Class OjRatingGauge

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

Migration

When you migrate a page from using oj-rating-guage to oj-c-rating-gauge you will also need to migrate your WebDriver tests from OjRatingGauge to RatingGaugeWebElement. To do that you will need to revise type and locator instances as follows
Type: from OjRatingGauge to RatingGaugeWebElement
Locator: from ojRatingGauge to findRatingGauge
For more details on migrating from legacy to core pack please see component's migration section

Hierarchy

Constructors

constructor

Methods

changeChanged changeValue clear click findElement findElements getAttribute getChanged getChangedState getCssValue getDescribedBy getDisabled getHoverState getLabelledBy getLocation getMax getMin getOrientation getPreserveAspectRatio getProperty getReadonly getRect getSelectedState getSize getSizeProperty getStep getText getThresholds getTooltip getTrackResize getTransientValue getTranslations getUnselectedState 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 OjRatingGauge

Methods

changeChanged

  • Sets the value of changed property. Whether there has been a value entered by the user.

    Parameters

    • changed: boolean

      The value to set for changed

    Returns Promise<void>

changeValue

  • Sets the value of value property. The value set on the gauge.

    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

getChanged

  • Gets the value of changed property. Whether there has been a value entered by the user.

    Returns Promise<boolean>

    The value of changed property.

getChangedState

  • Gets the value of changedState property. The changed shape for the gauge. Displayed after the user has set a value, or when the changed attribute of the data object is set to true.

    Returns Promise<ChangedState>

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

getDisabled

  • Gets the value of disabled property. Defines whether the gauge is disabled or not. User interaction is prevented if set to true. Visual indication will not be present when custom image source is used. Other state specific svg-class-name and svg-style will be overridden by disabled default style.

    Returns Promise<boolean>

    The value of disabled property.

getHoverState

  • Gets the value of hoverState property. The shape that displays on hover.

    Returns Promise<HoverState>

    The value of hoverState property.

    Deprecated

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

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

getMax

  • Gets the value of max property. Integer value specifying the maximum value of the gauge, which determines the number of shapes or images that are displayed.

    Returns Promise<number>

    The value of max property.

getMin

  • Gets the value of min property. The minimum value that can be set on the gauge by the end user. Does not affect the value set on the gauge by API.

    Returns Promise<number>

    The value of min property.

    Deprecated

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

getOrientation

  • Gets the value of orientation property. Defines the type of rating gauge to be rendered.

    Returns Promise<string>

    The value of orientation property.

    Deprecated

    Since 9.0.0. Usage of vertical rating gauges is not recommended.

getPreserveAspectRatio

  • Gets the value of preserveAspectRatio property. Specifies whether the images provided should show up at their defined aspect ratios. See the Help documentation for more information.

    Returns Promise<string>

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

getSelectedState

getSize

getSizeProperty

  • Gets the value of size property. Specifies the size of the rating gauge item. See the Help documentation for more information.

    Returns Promise<string>

    The value of size property.

getStep

  • Gets the value of step property. Specifies the increment by which values can be specified by the end user.

    Returns Promise<number>

    The value of step property.

getText

getThresholds

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.

getUnselectedState

  • Gets the value of unselectedState property. The unselected shape for the gauge.

    Returns Promise<UnselectedState>

    The value of unselectedState property.

    Deprecated

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

getValue

  • Gets the value of value property. The value set on the gauge.

    Returns Promise<null | number>

    The value of value property.

getVisualEffects

  • Gets the value of visualEffects property. Defines whether 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