Class LineChartWebElement

The component WebElement for oj-c-line-chart. Do not instantiate this class directly, instead, use findLineChart.

Hierarchy

  • LineChartWebElementBase
    • LineChartWebElement

Constructors

constructor

Methods

changeHiddenCategories changeHighlightedCategories changeSelection clear click findElement findElements getAttribute getContextMenuConfig getCssValue getData getDragMode getDrilling getDriver getGroupComparator getHiddenCategories getHideAndShowBehavior getHighlightMatch getHighlightedCategories getHoverBehavior getId getLegend getLocation getOrientation getPlotArea getProperty getRect getSelection getSelectionMode getSeriesComparator getShadowRoot getSize getStack getTagName getText getTimeAxisType getValueFormats getXAxis getYAxis getZoomAndScroll hasSize hasVisibility isDisplayed isEnabled isSelected sendKeys serialize setProperty submit takeScreenshot whenBusyContextReady whenReady buildId equals extractId isId

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 LineChartWebElement

Methods

changeHiddenCategories

  • Sets the value of hiddenCategories property. An array of category strings used for filtering.

    Parameters

    • hiddenCategories: string[]

      The value to set for hiddenCategories

    Returns Promise<void>

changeHighlightedCategories

  • Sets the value of highlightedCategories property. An array of category strings used for highlighting.

    Parameters

    • highlightedCategories: string[]

      The value to set for highlightedCategories

    Returns Promise<void>

changeSelection

  • Sets the value of selection property. An array containing the ids of the initially selected data items.

    Parameters

    • selection: any[]

      The value to set for selection

    Returns Promise<void>

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

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getContextMenuConfig

  • Gets the value of contextMenuConfig property. Specifies a context menu configuration.

    Returns Promise<ContextMenuConfig>

    The value of contextMenuConfig property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getData

  • Gets the value of data property. Specifies the DataProvider for the sections and items of the line-chart.

    Returns Promise<null>

    The value of data property.

    Deprecated

    Since 17.1.0. Data sets from a DataProvider cannot be sent to WebDriverJS; use ViewModels or page variables instead.

getDragMode

  • Gets the value of dragMode property. The action that is performed when a drag occurs on the chart.

    Returns Promise<string>

    The value of dragMode property.

getDrilling

  • Gets the value of drilling property. Whether drilling is enabled. Drillable objects will show a pointer cursor on hover and fire an <code class="prettyprint">ojDrill</code> event on click (double click if selection is enabled). Use "on" to enable drilling for all series objects (legend items), group objects (x-axis labels), and data items. Use "seriesOnly" or "groupsOnly" to enable drilling for series objects or group objects only. To enable or disable drilling on individual series, group, or data item, use the drilling attribute in each series, group, or data item.

    Returns Promise<string>

    The value of drilling property.

getDriver

  • Returns WebDriver

    The parent driver for this instance.

getGroupComparator

  • Gets the value of groupComparator property. A comparator function that determines the ordering of the chart groups when using a DataProvider. If undefined, the group will follow the order in which they are found in the data.

    Returns Promise<null>

    The value of groupComparator property.

getHiddenCategories

  • Gets the value of hiddenCategories property. An array of category strings used for filtering.

    Returns Promise<string[]>

    The value of hiddenCategories property.

getHideAndShowBehavior

  • Gets the value of hideAndShowBehavior property. Defines the hide and show behavior that is performed when clicking on a leegnd item.

    Returns Promise<string>

    The value of hideAndShowBehavior property.

getHighlightMatch

  • Gets the value of highlightMatch property. The matching condition for the highlighted property.

    Returns Promise<string>

    The value of highlightMatch property.

getHighlightedCategories

  • Gets the value of highlightedCategories property. An array of category strings used for highlighting.

    Returns Promise<string[]>

    The value of highlightedCategories property.

getHoverBehavior

  • Gets the value of hoverBehavior property. Defines the behavior applied when hovering over data items.

    Returns Promise<string>

    The value of hoverBehavior property.

getId

  • Returns Promise<string>

    A promise that resolves to the server-assigned opaque ID assigned to this element.

getLegend

  • Gets the value of legend property. An object defining the style, positioning, and behavior of the legend.

    Returns Promise<Legend>

    The value of legend property.

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

getOrientation

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

    Returns Promise<string>

    The value of orientation property.

getPlotArea

  • Gets the value of plotArea property. The plot area of the chart.

    Returns Promise<PlotArea>

    The value of plotArea 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

getSelection

  • Gets the value of selection property. An array containing the ids of the initially selected data items.

    Returns Promise<any[]>

    The value of selection property.

getSelectionMode

  • Gets the value of selectionMode property. Specifies the selection mode.

    Returns Promise<string>

    The value of selectionMode property.

getSeriesComparator

  • Gets the value of seriesComparator property. A comparator function that determines the ordering of the chart series when using a DataProvider. If undefined, the series will follow the order in which they are found in the data.

    Returns Promise<null>

    The value of seriesComparator property.

getShadowRoot

  • Get the shadow root of the current web element.

    Returns ShadowRootPromise

    A promise that will be resolved with the elements shadow root or rejected with NoSuchShadowRootError

getSize

  • Returns Promise<ISize>

    Inherit Doc

getStack

  • Gets the value of stack property. Defines whether the data items are stacked.

    Returns Promise<string>

    The value of stack property.

getTagName

  • Schedules a command to query for the tag/node name of this element.

    Returns Promise<string>

    A promise that will be resolved with the element's tag name.

getText

  • Returns Promise<string>

    Inherit Doc

getTimeAxisType

  • Gets the value of timeAxisType property. The time axis type of the chart x axis.

    Returns Promise<string>

    The value of timeAxisType property.

getValueFormats

  • Gets the value of valueFormats property. An object specifying value formatting and tooltip behavior, whose keys generally correspond to the attribute names on the data items.

    Returns Promise<ValueFormats>

    The value of valueFormats property.

getXAxis

  • Gets the value of xAxis property. The xAxis options for the chart.

    Returns Promise<XAxis>

    The value of xAxis property.

getYAxis

  • Gets the value of yAxis property. The yAxis options for the chart.

    Returns Promise<YAxis>

    The value of yAxis property.

getZoomAndScroll

  • Gets the value of zoomAndScroll property. The zoom and scroll behavior.

    Returns Promise<string>

    The value of zoomAndScroll 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

  • Returns Promise<boolean>

    Inherit Doc

isEnabled

  • Returns Promise<boolean>

    Inherit Doc

isSelected

  • Returns Promise<boolean>

    Inherit Doc

sendKeys

  • Parameters

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

    Returns Promise<void>

    Inherit Doc

serialize

  • Returns Promise<IWebElementId>

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

  • Returns Promise<void>

    Inherit Doc

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.

Static buildId

  • Parameters

    • id: string

      The raw ID.

    • Optional opt_noLegacy: boolean

      Whether to exclude the legacy element key.

    Returns IWebElementId

    The element ID for use with WebDriver's wire protocol.

Static equals

  • Compares two WebElements for equality.

    Parameters

    • a: WebElement

      A WebElement.

    • b: WebElement

      A WebElement.

    Returns Promise<boolean>

    A promise that will be resolved to whether the two WebElements are equal.

Static extractId

  • Extracts the encoded WebElement ID from the object.

    Parameters

    • obj: IWebElementId

      The object to extract the ID from.

    Returns string

    the extracted ID.

    Throws

    if the object is not a valid encoded ID.

Static isId

  • Parameters

    • obj: IWebElementId

      the object to test.

    Returns boolean

    whether the object is a valid encoded WebElement ID.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc