Class OjSparkChartBase

This is the base class for oj-spark-chart WebElement, and is generated from the component's metadata. Do not modify these contents since they'll be replaced during the next generation. Put overrides into the WebElements's subclass, OjSparkChart.ts.

Hierarchy

Constructors

constructor

Methods

clear click findElement findElements getAnimationDuration getAnimationOnDataChange getAnimationOnDisplay getAreaColor getAreaSvgClassName getAreaSvgStyle getAs getAttribute getBarGapRatio getBaselineScaling getColor getCssValue getFirstColor getHighColor getItems getLastColor getLineStyle getLineType getLineWidth getLocation getLowColor getMarkerShape getMarkerSize getProperty getRect getReferenceObjects getSize getSvgClassName getSvgStyle getText getTooltip getTrackResize getTranslations getType getVisualEffects hasSize hasVisibility isDisplayed isEnabled isSelected sendKeys setProperty submit takeScreenshot whenBusyContextReady whenReady

Constructors

constructor

  • Constructor. Pass an instance of WebDriver's WebElement that represents the DOM node on which we"ll perform operations.

    Parameters

    • el: WebElement

      The basic WebElement with which this WebElement will work.

    • locators: ElementLocators

    Returns OjSparkChartBase

Methods

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

getAnimationDuration

  • Gets the value of animationDuration property. The duration of the animations in milliseconds.

    Returns Promise<number>

    The value of animationDuration property.

getAnimationOnDataChange

  • Gets the value of animationOnDataChange property. Defines the animation that is applied on data changes.

    Returns Promise<string>

    The value of animationOnDataChange property.

getAnimationOnDisplay

  • Gets the value of animationOnDisplay property. Defines the animation that is shown on initial display.

    Returns Promise<string>

    The value of animationOnDisplay property.

getAreaColor

  • Gets the value of areaColor property. The color of the area. Only applies if type is "area" or "lineWithArea".

    Returns Promise<string>

    The value of areaColor property.

getAreaSvgClassName

  • Gets the value of areaSvgClassName property. The CSS style class to apply if type is "area" or "lineWithArea".

    Returns Promise<string>

    The value of areaSvgClassName property.

    Deprecated

    Since 18.1.0. The areaSvgClassName property is deprecated. This API is not recommended in Redwood theme. Use other customization APIs where appropriate.

getAreaSvgStyle

  • Gets the value of areaSvgStyle property. The inline style to apply if type is "area" or "lineWithArea".

    Returns Promise<object>

    The value of areaSvgStyle property.

    Deprecated

    Since 18.1.0. The areaSvgStyle property is deprecated. This API is not recommended in Redwood theme. Use other customization APIs where appropriate.

getAs

  • Gets the value of as property. An alias for the '$current' context variable passed to slot content for the itemTemplate slot.

    Returns Promise<string>

    The value of as property.

    Deprecated

    Since 6.2.0. Set the alias directly on the template element using the data-oj-as attribute instead.

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getBarGapRatio

  • Gets the value of barGapRatio property. Specifies the width of the bar gap as a ratio of the item width. The valid value is a number from 0 to 1.

    Returns Promise<number>

    The value of barGapRatio property.

getBaselineScaling

  • Gets the value of baselineScaling property. Defines whether the axis baseline starts at the minimum value of the data or at zero.

    Returns Promise<string>

    The value of baselineScaling property.

getColor

  • Gets the value of color property. The color of the data items.

    Returns Promise<string>

    The value of color property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getFirstColor

  • Gets the value of firstColor property. The color of the first data item.

    Returns Promise<string>

    The value of firstColor property.

getHighColor

  • Gets the value of highColor property. The color of the data item with the greatest value.

    Returns Promise<string>

    The value of highColor property.

getItems

  • Gets the value of items property. An array of objects that define the data for the spark chart. See the Help documentation for more information.

    Returns Promise<null | number[] | Items[]>

    The value of items property.

getLastColor

  • Gets the value of lastColor property. The color of the last data item.

    Returns Promise<string>

    The value of lastColor property.

getLineStyle

  • Gets the value of lineStyle property. The line style of the data line. Only applies to line spark charts.

    Returns Promise<string>

    The value of lineStyle property.

getLineType

  • Gets the value of lineType property. The line type of the data line or area. Only applies to line and area spark charts.

    Returns Promise<string>

    The value of lineType property.

getLineWidth

  • Gets the value of lineWidth property. The width of the data line in pixels. Only applies to line spark charts.

    Returns Promise<number>

    The value of lineWidth property.

getLocation

getLowColor

  • Gets the value of lowColor property. The color of the data item with the lowest value.

    Returns Promise<string>

    The value of lowColor property.

getMarkerShape

  • Gets the value of markerShape property. The shape of the data markers. See the Help documentation for more information.

    Returns Promise<string>

    The value of markerShape property.

getMarkerSize

  • Gets the value of markerSize property. The size of the data markers in pixels. Only applies to line and area spark charts.

    Returns Promise<number>

    The value of markerSize property.

getProperty

  • Get a named property value from this component. This function will wait for the application's busy context to complete before attempting to get the property value.

    Type Parameters

    • T = string

    Parameters

    • propertyName: string

      The name of the property

    Returns Promise<T>

    A Promise that yields a value for the named property.

getRect

  • Returns Promise<IRectangle>

    Inherit Doc

getReferenceObjects

  • Gets the value of referenceObjects property. An array of reference objects associated with the y axis of the spark chart.

    Returns Promise<ReferenceObjects[]>

    The value of referenceObjects property.

getSize

getSvgClassName

  • Gets the value of svgClassName property. The CSS style class to apply to the data items. If type is "lineWithArea", this style will only be applied to the line if areaSvgClassName is also specified. See the Help documentation for more information.

    Returns Promise<string>

    The value of svgClassName property.

    Deprecated

    Since 19.0.0. The svgClassName property is deprecated. This API is not recommended in Redwood theme. Use other customization APIs where appropriate.

getSvgStyle

  • Gets the value of svgStyle property. The inline style to apply to the data items. If type is "lineWithArea", this style will only be applied to the line if areaSvgStyle is also specified. See the Help documentation for more information.

    Returns Promise<object>

    The value of svgStyle property.

    Deprecated

    Since 19.0.0. The svgStyle property is deprecated. This API is not recommended in Redwood theme. Use other customization APIs where appropriate.

getText

  • Returns Promise<string>

    Inherit Doc

getTooltip

  • Gets the value of tooltip property. An object containing an optional callback function for tooltip customization.

    Returns Promise<Tooltip>

    The value of tooltip property.

getTrackResize

  • Gets the value of trackResize property. Defines whether the element will automatically render in response to changes in size. See the Help documentation for more information.

    Returns Promise<string>

    The value of trackResize property.

getTranslations

  • Gets the value of translations property. A collection of translated resources from the translation bundle, or null if this component has no resources.

    Returns Promise<null | Translations>

    The value of translations property.

getType

  • Gets the value of type property. The chart type.

    Returns Promise<string>

    The value of type property.

getVisualEffects

  • Gets the value of visualEffects property. Defines whether visual effects such as overlays are applied to the spark chart.

    Returns Promise<string>

    The value of visualEffects property.

Protected hasSize

  • Create a wait condition that is satisfied when the element's DOM has a non-zero size.

    Returns Condition<Promise<boolean>>

    The Condition to be used with driver.wait() that's satisfied when the element's DOM has a non-zero size.

    Deprecated

    Since 11.0.0. Call the appropriate WebElement method to test the size of the element.

Protected hasVisibility

  • Create a wait condition that is satisfid when the element is visible. The condition is satisfied when the element is displayed, as reported by #isDisplayed, and is scrolled into view. This is method is deprecated. Use WebElement.isDisplayed instead to test the display of the element, and scroll it into view if necessary.

    Returns Condition<Promise<boolean>>

    Deprecated

isDisplayed

isEnabled

isSelected

sendKeys

  • Parameters

    • Rest ...varArgs: (string | number | Promise<string | number>)[]

    Returns Promise<void>

    Inherit Doc

Protected setProperty

  • Set a property value on the remote element. This function first waits for the BusyContext to clear before setting the property, then after setting, waits again to ensure that no additional busy states were created due to the property setting.

    Type Parameters

    • T = string

    Parameters

    • propertyName: string

      The property name to set

    • value: T

      The value to set for the property

    Returns Promise<void>

    A Promise which resolves when the remote property has been set to the value. Any value returned from the call to set the remote property is returned in the Promise.

submit

takeScreenshot

  • Parameters

    • Optional optScroll: boolean

    Returns Promise<string>

    Inherit Doc

whenBusyContextReady

  • Returns a Promise that is resolved when the application's busy state reports ready. This method checks only that the application's busy context is ready, and not that the DOM element is actually displayed or has a physical size, such as is the case with #whenReady. Operations which are read-only in nature should call this method prior to execution.

    Returns Promise<void>

    A Promise which is resolved when the page's busy state is ready.

whenReady

  • Returns a Promise that is resolved when the element is ready for interaction--it is visible, has a size, and the app's busy context is ready. Operations on the DOM which rely on its physical location and size to be in a "ready" state should use this command, such as clicking, sending keys, locating child elements, and so on.

    Returns Promise<void>

    A Promise that's resolved when all conditions are met.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc