Class OjDataGrid

The component WebElement for oj-data-grid. Do not instantiate this class directly, instead, use ojDataGrid.

Hierarchy

  • OjDataGridBase
    • OjDataGrid

Constructors

constructor

Methods

changeCurrentCell changeEditMode changeFrozenColumnCount changeFrozenRowCount changeHiddenColumns changeHiddenRows changeScrollPosition changeSelection clear click enterEditMode exitEditMode findCell findElement findElements findHeader findLabel getAttribute getBandingInterval getCell getCellContents getCssValue getCurrentCell getDataTransferOptions getDnd getDriver getEditMode getFrozenColumnCount getFrozenRowCount getGridlines getHeader getHeaderContents getHiddenColumns getHiddenRows getId getLabelContents getLocation getProperty getRect getScrollPolicy getScrollPolicyOptions getScrollPosition getScrollToKey getSelection getSelectionMode getShadowRoot getSize getTagName getText getTranslations 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 OjDataGrid

Methods

changeCurrentCell

  • Sets the value of currentCell property. Specifies the grid's currently focused cell.

    Parameters

    • currentCell: object

      The value to set for currentCell

    Returns Promise<void>

changeEditMode

  • Sets the value of editMode property. Specifies if the grid is read-only or editable.

    Parameters

    • editMode: string

      The value to set for editMode

    Returns Promise<void>

changeFrozenColumnCount

  • Sets the value of frozenColumnCount property. Specifies count of columns to be frozen.

    Parameters

    • frozenColumnCount: number

      The value to set for frozenColumnCount

    Returns Promise<void>

changeFrozenRowCount

  • Sets the value of frozenRowCount property. Specifies count of rows to be frozen.

    Parameters

    • frozenRowCount: number

      The value to set for frozenRowCount

    Returns Promise<void>

changeHiddenColumns

  • Sets the value of hiddenColumns property. Use to hide columns of grid on initial render.

    Parameters

    • hiddenColumns: object

      The value to set for hiddenColumns

    Returns Promise<void>

changeHiddenRows

  • Sets the value of hiddenRows property. Use to hide rows of grid on initial render.

    Parameters

    • hiddenRows: object

      The value to set for hiddenRows

    Returns Promise<void>

changeScrollPosition

  • Sets the value of scrollPosition property. Specifies the current scroll position of the data grid. See the Help documentation for more information.

    Parameters

    • scrollPosition: ScrollPosition

      The value to set for scrollPosition

    Returns Promise<void>

changeSelection

  • Sets the value of selection property. Specifies the grid's current selection.

    Parameters

    • selection: object[]

      The value to set for selection

    Returns Promise<void>

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

enterEditMode

  • Forces grid to ender editMode on a particular cell.

    Type Parameters

    • K = any

    Parameters

    • itemLocator: {
          columnIndex?: number;
          columnKey?: K;
          rowIndex?: number;
          rowKey?: K;
      }
      • Optional columnIndex?: number

        The columnIndex within the Collection's dataset associated with the item. (Optional if columnKey is provided)

      • Optional columnKey?: K

        The columnKey within the Collection's dataset associated with the item. (Optional if columnIndex is provided).

      • Optional rowIndex?: number

        The rowIndex within the Collection's dataset associated with the item. (Optional if rowKey is provided)

      • Optional rowKey?: K

        The rowKey within the Collection's dataset associated with the item. (Optional if rowIndex is provided)

    Returns Promise<void>

exitEditMode

  • Forces grid to exit editMode.

    Parameters

    • Optional exitParams: {
          cancel: boolean;
      }
      • cancel: boolean

        If set to true datagrid will cancel edit.

    Returns Promise<void>

findCell

  • Retrieve a SlotProxy which represents a single datagrid cell.

    Type Parameters

    • K = any

    Parameters

    • itemLocator: {
          columnIndex?: null | number;
          columnKey?: K;
          rowIndex?: null | number;
          rowKey?: K;
      }
      • Optional columnIndex?: null | number

        The columnIndex within the Collection's dataset associated with the item. (Optional if columnKey is provided).

      • Optional columnKey?: K

        The columnKey within the Collection's dataset associated with the item. (Optional if columnIndex is provided).

      • Optional rowIndex?: null | number

        The rowIndex within the Collection's dataset associated with the item. (Optional if rowKey is provided)

      • Optional rowKey?: K

        The rowKey within the Collection's dataset associated with the item. (Optional if rowIndex is provided)

    Returns Promise<SlotProxy>

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

findHeader

  • Retrieve a SlotProxy which represents a single datagrid header.

    Type Parameters

    • K = any

    Parameters

    • itemLocator: {
          axis: "row" | "rowEnd" | "column" | "columnEnd";
          index?: number;
          key?: K;
          level?: number;
      }
      • axis: "row" | "rowEnd" | "column" | "columnEnd"

        The axis where the header is located.

      • Optional index?: number

        The index within the Collection's dataset associated with the header.

      • Optional key?: K

        The key within the Collection's dataset associated with the header.

      • Optional level?: number

        The level of the header requested.

    Returns Promise<SlotProxy>

findLabel

  • Retrieve a SlotProxy which represents a single datagrid label.

    Parameters

    • itemLocator: {
          axis: "row" | "rowEnd" | "column" | "columnEnd";
          level: number;
      }
      • axis: "row" | "rowEnd" | "column" | "columnEnd"

        The axis where the label is located.

      • level: number

        The level of the label requested.

    Returns Promise<SlotProxy>

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getBandingInterval

  • Gets the value of bandingInterval property. Specifies the data body row and column banding intervals.

    Returns Promise<BandingInterval>

    The value of bandingInterval property.

