Class OjLedGauge

The component WebElement for oj-led-gauge. Do not instantiate this class directly, instead, use ojLedGauge.

Hierarchy

Constructors

constructor

Methods

changeValue clear click findElement findElements getAttribute getBorderColor getColor getCssValue getLabel getLocation getMarkerSize getMax getMetricLabel getMin getProperty getRect getRotation getSize getSizeProperty getSvgClassName getSvgStyle getText getThresholds getTooltip getTrackResize getTranslations getType getValue 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 OjLedGauge

Methods

changeValue

  • Sets the value of value property. The metric value.

    Parameters

    • value: null | number

      The value to set for value

    Returns Promise<void>

clear

click

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

getBorderColor

  • Gets the value of borderColor property. The border color of the gauge. Only applies when thresholds are not defined. The default value varies based on theme.

    Returns Promise<string>

    The value of borderColor property.

getColor

  • Gets the value of color property. The color of the gauge. Only applies when thresholds are not defined. The default value varies based on theme.

    Returns Promise<string>

    The value of color property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getLabel

  • Gets the value of label property. An object defining the label.

    Returns Promise<Label>

    The value of label property.

    Deprecated

    Since 12.1.0. Use metric-label instead.

getLocation

getMarkerSize

  • Gets the value of markerSize property. Specifies the led size.

    Returns Promise<string>

    The value of markerSize property.

getMax

  • Gets the value of max property. The maximum value of the gauge.

    Returns Promise<number>

    The value of max property.

getMetricLabel

getMin

  • Gets the value of min property. The minimum value of the gauge.

    Returns Promise<number>

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

getRotation

  • Gets the value of rotation property. The rotation angle for the gauge. Useful for changing the direction of triangle or arrow gauges.

    Returns Promise<number>

    The value of rotation property.

getSize

getSizeProperty

  • Gets the value of size property. Fraction of area to use. Values range from 0 to 1.

    Returns Promise<number>

    The value of size property.

getSvgClassName

  • Gets the value of svgClassName property. The CSS style class to apply to the gauge. See the Help documentation for more information.

    Returns Promise<string>

    The value of svgClassName property.

getSvgStyle

  • Gets the value of svgStyle property. The inline style to apply to the gauge. See the Help documentation for more information.

    Returns Promise<object>

    The value of svgStyle property.

getText

getThresholds

  • Gets the value of thresholds property. An array of objects specifying the gauge thresholds.

    Returns Promise<Thresholds[]>

    The value of thresholds property.

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 shape of the LED gauge. Can take the name of a built-in shape or the SVG path commands for a custom shape.

    Returns Promise<string>

    The value of type property.

getValue

  • Gets the value of value property. The metric value.

    Returns Promise<null | number>

    The value of value property.

getVisualEffects

  • Gets the value of visualEffects property. Defines whether the theme specific visual effects such as overlays and gradients are applied to the gauge.

    Returns Promise<string>

    The value of visualEffects property.

    Deprecated

    Since 12.1.0. Overlays and gradients are not supported in Redwood theme and are not recommended.

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