The component WebElement for oj-c-tag-cloud. Do not instantiate this class directly, instead, use findTagCloud.

Hierarchy

  • TagCloudWebElementBase
    • TagCloudWebElement

Constructors

  • 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 TagCloudWebElement

Methods

  • Sets the value of hiddenCategories property. An array of categories that will be hidden.

    Parameters

    • hiddenCategories: string[]

      The value to set for hiddenCategories

    Returns Promise<void>

  • Sets the value of highlightedCategories property. An array of categories that will be highlighted.

    Parameters

    • highlightedCategories: string[]

      The value to set for highlightedCategories

    Returns Promise<void>

  • Sets the value of selection property. An array containing the ids of the initially selected data items.

    Parameters

    • selection: any[]

      The value to set for selection

    Returns Promise<void>

  • Returns Promise<void>

    Inherit Doc

  • Returns Promise<void>

    Inherit Doc

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

  • Gets the value of contextMenuConfig property. Specifies a context menu configuration.

    Returns Promise<ContextMenuConfig>

    The value of contextMenuConfig property.

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

  • Gets the value of data property. Specifies the DataProvider for the sections and items of the tag-cloud

    Returns Promise<null>

    The value of data property.

    Deprecated

    Since 17.1.0. Data sets from a DataProvider cannot be sent to WebDriverJS; use ViewModels or page variables instead.

  • Gets the value of datatip property.

    Returns Promise<null>

    The value of datatip property.

  • Returns WebDriver

    The parent driver for this instance.

  • Gets the value of hiddenCategories property. An array of categories that will be hidden.

    Returns Promise<string[]>

    The value of hiddenCategories property.

  • Gets the value of highlightMatch property. The matching condition for the highlightedCategories option. By default, highlightMatch is 'all' and only items whose categories match all of the values specified in the highlightedCategories array will be highlighted. If highlightMatch is 'any', then items that match at least one of the highlightedCategories values will be highlighted.

    Returns Promise<string>

    The value of highlightMatch property.

  • Gets the value of highlightedCategories property. An array of categories that will be highlighted.

    Returns Promise<string[]>

    The value of highlightedCategories property.

  • Gets the value of hoverBehavior property. Defines the behavior applied when hovering over data items.

    Returns Promise<string>

    The value of hoverBehavior property.

  • Returns Promise<string>

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

  • Gets the value of layout property. The layout to use for tag display.

    Returns Promise<string>

    The value of layout property.

  • Returns Promise<ILocation>

    Inherit Doc

  • 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.

  • Returns Promise<IRectangle>

    Inherit Doc

  • Gets the value of selection property. An array containing the ids of the initially selected data items.

    Returns Promise<any[]>

    The value of selection property.

  • Gets the value of selectionMode property. Specifies the selection mode.

    Returns Promise<string>

    The value of selectionMode property.

  • 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

  • Returns Promise<ISize>

    Inherit Doc

  • 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.

  • Returns Promise<string>

    Inherit Doc

  • Gets the value of touchResponse property. Data visualizations require a press and hold delay before triggering tooltips and rollover effects on mobile devices to avoid interfering with page panning, but these hold delays can make applications seem slower and less responsive. For a better user experience, the application can remove the touch and hold delay when data visualizations are used within a non scrolling container or if there is sufficient space outside of the visualization for panning. If touchResponse is touchStart the element will instantly trigger the touch gesture and consume the page pan events. If touchResponse is auto, the element will behave like touchStart if it determines that it is not rendered within scrolling content and if element panning is not available for those elements that support the feature.

    Returns Promise<string>

    The value of touchResponse property.

  • 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.

  • 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

  • Returns Promise<boolean>

    Inherit Doc

  • Returns Promise<boolean>

    Inherit Doc

  • Returns Promise<boolean>

    Inherit Doc

  • Parameters

    • Rest ...varArgs: (string | number | Promise<string | number>)[]

    Returns Promise<void>

    Inherit Doc

  • Returns Promise<IWebElementId>

  • 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.

  • Returns Promise<void>

    Inherit Doc

  • Parameters

    • Optional optScroll: boolean

    Returns Promise<string>

    Inherit Doc

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • Parameters

    • obj: IWebElementId

      the object to test.

    Returns boolean

    whether the object is a valid encoded WebElement ID.

Generated using TypeDoc