Class OjThematicMap

The component WebElement for oj-thematic-map. Do not instantiate this class directly, instead, use ojThematicMap.

Hierarchy

  • OjThematicMapBase
    • OjThematicMap

Constructors

constructor

Methods

changeHiddenCategories changeHighlightedCategories changeSelection clear click findElement findElements getAnimationDuration getAnimationOnDisplay getAreas getAs getAttribute getCssValue getDriver getFocusRenderer getHiddenCategories getHighlightMatch getHighlightedCategories getHoverBehavior getHoverRenderer getId getInitialZooming getIsolatedItem getLabelDisplay getLabelType getLinks getLocation getMapProvider getMarkerZoomBehavior getMarkers getMaxZoom getPanning getProperty getRect getRenderer getSelection getSelectionMode getSelectionRenderer getShadowRoot getSize getStyleDefaults getTagName getText getTooltip getTooltipDisplay getTouchResponse getTrackResize getTranslations getZooming 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 OjThematicMap

Methods

changeHiddenCategories

  • Sets the value of hiddenCategories property. An array of category strings used for filtering. Data items matching categories 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>

changeSelection

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

    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

getAnimationDuration

  • Gets the value of animationDuration property. The duration of the animations in milliseconds. See the Help documentation for more information.

    Returns Promise<number>

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

getAreas

  • Gets the value of areas property. An array of objects that define area data layers. Also accepts a Promise for deferred data rendering. See the Help documentation for more information.

    Returns Promise<null | Areas[]>

    The value of areas property.

getAs

  • Gets the value of as property. An alias for the '$current' context variable passed to slot content for the areaTemplate, markerTemplate, or linkTemplate slots.

    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

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getDriver

  • Returns WebDriver

    The parent driver for this instance.

getFocusRenderer

  • Gets the value of focusRenderer property. An optional callback function to update the data item in response to changes in keyboard focus state. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.

    Returns Promise<null>

    The value of focusRenderer property.

getHiddenCategories

  • Gets the value of hiddenCategories property. An array of category strings used for filtering. Data items matching categories 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.

getHoverRenderer

  • Gets the value of hoverRenderer property. An optional callback function to update the node in response to changes in hover state. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.

    Returns Promise<null>

    The value of hoverRenderer property.

getId

  • Returns Promise<string>

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

getInitialZooming

  • Gets the value of initialZooming property. Specifies whether the map will zoom to fit the data objects on initial render.

    Returns Promise<string>

    The value of initialZooming property.

getIsolatedItem

  • Gets the value of isolatedItem property. The id for the isolated area of this area data layer. If set, only the isolated area will be displayed.

    Returns Promise<any>

    The value of isolatedItem property.

getLabelDisplay

  • Gets the value of labelDisplay property. Specifies how labels for this layer should be displayed.

    Returns Promise<string>

    The value of labelDisplay property.

getLabelType

  • Gets the value of labelType property. Specifies which type of map labels to display.

    Returns Promise<string>

    The value of labelType property.

getLinks

  • Gets the value of links property. An array of objects that define the map links. Also accepts a Promise for deferred data rendering. See the Help documentation for more information.

    Returns Promise<null | Links[]>

    The value of links property.

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

getMapProvider

  • Gets the value of mapProvider property. An object defining a custom map.

    Returns Promise<MapProvider>

    The value of mapProvider property.

getMarkerZoomBehavior

  • Gets the value of markerZoomBehavior property. Specifies marker behavior on zoom.

    Returns Promise<string>

    The value of markerZoomBehavior property.

getMarkers

  • Gets the value of markers property. An array of objects that define marker data layers. Also accepts a Promise for deferred data rendering. See the Help documentation for more information.

    Returns Promise<null | Markers[]>

    The value of markers property.

getMaxZoom

  • Gets the value of maxZoom property. Specifies the maximum zoom level for this element. Must be greater than or equal to 1.0. See the Help documentation for more information.

    Returns Promise<number>

    The value of maxZoom property.

getPanning

  • Gets the value of panning property. Specifies whether element panning is allowed.

    Returns Promise<string>

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

getRenderer

  • Gets the value of renderer property. An optional callback function to stamp custom SVG elements for a data layer. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.

    Returns Promise<null>

    The value of renderer property.

getSelection

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

    Returns Promise<any[]>

    The value of selection property.

getSelectionMode

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

    Returns Promise<string>

    The value of selectionMode property.

getSelectionRenderer

  • Gets the value of selectionRenderer property. An optional callback function to update the data item in response to changes in selection state. The function takes a context argument, provided by the thematic map. See the Help documentation for more information.

    Returns Promise<null>

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

getStyleDefaults

  • Gets the value of styleDefaults property. An object defining the style defaults for this thematic map. See the Help documentation for more information.

    Returns Promise<StyleDefaults>

    The value of styleDefaults property.

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

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.

getTooltipDisplay

  • Gets the value of tooltipDisplay property. Specifies the tooltip behavior of the thematic map.

    Returns Promise<string>

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

getZooming

  • Gets the value of zooming property. Specifies whether element zooming is allowed.

    Returns Promise<string>

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