Class OjDiagram

The component WebElement for oj-diagram. Do not instantiate this class directly, instead, use ojDiagram.

Hierarchy

Constructors

constructor

Methods

changeCurrentItem changeHiddenCategories changeHighlightedCategories changePanZoomState changeSelection clear click findElement findElements getAnimationOnDataChange getAnimationOnDisplay getAs getAttribute getCssValue getCurrentItem getDnd getFocusRenderer getHiddenCategories getHighlightMatch getHighlightedCategories getHoverBehavior getHoverRenderer getLayout getLinkContent getLinkHighlightMode getLinkProperties getLocation getMaxZoom getMinZoom getNodeContent getNodeHighlightMode getNodeProperties getOverview getPanDirection getPanZoomState getPanning getPromotedLinkBehavior getProperty getRect getRenderer getSelection getSelectionMode getSelectionRenderer getSize getStyleDefaults getText getTooltip getTouchResponse getTrackResize getTranslations getZoomRenderer getZooming 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 OjDiagram

Methods

changeCurrentItem

  • Sets the value of currentItem property. Specifies the node or link that should receive focus.

    Parameters

    • currentItem: any

      The value to set for currentItem

    Returns Promise<void>

changeHiddenCategories

  • Sets the value of hiddenCategories property. Specifies categories used for filtering.

    Parameters

    • hiddenCategories: string[]

      The value to set for hiddenCategories

    Returns Promise<void>

changeHighlightedCategories

  • Sets the value of highlightedCategories property. Specifies categories used for highlighting.

    Parameters

    • highlightedCategories: string[]

      The value to set for highlightedCategories

    Returns Promise<void>

changePanZoomState

  • Sets the value of panZoomState property. A writeback object that contains properties zoom, centerX, and centerY that represent the panZoomState

    Parameters

    • panZoomState: PanZoomState

      The value to set for panZoomState

    Returns Promise<void>

changeSelection

  • Sets the value of selection property. An array containing the ids of the selected nodes and links.

    Parameters

    • selection: any[]

      The value to set for selection

    Returns Promise<void>

clear

click

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. An alias for the '$current' context variable passed to slot content for the nodeTemplate 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

getCurrentItem

  • Gets the value of currentItem property. Specifies the node or link that should receive focus.

    Returns Promise<any>

    The value of currentItem property.

getDnd

  • Gets the value of dnd property. Used to customize the drag and drop features.

    Returns Promise<Dnd>

    The value of dnd property.

getFocusRenderer

  • Gets the value of focusRenderer property. Specifies custom renderer for the diagram nodes used for focus updates.

    Returns Promise<null>

    The value of focusRenderer property.

    Deprecated

    Since 8.0.0. Use nodeContent.focusRenderer instead.

getHiddenCategories

  • Gets the value of hiddenCategories property. Specifies categories used for filtering.

    Returns Promise<string[]>

    The value of hiddenCategories property.

getHighlightMatch

  • Gets the value of highlightMatch property. Specifies matching condition used for category highlighting.

    Returns Promise<string>

    The value of highlightMatch property.

getHighlightedCategories

  • Gets the value of highlightedCategories property. Specifies categories used for highlighting.

    Returns Promise<string[]>

    The value of highlightedCategories property.

getHoverBehavior

  • Gets the value of hoverBehavior property. Defines the behavior applied when hovering over diagram nodes and links.

    Returns Promise<string>

    The value of hoverBehavior property.

getHoverRenderer

  • Gets the value of hoverRenderer property. Specifies custom renderer for the diagram nodes used for hover updates.

    Returns Promise<null>

    The value of hoverRenderer property.

    Deprecated

    Since 8.0.0. Use nodeContent.hoverRenderer instead.

getLayout

  • Gets the value of layout property. Specifies layout callback used to position nodes and links.

    Returns Promise<null>

    The value of layout property.

getLinkContent

  • Gets the value of linkContent property. An object containing an optional callbacks function for link customization.

    Returns Promise<LinkContent>

    The value of linkContent property.

getLinkHighlightMode

  • Gets the value of linkHighlightMode property. Defines link highlighting mode.

    Returns Promise<string>

    The value of linkHighlightMode property.

getLinkProperties

  • Gets the value of linkProperties property. Optional callback for customizing link appearance based on link data.

    Returns Promise<null>

    The value of linkProperties property.

    Deprecated

    Since 6.0.0. See nodeData and linkData usage.

getLocation

getMaxZoom

  • Gets the value of maxZoom property. Specifies the maximum zoom level for this diagram.

    Returns Promise<number>

    The value of maxZoom property.

getMinZoom

  • Gets the value of minZoom property. Specifies the minimum zoom level for this diagram.

    Returns Promise<number>

    The value of minZoom property.

getNodeContent

  • Gets the value of nodeContent property. An object containing an optional callbacks function for node customization.

    Returns Promise<NodeContent>

    The value of nodeContent property.

getNodeHighlightMode

  • Gets the value of nodeHighlightMode property. Defines node highlighting mode.

    Returns Promise<string>

    The value of nodeHighlightMode property.

getNodeProperties

  • Gets the value of nodeProperties property. Optional callback for customizing node appearance based on node data.

    Returns Promise<null>

    The value of nodeProperties property.

    Deprecated

    Since 6.0.0. See nodeData and linkData usage.

getOverview

  • Gets the value of overview property. An object, used to define a diagram overview. If not specified, no overview will be shown.

    Returns Promise<Overview>

    The value of overview property.

getPanDirection

  • Gets the value of panDirection property. Specifies if panning allowed in horizontal and vertical directions.

    Returns Promise<string>

    The value of panDirection property.

getPanZoomState

  • Gets the value of panZoomState property. A writeback object that contains properties zoom, centerX, and centerY that represent the panZoomState

    Returns Promise<PanZoomState>

    The value of panZoomState property.

getPanning

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

    Returns Promise<string>

    The value of panning property.

getPromotedLinkBehavior

  • Gets the value of promotedLinkBehavior property. Defines promoted link behavior for the component.

    Returns Promise<string>

    The value of promotedLinkBehavior 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. Specifies custom renderer for the diagram nodes used for initial rendering.

    Returns Promise<null>

    The value of renderer property.

    Deprecated

    Since 8.0.0. Use nodeContent.renderer instead.

getSelection

  • Gets the value of selection property. An array containing the ids of the selected nodes and links.

    Returns Promise<any[]>

    The value of selection property.

getSelectionMode

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

    Returns Promise<string>

    The value of selectionMode property.

getSelectionRenderer

  • Gets the value of selectionRenderer property. Specifies custom renderer for the diagram nodes used for selection updates.

    Returns Promise<null>

    The value of selectionRenderer property.

    Deprecated

    Since 8.0.0. Use nodeContent.selectionRenderer instead.

getSize

getStyleDefaults

getText

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 touch response behavior.

    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.

getZoomRenderer

  • Gets the value of zoomRenderer property. Specifies custom renderer for the diagram nodes used for zoom updates.

    Returns Promise<null>

    The value of zoomRenderer property.

    Deprecated

    Since 8.0.0. Use nodeContent.zoomRenderer instead.

getZooming

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

    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

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