Class OjStatusMeterGauge

The component WebElement for oj-status-meter-gauge. Do not instantiate this class directly, instead, use ojStatusMeterGauge.

Migration

oj-status-meter-gauge is being broken down into multiple core pack chart components. When you migrate a page from using oj-status-meter-gauge to new core pack chart components oj-c-meter-circle and oj-c-meter-bar you will also need to migrate your WebDriver tests from OjStatusMeterGauge to MeterCircleWebElement and MeterBarWebElement respectively. To do that you will need to revise type and locator instances as follows
Type: from OjStatusMeterGauge to MeterCircleWebElement or MeterBarWebElement
Locator: from OjStatusMeterGauge to findMeterCircle or findMeterBarWeb.
For more details on migrating from legacy to core pack please see MeterCircle component's migration section and MeterBar component's migration section

Hierarchy

  • OjStatusMeterGaugeBase
    • OjStatusMeterGauge

Constructors

constructor

Methods

changeValue clear click findElement findElements getAngleExtent getAnimationDuration getAnimationOnDataChange getAnimationOnDisplay getAttribute getBorderColor getBorderRadius getCenter getColor getCssValue getDescribedBy getDriver getId getIndicatorSize getInnerRadius getLabel getLabelledBy getLocation getMax getMetricLabel getMin getOrientation getPlotArea getProperty getReadonly getRect getReferenceLines getShadowRoot getSize getSizeProperty getStartAngle getStep getSvgClassName getSvgStyle getTagName getText getThresholdDisplay getThresholds getTooltip getTrackResize getTransientValue getTranslations getValue getVisualEffects 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 OjStatusMeterGauge

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

  • 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

getAngleExtent

  • Gets the value of angleExtent property. Specifies the angle extent of a gauge with circular orientation. Value should be provided in degrees.

    Returns Promise<number>

    The value of angleExtent property.

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.

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.

    Deprecated

    Since 14.0.0. This is not recommended in the Redwood design system.

getBorderRadius

  • Gets the value of borderRadius property. Specifies the border radius of the indicator and plot area. See the Help documentation for more information.

    Returns Promise<string>

    The value of borderRadius property.

    Deprecated

    Since 14.0.0. This is not recommended in the Redwood design system.

getCenter

  • Gets the value of center property. An object defining the center content of a status meter with circular orientation.

    Returns Promise<Center>

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

getDescribedBy

  • Gets the value of describedBy property. Specifies a relationship between this component and another element.

    Returns Promise<null | string>

    The value of describedBy property.

getDriver

  • Returns WebDriver

    The parent driver for this instance.

getId

  • Returns Promise<string>

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

getIndicatorSize

  • Gets the value of indicatorSize property. Defines the ratio of relative thickness of the indicator to the plot area.

    Returns Promise<number>

    The value of indicatorSize property.

getInnerRadius

  • Gets the value of innerRadius property. Specifies the inner radius of a gauge with circular orientation, defined by the distance from the center of the gauge to the innermost edge of the indicator and plot area. Valid values are a percent or ratio from 0 to 1.

    Returns Promise<number>

    The value of innerRadius property.

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.

getLabelledBy

  • Gets the value of labelledBy property. Establishes a relationship between this component and another element, typically an oj-label custom element. See the Help documentation for more information.

    Returns Promise<null | string>

    The value of labelledBy property.

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

getMax

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

    Returns Promise<number>

    The value of max property.

getMetricLabel

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

    Returns Promise<MetricLabel>

    The value of metricLabel property.

    Deprecated

    Since 18.0.0. This component is superceded by oj-c-meter-bar and oj-c-meter-circle. Applications with this use case should instead create their own labels that also satisfy accessibility requirements.

getMin

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

    Returns Promise<number>

    The value of min property.

getOrientation

  • Gets the value of orientation property. Defines the type of status meter to be rendered.

    Returns Promise<string>

    The value of orientation property.

getPlotArea

  • Gets the value of plotArea property. Plot Area for Status Meter Gauge

    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.

getReadonly

  • Gets the value of readonly property. Defines whether the value of the gauge can be changed by the end user.

    Returns Promise<boolean>

    The value of readonly property.

getRect

  • Returns Promise<IRectangle>

    Inherit Doc

getReferenceLines

  • Gets the value of referenceLines property. An array of objects specifying the reference lines for the gauge.

    Returns Promise<ReferenceLines[]>

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

getSizeProperty

  • Gets the value of size property. Specifies the gauge size.

    Returns Promise<string>

    The value of size property.

getStartAngle

  • Gets the value of startAngle property. Specifies the start angle of a gauge with circular orientation. Value should be provided in degrees.

    Returns Promise<number>

    The value of startAngle property.

getStep

  • Gets the value of step property. Specifies the increment by which values can be changed by the end user. See the Help documentation for more information.

    Returns Promise<null | number>

    The value of step property.

getSvgClassName

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

    Returns Promise<string>

    The value of svgClassName property.

    Deprecated

    Since 14.0.0. This is not recommended in the Redwood design system.

getSvgStyle

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

    Returns Promise<object>

    The value of svgStyle property.

    Deprecated

    Since 14.0.0. This is not recommended in the Redwood design system.

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

getThresholdDisplay

  • Gets the value of thresholdDisplay property. Controls whether the current threshold is displayed on the indicator, in the plotArea, or if all the thresholds are displayed in the plot area.

    Returns Promise<string>

    The value of thresholdDisplay property.

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.

getTransientValue

  • Gets the value of transientValue property. Read-only property used for retrieving the transient value from the component. See the Help documentation for more information.

    Returns Promise<null | number>

    The value of transientValue 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.

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

  • 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