getCell

  • Gets the value of cell property. Specifies attributes on the cells.

    Returns Promise<Cell>

    The value of cell property.

getCellContents

  • This method exists to get content that is intended to interact with. This is not a method to verify data or that template rendering is correct. For those cases unit test the data, template, style function etc.

    Parameters

    • itemLocator: {
          key: {
              columnIndex?: null | number;
              columnKey?: any;
              rowIndex?: null | number;
              rowKey?: any;
          };
      }
      • key: {
            columnIndex?: null | number;
            columnKey?: any;
            rowIndex?: null | number;
            rowKey?: any;
        }
        • Optional columnIndex?: null | number
        • Optional columnKey?: any
        • Optional rowIndex?: null | number
        • Optional rowKey?: any

    Returns Promise<null | WebElement>

    If no cell is found matching the id, returns null. Otherwise: On Zero Match return an empty list. On One Match returns list of one WebElement only. On One+ Match returns list with all matching instance. If cell renderer/template/slot is not specified the promise will be rejected with an error message.

    Deprecated

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getCurrentCell

  • Gets the value of currentCell property. Specifies the grid's currently focused cell.

    Returns Promise<object>

    The value of currentCell property.

getDataTransferOptions

  • Gets the value of dataTransferOptions property. Specifies data transfer features.

    Returns Promise<DataTransferOptions>

    The value of dataTransferOptions property.

getDnd

  • Gets the value of dnd property. Specifies drag and drop features.

    Returns Promise<Dnd>

    The value of dnd property.

getDriver

  • Returns WebDriver

    The parent driver for this instance.

getEditMode

  • Gets the value of editMode property. Specifies if the grid is read-only or editable.

    Returns Promise<string>

    The value of editMode property.

getFrozenColumnCount

  • Gets the value of frozenColumnCount property. Specifies count of columns to be frozen.

    Returns Promise<number>

    The value of frozenColumnCount property.

getFrozenRowCount

  • Gets the value of frozenRowCount property. Specifies count of rows to be frozen.

    Returns Promise<number>

    The value of frozenRowCount property.

getGridlines

  • Gets the value of gridlines property. Specifies the visibility of the grid body vertical and horizontal gridlines.

    Returns Promise<Gridlines>

    The value of gridlines property.

getHeader

  • Gets the value of header property. Specifies attributes on the headers.

    Returns Promise<Header>

    The value of header property.

getHeaderContents

  • This method exists to get content that is intended to interact with. This is not a method to verify data or that template rendering is correct. For those cases unit test the data, template, style function etc.

    Parameters

    • subId: {
          axis: "row" | "rowEnd" | "column" | "columnEnd";
          index?: number;
          key?: any;
          level?: number;
      }

      information about the header to get contents of, if level not specified will default to 0

      • axis: "row" | "rowEnd" | "column" | "columnEnd"
      • Optional index?: number
      • Optional key?: any
      • Optional level?: number
    • by: By

      The lookup to pass into findElements

    Returns Promise<null | WebElement[]>

    If no header is found matching the id, returns null. Otherwise: On Zero Match return an empty list. On One Match returns list of one WebElement only. On One+ Match returns list with all matching instance. If header renderer/template/slot is not specified the promise will be rejected with an error message.

    Deprecated

getHiddenColumns

  • Gets the value of hiddenColumns property. Use to hide columns of grid on initial render.

    Returns Promise<object>

    The value of hiddenColumns property.

getHiddenRows

  • Gets the value of hiddenRows property. Use to hide rows of grid on initial render.

    Returns Promise<object>

    The value of hiddenRows property.

getId

  • Returns Promise<string>

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

getLabelContents

  • This method exists to get content that is intended to interact with. This is not a method to verify data or that template rendering is correct. For those cases unit test the data, template, style function etc.

    Parameters

    • subId: {
          axis: "row" | "rowEnd" | "column" | "columnEnd";
          level: number;
      }

      information about the label to get contents of, if level not specified will default to 0

      • axis: "row" | "rowEnd" | "column" | "columnEnd"
      • level: number
    • by: By

      The lookup to pass into findElements

    Returns Promise<null | WebElement[]>

    If no label is found matching the id, returns null. Otherwise: On Zero Match return an empty list. On One Match returns list of one WebElement only. On One+ Match returns list with all matching instance. If label renderer/template/slot is not specified the promise will be rejected with an error message.

    Deprecated

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

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

getScrollPolicy

  • Gets the value of scrollPolicy property. Specifies how data are fetched as user scrolls through the data grid.

    Returns Promise<null | string>

    The value of scrollPolicy property.

getScrollPolicyOptions

  • Gets the value of scrollPolicyOptions property. Specifies fetch options for scrolling behaviors that trigger data fetches.

    Returns Promise<null | ScrollPolicyOptions>

    The value of scrollPolicyOptions property.

getScrollPosition

  • Gets the value of scrollPosition property. Specifies the current scroll position of the data grid. See the Help documentation for more information.

    Returns Promise<ScrollPosition>

    The value of scrollPosition property.

getScrollToKey

  • Gets the value of scrollToKey property. Specifies the behavior when DataGrid needs to scroll to a position based on a row/column key.

    Returns Promise<null | string>

    The value of scrollToKey property.

getSelection

  • Gets the value of selection property. Specifies the grid's current selection.

    Returns Promise<object[]>

    The value of selection property.

getSelectionMode

  • Gets the value of selectionMode property. Specifies the row and cell selection modes. See the Help documentation for more information.

    Returns Promise<SelectionMode>

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

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

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

  • 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