Class OjNBox

The component WebElement for oj-n-box. Do not instantiate this class directly, instead, use ojNBox.

Hierarchy

Constructors

constructor

Methods

changeHiddenCategories changeHighlightedCategories changeMaximizedColumn changeMaximizedRow changeSelection clear click findElement findElements getAnimationOnDataChange getAnimationOnDisplay getAs getAttribute getCellContent getCellMaximize getCells getColumns getColumnsTitle getCountLabel getCssValue getDataTransferOptions getDnd getGroupAttributes getGroupBehavior getHiddenCategories getHighlightMatch getHighlightedCategories getHoverBehavior getLabelTruncation getLocation getMaximizedColumn getMaximizedRow getNodes getOtherColor getOtherThreshold getProperty getRect getRows getRowsTitle getSelection getSelectionMode getSize getStyleDefaults getText getTooltip getTouchResponse getTrackResize getTranslations 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 OjNBox

Methods

changeHiddenCategories

  • Sets the value of hiddenCategories property. An array of category strings used for filtering. Data items with any category matching an item in this array will be filtered.

    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. Data items matching categories in this array will be highlighted.

    Parameters

    • highlightedCategories: string[]

      The value to set for highlightedCategories

    Returns Promise<void>

changeMaximizedColumn

  • Sets the value of maximizedColumn property. The id of the column to be maximized.

    Parameters

    • maximizedColumn: string

      The value to set for maximizedColumn

    Returns Promise<void>

changeMaximizedRow

  • Sets the value of maximizedRow property. The id of the row to be maximized.

    Parameters

    • maximizedRow: string

      The value to set for maximizedRow

    Returns Promise<void>

changeSelection

  • Sets the value of selection property. Specifies the ids of the selected nodes.

    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

getAnimationOnDataChange

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

    Returns Promise<string>

    The value of animationOnDataChange property.

getAnimationOnDisplay

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

    Returns Promise<string>

    The value of animationOnDisplay property.

getAs

  • Gets the value of as property. Specifies the alias for the current item when referenced inside the nodeTemplate.

    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

getCellContent

  • Gets the value of cellContent property. Specifies the content displayed in cells. See the Help documentation for more information.

    Returns Promise<string>

    The value of cellContent property.

getCellMaximize

  • Gets the value of cellMaximize property. Specifies whether cell maximize/de-maximize gestures are enabled.

    Returns Promise<string>

    The value of cellMaximize property.

getCells

  • Gets the value of cells property. Specifies the list of cells. Also accepts a Promise for deferred data rendering.

    Returns Promise<null | Cells[]>

    The value of cells property.

getColumns

  • Gets the value of columns property. Specifies the list of columns. Also accepts a Promise for deferred data rendering.

    Returns Promise<null | Columns[]>

    The value of columns property.

getColumnsTitle

  • Gets the value of columnsTitle property. The text for the title on the column edge.

    Returns Promise<string>

    The value of columnsTitle property.

getCountLabel

  • Gets the value of countLabel property. A function that returns custom text for the cell count labels.

    Returns Promise<null>

    The value of countLabel property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getDataTransferOptions

getDnd

  • Gets the value of dnd property. Provides support for HTML5 Drag and Drop events. See the Help documentation for more information.

    Returns Promise<Dnd>

    The value of dnd property.

getGroupAttributes

  • Gets the value of groupAttributes property. An array of attributes for styling the group nodes.

    Returns Promise<string[]>

    The value of groupAttributes property.

getGroupBehavior

  • Gets the value of groupBehavior property. Specifies how nodes should be grouped.

    Returns Promise<string>

    The value of groupBehavior property.

getHiddenCategories

  • Gets the value of hiddenCategories property. An array of category strings used for filtering. Data items with any category matching an item in this array will be filtered.

    Returns Promise<string[]>

    The value of hiddenCategories property.

getHighlightMatch

  • Gets the value of highlightMatch property. The matching condition for the highlightedCategories property. See the Help documentation for more information.

    Returns Promise<string>

    The value of highlightMatch property.

getHighlightedCategories

  • Gets the value of highlightedCategories property. An array of category strings used for highlighting. Data items matching categories in this array will be highlighted.

    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.

getLabelTruncation

  • Gets the value of labelTruncation property. Specifies node label truncation behavior. See the Help documentation for more information.

    Returns Promise<string>

    The value of labelTruncation property.

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

getMaximizedColumn

  • Gets the value of maximizedColumn property. The id of the column to be maximized.

    Returns Promise<string>

    The value of maximizedColumn property.

getMaximizedRow

  • Gets the value of maximizedRow property. The id of the row to be maximized.

    Returns Promise<string>

    The value of maximizedRow property.

getNodes

  • Gets the value of nodes property. The list of nodes. Also accepts a Promise for deferred data rendering.

    Returns Promise<null | Nodes[]>

    The value of nodes property.

getOtherColor

  • Gets the value of otherColor property. The color for the "other" group nodes. See the Help documentation for more information.

    Returns Promise<string>

    The value of otherColor property.

getOtherThreshold

  • Gets the value of otherThreshold property. The threshold for aggregating nodes into an "other" group node. See the Help documentation for more information.

    Returns Promise<number>

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

getRows

  • Gets the value of rows property. The list of rows. Also accepts a Promise for deferred data rendering.

    Returns Promise<null | Rows[]>

    The value of rows property.

getRowsTitle

  • Gets the value of rowsTitle property. The text for the title on the row edge.

    Returns Promise<string>

    The value of rowsTitle property.

getSelection

  • Gets the value of selection property. Specifies the ids of the selected nodes.

    Returns Promise<any[]>

    The value of selection property.

getSelectionMode

  • Gets the value of selectionMode property. Specifies the selection behavior on the NBox. See the Help documentation for more information.

    Returns Promise<string>

    The value of selectionMode property.

getSize

  • Returns Promise<ISize>

    Inherit Doc

getStyleDefaults

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.

getTouchResponse

  • Gets the value of touchResponse property. Specifies configuration options for touch and hold delays on mobile devices. See the Help documentation for more information.

    Returns Promise<string>

    The value of touchResponse property.

    Deprecated

    Since 18.0.0. This attribute is deprecated and no longer recommended in the Redwood Design system. The "auto" value behavior will be applied instead.

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.

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

  • 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

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc