Component: ojDiagram

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

Options


Binding Attributes
Context Objects
Sub-ID's

oj. ojDiagram extends oj.dvtBaseComponent

Version:
  • 3.2.0
Since:
  • 1.1.0

JET Diagram Component

Diagrams are used to display a set of nodes and the links between them.

This component should be bound to an HTML div element, and the SVG DOM that it generates should be treated as a black box, as it is subject to change. This component should not be extended.


<div data-bind="ojComponent: {
  component: 'ojDiagram',
  layout : customLayoutObj.doLayout,
  nodes: [{id: N0, label: "Node 0",
           icon : {color: "#fdffcc", width: 10, height : 10}},
          {id: N1, label: "Node 1",
            icon : {color: "#2190e5", width: 20, height : 20}},
          {id: N2, label: "Node 2",
            icon : {color: "#5ea7d9", width: 30, height : 30}}],
  links : [{id: "L0", startNode : "N0", endNode : "N1"},
           {id: "L1", startNode : "N1", endNode : "N2"],
           {id: "L2", startNode : "N2", endNode : "N0"]]
}"/>

Accessibility

The application is responsible for populating the shortDesc value in the component options object with meaningful descriptors when the component does not provide a default descriptor. Since component terminology for keyboard and touch shortcuts can conflict with those of the application, it is the application's responsibility to provide these shortcuts, possibly via a help popup.

Touch End User Information

Target Gesture Action
Node or Link Tap Select when selectionMode is enabled.
Press & Hold Display tooltip.
Display context menu on release.

Keyboard End User Information

Key Action
Tab Move focus to next component.
Shift + Tab Move focus to previous component.
+ Zoom in one level.
- Zoom out one level.
0 (zero) Zoom to fit.
Ctrl + Alt + 0 (zero) Zoom and center.
PageUp or PageDown Pan up / down.
Shift + PageUp or PageDown Pan left/right (RTL: Pan right/left).
LeftArrow or RightArrow When focus is on a node, move focus and selection to nearest node left/right.
UpArrow or DownArrow When focus is on a node, move focus and selection to nearest node up/down.
Alt + < or Alt + > Move focus from the node to a link.
UpArrow or DownArrow When focus is on a link, navigate between links clockwise or counter clockwise.
LeftArrow or RightArrow When focus is on a link, move focus from a link to a start or end node.
Ctrl + Space Select focused node / link.
Ctrl + Space Multi-select node / link with focus.
Shift + <node or link navigation shortcut> Move focus and multi-select a node or a link.
Ctrl + <node or link navigation shortcut> Move focus to a node or a link but do not select.

Performance

Animation

Animation should only be enabled for visualizations of small to medium data sets. Alternate visualizations should be considered if identifying data changes is important, since all nodes will generally move and resize on any data change.

Data Set Size

Applications should avoid setting very large data densities on this component. Applications can aggregate small nodes to reduce the displayed data set size.

Style Attributes

Use the highest level options property available. For example, consider using attributes on styleDefaults.nodeDefaults, styleDefaults.linkDefaults, instead of attributes on the individual nodes and links. The component can take advantage of these higher level attributes to apply the style properties on containers, saving expensive DOM calls.

Tracking Resize

By default, the component will track resizes and render at the new size. This functionality adds a small overhead to the initial render for simple components like gauges or spark charts, which become noticable when using large numbers of these simple components. To disable resize tracking, set trackResize to off. The application can manually request a re-render at any time by calling the refresh function.

Reading direction

As with any JET component, in the unusual case that the directionality (LTR or RTL) changes post-init, the component must be refresh()ed.

Initializer

.ojDiagram()

Creates a JET Diagram.
Source:
Example

Initialize the Diagram:

$(".selector").ojDiagram(layout : customLayoutObj.doLayout,
                            nodes:[{id:N0,label:"Node 0",icon:{color:"#fdffcc",width:10,height:10}},
                                   {id:N1,label:"Node 1",icon:{color:"#2190e5",width:20,height:20}},
                                   {id:N2,label:"Node 2",icon:{color:"#5ea7d9",width:30,height:30}}],
                            links:[{id:"L0",startNode:"N0",endNode:"N1"},
                                    {id:"L1",startNode:"N1",endNode:"N2"},
                                    {id:"L2",startNode:"N2",endNode:"N0"}]);

Options

animationOnDataChange :string

Specifies the animation that is applied on data changes.
Supported Values:
Name Type
"auto" string
"none" string
Default Value:
  • "none"
Source:

animationOnDisplay :string

Specifies the animation that is shown on initial display.
Supported Values:
Name Type
"auto" string
"none" string
Default Value:
  • "none"
Source:

childNodes :function(object)

A callback function for fetching child nodes. This function will be called to retrieve the children of each expanded node. The function takes a single argument, provided by the component, with the following properties:
  • id: The id of the parent node
  • type : Object type - "node"
  • label: The parent node label
  • component: ojDiagram widget constructor
  • data : The parent node data
The function should return one of the following:
  • An array of nodes.
  • Promise: a Promise that will resolve with an array of nodes.
See the documentation for the nodes[].nodes option for additional information.
Default Value:
  • null
Deprecated:
  • This attribute is deprecated, use the data attribute instead.
    Source:

    contextMenu :Element|Array.<Element>|string|jQuery|NodeList

    Identifies the JET Menu that the component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the specified JET Menu.

    The value can be an HTML element, JQ selector, JQ object, NodeList, or array of elements. In all cases, the first indicated element is used.

    To specify a JET context menu on a DOM element that is not a JET component, see the ojContextMenu binding.

    To make the page semantically accurate from the outset, applications are encouraged to specify the context menu via the standard HTML5 syntax shown in the below example. When the component is initialized, the context menu thus specified will be set on the component.

    There is no restriction on the order in which the JET Menu and the referencing component are initialized. However, when specifying the Menu via the HTML attribute, the referenced DOM element must be in the document at the time that the referencing component is initialized.

    After create time, the contextMenu option should be set via this API, not by setting the DOM attribute.

    The application can register a listener for the Menu's beforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

    To help determine whether it's appropriate to cancel the launch or customize the menu, the beforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc and demos of the individual components for details. Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

    Default Value:
    • null
    Inherited From:
    Source:
    Examples

    Initialize a JET component with a context menu:

    // via recommended HTML5 syntax:
    <div id="myComponent" contextmenu="myMenu" data-bind="ojComponent: { ... }>
    
    // via JET initializer (less preferred) :
    // Foo is the component, e.g., InputText, InputNumber, Select, etc.
    $( ".selector" ).ojFoo({ "contextMenu": "#myMenu" });

    Get or set the contextMenu option, after initialization:

    // getter
    // Foo is the component, e.g., InputText, InputNumber, Select, etc.
    var menu = $( ".selector" ).ojFoo( "option", "contextMenu" );
    
    // setter
    // Foo is the component, e.g., InputText, InputNumber, Select, etc.
    $( ".selector" ).ojFoo( "option", "contextMenu", ".my-marker-class" );

    Set a JET context menu on an ordinary HTML element:

    <a href="#" id="myAnchor" contextmenu="myMenu" data-bind="ojContextMenu: {}">Some text

    data :object

    The data source for the Diagram component. Replaced nodes, links and childNodes attributes. See oj.DiagramDataSource
    Default Value:
    • null
    Source:

    dnd :object

    Provides support for HTML5 Drag and Drop events. Please refer to third party documentation on HTML5 Drag and Drop to learn how to use it.
    Default Value:
    • null
    Source:

    dnd.drag :object

    An object that describes drag functionality.
    Default Value:
    • null
    Source:

    dnd.drag.nodes :object

    If this object is specified, the diagram will initiate drag operation when the user drags on diagram nodes.
    Default Value:
    • null
    Source:

    dnd.drag.nodes.dataTypes :string|Array.<string>

    The MIME types to use for the dragged data in the dataTransfer object. This can be a string if there is only one type, or an array of strings if multiple types are needed. For example, if selected employee data items are being dragged, dataTypes could be "application/employees+json". Drop targets can examine the data types and decide whether to accept the data. For each type in the array, dataTransfer.setData will be called with the specified type and the data. The data is an array of the dataContexts of the selected data items. The dataContext is the JSON version of the dataContext that we use for "tooltip" option, excluding component and parentElement. This property is required unless the application calls setData itself in a dragStart callback function.
    Default Value:
    • null
    Source:

    dnd.drag.nodes.drag :function($.Event)

    An optional callback function that receives the "drag" event as argument.
    Default Value:
    • null
    Source:

    dnd.drag.nodes.dragEnd :function($.Event)

    An optional callback function that receives the "dragend" event as argument.
    Default Value:
    • null
    Source:

    dnd.drag.nodes.dragStart :function($.Event, object)

    An optional callback function that receives the "dragstart" event and context information as arguments. The context information is as follows:
    • nodes {Array.(object)}: An array of dataContexts of the dragged data nodes. The dataContext for the node has the following properties:
      • id: The id of the hovered diagram object
      • type : The type of the hovered diagram object - "link", "promotedLink" or "node"
      • label: The label of the hovered diagram object.
      • component: ojDiagram widget constructor
      • data : data object for the node
      • nodeOffset : an object with x,y properties, that reflects node offset from the upper left corner of the bounding box for the dragged content.
    This function can set its own data and drag image as needed. When this function is called, event.dataTransfer is already populated with the default data and drag image.
    Default Value:
    • null
    Source:

    dnd.drag.ports :object

    If this object is specified, the diagram will initiate link creation when the user starts dragging from a port.
    Default Value:
    • null
    Source:

    dnd.drag.ports.dataTypes :string|Array.<string>

    The MIME types to use for the dragged data in the dataTransfer object. This can be a string if there is only one type, or an array of strings if multiple types are needed. and parentElement. This property is required unless the application calls setData itself in a dragStart callback function.
    Default Value:
    • null
    Source:

    dnd.drag.ports.drag :function($.Event)

    An optional callback function that receives the "drag" event as argument.
    Default Value:
    • null
    Source:

    dnd.drag.ports.dragEnd :function($.Event)

    An optional callback function that receives the "dragend" event as argument.
    Default Value:
    • null
    Source:

    dnd.drag.ports.dragStart :function($.Event, object)

    An optional callback function that receives the "dragstart" event and context information as arguments. The context information is as follows:
    • ports {object}: An object with the following properties:
      • dataContext : The dataContext object of the link start node. The dataContext is the same as what we use for "tooltip" option.
      • portElement : DOM element recognized as a port that received drag event.
    Default Value:
    • null
    Source:

    dnd.drag.ports.linkStyle :function(object)

    An optional callback function for customizing link feedback based on a starting node and a port. If the function is not specified the link feedback will use default link styles. The function will take a single parameter - a context object with the following properties:
    • dataContext: The dataContext object of the link start node.
    • portElement: DOM element recognized as a port that received drag event
    The function should return one of the following:
    • an object with the following properties:
      • svgStyle : Inline stlye object to be applied on the link feedback
      • svgClassName : A name of a style class to be applied on the link
    • null or undefined : the default link styles will be used for the link feedback
    Default Value:
    • null
    Source:

    dnd.drag.ports.selector :string

    A string, containing a selector expression, that will be used to identify the descendant DOM element in a diagram node that can be used for link creation. This property is requred.
    Default Value:
    • null
    Source:

    dnd.drop :object

    An object that describes drop functionality.
    Default Value:
    • null
    Source:

    dnd.drop.background :object

    Allows dropping on the diagram background.
    Default Value:
    • null
    Source:

    dnd.drop.background.dataTypes :string|Array.<string>

    An array of MIME data types this component can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
    Default Value:
    • null
    Source:

    dnd.drop.background.dragEnter :function($.Event, object)

    An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.background.dragLeave :function($.Event, object)

    An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    Default Value:
    • null
    Source:

    dnd.drop.background.dragOver :function($.Event, object)

    An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.background.drop :function($.Event, object)

    An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise.
    Default Value:
    • null
    Source:
    Allows dropping on diagram links.
    Default Value:
    • null
    Source:

    dnd.drop.links.dataTypes :string|Array.<string>

    An array of MIME data types this component can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
    Default Value:
    • null
    Source:

    dnd.drop.links.dragEnter :function($.Event, object)

    An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • linkContext {object}: the JSON version of the data context for the target link.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.links.dragLeave :function($.Event, object)

    An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • linkContext {object}: the JSON version of the data context for the target link.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    Default Value:
    • null
    Source:

    dnd.drop.links.dragOver :function($.Event, object)

    An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • linkContext {object}: the JSON version of the data context for the target link.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.links.drop :function($.Event, object)

    An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • linkContext {object}: the JSON version of the data context for the target link.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise.
    Default Value:
    • null
    Source:

    dnd.drop.nodes :object

    Allows dropping on diagram nodes.
    Default Value:
    • null
    Source:

    dnd.drop.nodes.dataTypes :string|Array.<string>

    An array of MIME data types this component can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
    Default Value:
    • null
    Source:

    dnd.drop.nodes.dragEnter :function($.Event, object)

    An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • nodeX {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeY {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeContext {object}: the JSON version of the data context for the target node.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.nodes.dragLeave :function($.Event, object)

    An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • nodeX {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeY {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeContext {object}: the JSON version of the data context for the target node.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    Default Value:
    • null
    Source:

    dnd.drop.nodes.dragOver :function($.Event, object)

    An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • nodeX {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeY {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeContext {object}: the JSON version of the data context for the target node.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.nodes.drop :function($.Event, object)

    An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
    • x {number}: x-coordinate value of the drop in the component coordinate system.
    • y {number}: y-coordinate value of the drop in the component coordinate system.
    • nodeX {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeY {number}: x-coordinate value of the drop in the target node coordinate system.
    • nodeContext {object}: the JSON version of the data context for the target node.
    Note: When the dropped items are originated from Diagram, the x, y coordinates represent the upper left corner of the dropped content.
    This function should return false to indicate the dragged data can be accepted or true otherwise.
    Default Value:
    • null
    Source:

    dnd.drop.ports :object

    Allows dropping a link end on a port.
    Default Value:
    • null
    Source:

    dnd.drop.ports.dataTypes :string|Array.<string>

    An array of MIME data types this component can accept. This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.
    Default Value:
    • null
    Source:

    dnd.drop.ports.dragEnter :function($.Event, object)

    An optional callback function that receives the "dragenter" event and context information as arguments. The context information is as follows:
    • dataContext : the JSON version of the data context for the link end node.
    • portElement : DOM element that represents a port that received drop event.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.ports.dragLeave :function($.Event, object)

    An optional callback function that receives the "dragleave" event and context information as arguments. The context information is as follows:
    • dataContext : the JSON version of the data context for the link end node.
    • portElement : DOM element that represents a port that received drop event.
    Default Value:
    • null
    Source:

    dnd.drop.ports.dragOver :function($.Event, object)

    An optional callback function that receives the "dragover" event and context information as arguments. The context information is as follows:
    • dataContext : the JSON version of the data context for the link end node.
    • portElement : DOM element that represents a port that received drop event.
    This function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.
    Default Value:
    • null
    Source:

    dnd.drop.ports.drop :function($.Event, object)

    An optional callback function that receives the "drop" event and context information as arguments. The context information is as follows:
    • dataContext : the JSON version of the data context for the link end node.
    • portElement : DOM element that represents a port that received drop event.
    This function should return false to indicate the dragged data can be accepted or true otherwise.
    Default Value:
    • null
    Source:

    dnd.drop.ports.selector :string

    A string, containing a selector expression, that will be used to identify the descendant DOM element in a diagram node that can be used for link creation. This property is requred.
    Default Value:
    • null
    Source:

    expanded :Array.<string>|string

    Specifies the nodes that should be expanded on initial render. It should contain an array of node ids to expand on initial render. Specify 'all' to expand all nodes.
    Default Value:
    • null
    Source:

    focusRenderer :function(object)

    An optional callback function to update the node in response to changes in keyboard focus state. The function takes a single argument, provided by the component, with the following properties:
    • component: A reference to the Diagram widget constructor.
    • data: The data object for the node.
    • parentElement: A parent group element that takes a custom SVG fragment as the node content. Modifications of the parentElement are not supported.
    • rootElement: An SVG fragment created as a node content.
    • state: An object that reflects the current state of the diagram node. The object has the following properties
      • hovered: hovered state, boolean.
      • selected: selected state, boolean.
      • focused: focused state, boolean.
      • zoom: zoom state, number.
    • previousState: An object that reflects the previous state of the diagram node. The object has the following properties
      • hovered: hovered state, boolean.
      • selected: selected state, boolean.
      • focused: focused state, boolean.
      • zoom: zoom state, number.
    • id: Node id.
    • type: Object type = node.
    • label: Node label.
    The function should return one of the following:
    • an object - DOM element of the created or modified content (an SVG fragment as Diagram Node content).
    • nothing : Indicates that the node content should be removed.
    Default Value:
    • null
    Source:

    hiddenCategories :Array.<string>

    An array of category strings used for category filtering. Diagram nodes and links with a category in hiddenCategories will be filtered.
    Default Value:
    • null
    Source:

    highlightMatch :string

    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.
    Supported Values:
    Name Type
    "any" string
    "all" string
    Default Value:
    • "all"
    Source:

    highlightedCategories :Array.<string>

    An array of category strings used for category highlighting. Diagram nodes and links with a category in highlightedCategories will be highlighted.
    Default Value:
    • null
    Source:

    hoverBehavior :string

    Defines the behavior applied when hovering over diagram nodes and links.
    Supported Values:
    Name Type
    "dim" string
    "none" string
    Default Value:
    • "none"
    Source:

    hoverRenderer :function(object)

    An optional callback function to update the node in response to changes in hover state. The function takes a single argument, provided by the component, with the following properties:
    • component: A reference to the Diagram widget constructor.
    • data: The data object for the node.
    • parentElement: A parent group element that takes a custom SVG fragment as the node content. Modifications of the parentElement are not supported.
    • rootElement: An SVG fragment created as a node content.
    • state: An object that reflects the current state of the diagram node. The object has the following properties
      • hovered: hovered state, boolean.
      • selected: selected state, boolean.
      • focused: focused state, boolean.
      • zoom: zoom state, number.
    • previousState: An object that reflects the previous state of the diagram node. The object has the following properties
      • hovered: hovered state, boolean.
      • selected: selected state, boolean.
      • focused: focused state, boolean.
      • zoom: zoom state, number.
    • id: Node id.
    • type: Object type = node.
    • label: Node label.
    The function should return one of the following:
    • an object - DOM element of the created or modified content (an SVG fragment as Diagram Node content).
    • nothing : Indicates that the node content should be removed.
    Default Value:
    • null
    Source:

    layout :function(object)

    A custom JavaScript client layout method - a custom code developed by a customer used to position Diagram nodes and links. The layout code must conform to the pluggable layout contract.
    Default Value:
    • null
    Source:
    See:

    linkHighlightMode :string

    Defines link highlighting mode.
    Supported Values:
    Name Type
    "linkAndNodes" string
    "link" string
    Default Value:
    • "link"
    Source:

    linkProperties :function(object)

    Optional callback that provides a way to customize an appearance of the specific link, the function maps link data into link styles.
    Default Value:
    • null
    Source:
    An array of objects with the following properties that defines the data for the links. Also accepts a Promise or callback function for deferred data rendering. The function should return one of the following:
    • Promise: A Promise that will resolve with an array of data items. No data will be rendered if the Promise is rejected.
    • Array: An array of data items.
    Default Value:
    • null
    Deprecated:
    • This attribute is deprecated, use the data attribute instead.
      Source:

      links[].categories :Array.<string>

      An optional array of additional category strings corresponding to this data item. This enables highlighting and filtering of individual data items through interactions with other components. Defaults to value of link id if unspecified.
      Default Value:
      • null
      Source:

      links[].className :string

      The CSS style class defining the style of the link.
      Default Value:
      • null
      Source:

      links[].color :string

      Link color.
      Default Value:
      • null
      Source:

      links[].endConnectorType :string

      Specifies the type of end connector on the link.
      Supported Values:
      Name Type
      "arrowOpen" string
      "arrow" string
      "arrowConcave" string
      "circle" string
      "rectangle" string
      "rectangleRounded" string
      "none" string
      Default Value:
      • "none"
      Source:

      links[].endNode :string

      The id of the end node.
      Default Value:
      • null
      Source:

      links[].id :string

      The id of this link.
      Default Value:
      • null
      Source:

      links[].label :string

      Primary label for the link.
      Default Value:
      • null
      Source:

      links[].labelStyle :string

      The CSS style string defining the style of the primary label.
      Default Value:
      • null
      Source:

      links[].selectable :string

      Specifies whether or not the link will be selectable.
      Supported Values:
      Name Type
      "off" string
      "auto" string
      Default Value:
      • "auto"
      Source:

      links[].shortDesc :string

      The description of the link. This is used for accessibility and also for customizing the tooltip text.
      Default Value:
      • null
      Source:

      links[].startConnectorType :string

      Specifies the type of start connector on the link.
      Supported Values:
      Name Type
      "arrowOpen" string
      "arrow" string
      "arrowConcave" string
      "circle" string
      "rectangle" string
      "rectangleRounded" string
      "none" string
      Default Value:
      • "none"
      Source:

      links[].startNode :string

      The id of the start node.
      Default Value:
      • null
      Source:

      links[].style :string|object

      The link style attribute can be string or object. The style string represents Link style type with following values: solid(default), dash, dot, dashDot. The style string representation has been deprecated. Consider specifying stroke-dasharray in the style object. The style object represents the CSS style of the link. User defined custom CSS Styles will be applied directly on the link.
      Default Value:
      • null
      Source:

      links[].width :number

      Link width in pixels.
      Default Value:
      • 1.0
      Source:

      maxZoom :number

      Specifies the maximum zoom level for this diagram. This can be any number greater than zero which indicates the maximum point to which Diagram objects can be scaled. A value of 2.0 implies that the Diagram can be zoomed in until Nodes appear at twice their natural size. By default, maxZoom is 1.0.
      Default Value:
      • 1.0
      Source:

      minZoom :number

      Specifies the minimum zoom level for this diagram. If minZoom is greater than zero, it indicates the minimum point to which Diagram objects can be scaled. A value of 0.1 implies that the Diagram can be zoomed out until Nodes appear at one-tenth their natural size. By default, minZoom is set to zoom-to-fit level based on the currently visible Nodes and Links.
      Default Value:
      • null
      Source:

      nodeHighlightMode :string

      Defines node highlighting mode.
      Supported Values:
      Name Type
      "nodeAndIncomingLinks" string
      "nodeAndOutgoingLinks" string
      "nodeAndLinks" string
      "node" string
      Default Value:
      • "node"
      Source:

      nodeProperties :function(object)

      Optional callback that provides a way to customize an appearance of the specific node, the function maps node data into node styles.
      Default Value:
      • null
      Source:

      nodes :Array.<object>|Promise|function<>

      An array of objects with the following properties that defines the data for the nodes. Also accepts a Promise or callback function for deferred data rendering. The function should return one of the following:
      • Promise: A Promise that will resolve with an array of data items. No data will be rendered if the Promise is rejected.
      • Array: An array of data items.
      Default Value:
      • null
      Deprecated:
      • This attribute is deprecated, use the data attribute instead.
        Source:

        nodes[].backgroundClassName :string

        The CSS style class defining the style of the node background.
        Default Value:
        • null
        Source:

        nodes[].backgroundStyle :string|object

        The CSS style string/object defining the style of the node background.
        Default Value:
        • null
        Source:

        nodes[].categories :Array.<string>

        An optional array of additional category strings corresponding to this data item. This enables highlighting and filtering of individual data items through interactions with other components. Defaults to value of node id if unspecified.
        Default Value:
        • null
        Source:

        nodes[].containerClassName :string

        The CSS style class defining the style of the expanded container node.
        Default Value:
        • null
        Source:

        nodes[].containerStyle :object

        The CSS style object defining the style of the expanded container node.
        Default Value:
        • null
        Source:

        nodes[].icon :object

        Specifies an icon to be used as a graphical element for the node
        Default Value:
        • null
        Source:

        nodes[].icon.borderColor :string

        The border color of this icon.
        Default Value:
        • null
        Source:

        nodes[].icon.borderWidth :number

        The border width in pixels.
        Default Value:
        • null
        Source:

        nodes[].icon.className :string

        The CSS style class defining the style of the icon.
        Default Value:
        • null
        Source:

        nodes[].icon.color :string

        The fill color of this icon.
        Default Value:
        • null
        Source:

        nodes[].icon.halign :string

        Horizontal alignment for the icon relative to the given background.
        Supported Values:
        Name Type
        "left" string
        "right" string
        "center" string
        Default Value:
        • "center"
        Source:

        nodes[].icon.height :number

        The height of this icon.
        Default Value:
        • null
        Source:

        nodes[].icon.opacity :number

        The opacity of this icon.
        Default Value:
        • null
        Source:

        nodes[].icon.pattern :string

        The fill pattern of this icon.
        Supported Values:
        Name Type
        "smallChecker" string
        "smallCrosshatch" string
        "smallDiagonalLeft" string
        "smallDiagonalRight" string
        "smallDiamond" string
        "smallTriangle" string
        "largeChecker" string
        "largeCrosshatch" string
        "largeDiagonalLeft" string
        "largeDiagonalRight" string
        "largeDiamond" string
        "largeTriangle" string
        "none" string
        Default Value:
        • "none"
        Source:

        nodes[].icon.positionX :number|string

        The x coordinate of the icon top left corner relative to the given background - pixels or %. The option takes precedence over halign option
        Default Value:
        • null
        Source:

        nodes[].icon.positionY :number|string

        The y coordinate of the icon top left corner relative to the given background - pixels or %. The option takes precedence over valign option
        Default Value:
        • null
        Source:

        nodes[].icon.shape :string

        The shape of this icon. Can take the name of a built-in shape or the svg path commands for a custom shape.
        Supported Values:
        Name Type
        "square" string
        "plus" string
        "diamond" string
        "triangleUp" string
        "triangleDown" string
        "human" string
        "rectangle" string
        "star" string
        "circle" string
        Default Value:
        • "circle"
        Source:

        nodes[].icon.source :string

        The URI of the node image.
        Default Value:
        • null
        Source:

        nodes[].icon.sourceHover :string

        The optional URI of the node hover image. If not defined, the source image will be used.
        Default Value:
        • null
        Source:

        nodes[].icon.sourceHoverSelected :string

        The optional URI of the selected image on hover. If not defined, the sourceSelected image will be used. If the sourceSelected image is not defined, the source image will be used.
        Default Value:
        • null
        Source:

        nodes[].icon.sourceSelected :string

        The optional URI of the selected image. If not defined, the source image will be used.
        Default Value:
        • null
        Source:

        nodes[].icon.style :object

        The CSS style object defining the style of the icon.
        Default Value:
        • null
        Source:

        nodes[].icon.valign :string

        Vertical alignment for the icon relative to the given background.
        Supported Values:
        Name Type
        "top" string
        "bottom" string
        "center" string
        Default Value:
        • "center"
        Source:

        nodes[].icon.width :number

        The width of this icon.
        Default Value:
        • null
        Source:

        nodes[].id :string

        The id of this node.
        Default Value:
        • null
        Source:

        nodes[].label :string

        Primary label for the node.
        Default Value:
        • null
        Source:

        nodes[].labelStyle :string

        The CSS style string defining the style of the primary label.
        Default Value:
        • null
        Source:

        nodes[].nodes :Array.<object>|Promise

        An array of objects with properties for the child nodes. Also a Promise that will resolve with an array of data items.
        Due to the fact that Promises begin resolving immediately, the recommended way to load child nodes on demand is via the callback function (which can return a Promise) using childNodes option in the component. In the case when all container nodes are expanded, the best approach is to pass a top-level Promise that resolves to a fully realized node hierarchy.
        Note that the callback function will only be called for this node if the nodes option is undefined. Any other value (including null or an empty array) will take precedence over the callback function.
        Default Value:
        • null
        Source:

        nodes[].selectable :string

        Specifies whether or not the node will be selectable.
        Supported Values:
        Name Type
        "off" string
        "auto" string
        Default Value:
        • "auto"
        Source:

        nodes[].shortDesc :string

        The description of the node. This is used for accessibility and also for customizing the tooltip text.
        Default Value:
        • null
        Source:

        nodes[].showDisclosure :string

        Determines when to display the expand/collapse button.
        Supported Values:
        Name Type
        "off" string
        "on" string
        Default Value:
        • "on"
        Source:

        panDirection :string

        Specifies if panning allowed in horizontal and vertical directions.
        Supported Values:
        Name Type
        "x" string
        "y" string
        "auto" string
        Default Value:
        • "auto"
        Source:

        panning :string

        Specifies whether component panning is allowed.
        Supported Values:
        Name Type
        "auto" string
        "none" string
        Default Value:
        • "none"
        Source:

        promotedLinkBehavior :string

        Defines promoted link behavior for the component.
        If the value is set to none, the diagram will not retrieve additional data to resolve promoted links and will not display promoted links.
        If the value is set to lazy, the diagram will retrieve additional data to resolve promoted links if the data is already available and will display available promoted links. The component will not retrieve additional data if the data is not available yet.
        If the value is set to full, the diagram will retrieve additional data to resolve all promoted links and will display promoted links.
        Supported Values:
        Name Type
        "none" string
        "full" string
        "lazy" string
        Default Value:
        • "lazy"
        Source:

        renderer :function(object)

        A callback function - a custom renderer - that will be used for initial node rendering. The function takes a single argument, provided by the component, with the following properties:
        • component: A reference to the Diagram widget constructor.
        • data: The data object for the node.
        • parentElement: a parent group element that takes a custom SVG fragment as the node content. Modifications of the parentElement are not supported.
        • content: An object that describes child content. The object has the following properties
          • element: an SVG group element that contains child nodes for the container.
          • width: width of the child content.
          • height: height of the child content.
        • state: An object that reflects the current state of the diagram node. The object has the following properties
          • hovered: hovered state, boolean.
          • selected: selected state, boolean.
          • focused: focused state, boolean.
          • zoom: zoom state, number.
          • expanded: expanded state, boolean.
        • previousState: An object that reflects the previous state of the diagram node. The object has the following properties
          • hovered: hovered state, boolean.
          • selected: selected state, boolean.
          • focused: focused state, boolean.
          • zoom: zoom state, number.
          • expanded: expanded state, boolean.
        • id: Node id.
        • type: Object type = node.
        • label: Node label.
        The function should return one of the following:
        • an object - DOM element of the created or modified content (an SVG fragment as Diagram Node content).
        • nothing : Indicates that the node content should be removed.
        Default Value:
        • null
        Source:

        rootAttributes :Object

        Attributes specified here will be set on the component's root DOM element at creation time. This is particularly useful for components like Dialog that wrap themselves in a new root element at creation time.

        The supported attributes are id, which overwrites any existing value, and class and style, which are appended to the current class and style, if any.

        Setting this option after component creation has no effect. At that time, the root element already exists, and can be accessed directly via the widget method, per the second example below.

        Default Value:
        • null
        Inherited From:
        Source:
        Examples

        Initialize a JET component, specifying a set of attributes to be set on the component's root DOM element:

        // Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc.
        $( ".selector" ).ojFoo({ "rootAttributes": {
          "id": "myId",
          "style": "max-width:100%; color:blue;",
          "class": "my-class"
        }});

        After initialization, rootAttributes should not be used. It is not needed at that time, as attributes of the root DOM element can simply be set directly, using widget:

        // Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc.
        $( ".selector" ).ojFoo( "widget" ).css( "height", "100px" );
        $( ".selector" ).ojFoo( "widget" ).addClass( "my-class" );

        selection :Array.<string>

        An array containing the ids of the selected nodes and links.
        Default Value:
        • null
        Source:

        selectionMode :string

        Specifies the selection mode.
        Supported Values:
        Name Type
        "single" string
        "multiple" string
        "none" string
        Default Value:
        • "none"
        Source:

        selectionRenderer :function(object)

        An optional callback function to update the node in response to changes in selection state. The function takes a single argument, provided by the component, with the following properties:
        • component: A reference to the Diagram widget constructor.
        • data: The data object for the node.
        • parentElement: A parent group element that takes a custom SVG fragment as the node content. Modifications of the parentElement are not supported.
        • rootElement: An SVG fragment created as a node content.
        • state: An object that reflects the current state of the diagram node. The object has the following properties
          • hovered: hovered state, boolean.
          • selected: selected state, boolean.
          • focused: focused state, boolean.
          • zoom: zoom state, number.
        • previousState: An object that reflects the previous state of the diagram node. The object has the following properties
          • hovered: hovered state, boolean.
          • selected: selected state, boolean.
          • focused: focused state, boolean.
          • zoom: zoom state, number.
        • id: Node id.
        • type: Object type = node.
        • label: Node label.
        The function should return one of the following:
        • an object - DOM element of the created or modified content (an SVG fragment as Diagram Node content).
        • nothing : Indicates that the node content should be removed.
        Default Value:
        • null
        Source:

        styleDefaults :object

        An object defining the style defaults for this diagram.
        Default Value:
        • null
        Source:

        styleDefaults.animationDuration :number|string

        The duration of the animations in milliseconds. Also accepts CSS strings such as 0.5s and 500ms.
        Default Value:
        • null
        Deprecated:
        • The string type is deprecated in 2.1.0.
          Source:

          styleDefaults.hoverBehaviorDelay :number|string

          Specifies initial hover delay in ms for highlighting data items. Also accepts CSS strings such as 1s and 1000ms.
          Default Value:
          • null
          Deprecated:
          • The string type is deprecated in 2.1.0.
            Source:

            styleDefaults.linkDefaults :object

            Default link styles
            Default Value:
            • null
            Source:

            styleDefaults.linkDefaults.color :string

            Default link color.
            Default Value:
            • null
            Source:

            styleDefaults.linkDefaults.endConnectorType :string

            Specifies the type of end connector on the link.
            Supported Values:
            Name Type
            "arrowOpen" string
            "arrow" string
            "arrowConcave" string
            "circle" string
            "rectangle" string
            "rectangleRounded" string
            "none" string
            Default Value:
            • "none"
            Source:

            styleDefaults.linkDefaults.labelStyle :string

            The CSS style string defining the style of the primary label.
            Default Value:
            • null
            Source:

            styleDefaults.linkDefaults.startConnectorType :string

            Specifies the type of start connector on the link.
            Supported Values:
            Name Type
            "arrowOpen" string
            "arrow" string
            "arrowConcave" string
            "circle" string
            "rectangle" string
            "rectangleRounded" string
            "none" string
            Default Value:
            • "none"
            Source:

            styleDefaults.linkDefaults.style :string|object

            The default link style attribute can be string or object. The default style string represents Link style type with following values: solid(default), dash, dot, dashDot. The default style string representation has been deprecated. Consider specifying stroke-dasharray in the default style object. The default style object represents the CSS style of the link. User defined custom CSS Styles will be applied directly on the link.
            Default Value:
            • null
            Deprecated:
            • This attribute is deprecated, use the svgStyle attribute instead.
              Source:

              styleDefaults.linkDefaults.svgStyle :object

              The default style object represents the CSS style of the link. User defined custom CSS Styles will be applied directly on the link.
              Default Value:
              • null
              Source:

              styleDefaults.linkDefaults.width :number

              Default link width in pixels.
              Default Value:
              • 1.0
              Source:

              styleDefaults.nodeDefaults :object

              Default node styles
              Default Value:
              • null
              Source:

              styleDefaults.nodeDefaults.backgroundStyle :string|object

              The CSS style string/object defining the style of the node background.
              Default Value:
              • null
              Deprecated:
              • This attribute is deprecated, use the backgroundSvgStyle attribute instead.
                Source:

                styleDefaults.nodeDefaults.backgroundSvgStyle :object

                The CSS style object defining the style of the node background.
                Default Value:
                • null
                Source:

                styleDefaults.nodeDefaults.containerStyle :object

                The CSS style object defining the style of the expanded container node.
                Default Value:
                • null
                Deprecated:
                • This attribute is deprecated, use the containerSvgStyle attribute instead.
                  Source:

                  styleDefaults.nodeDefaults.containerSvgStyle :object

                  The CSS style object defining the style of the expanded container node.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon :object

                  Default style for the node icon.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.borderColor :string

                  Default border color of the icon.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.borderWidth :number

                  Default border width of the icon in pixels.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.color :string

                  Default color of the icon.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.halign :string

                  Default horizontal alignment for the icon relative to the given background.
                  Supported Values:
                  Name Type
                  "left" string
                  "right" string
                  "center" string
                  Default Value:
                  • "center"
                  Source:

                  styleDefaults.nodeDefaults.icon.height :number

                  Default icon height.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.pattern :string

                  Default fill pattern of the icon.
                  Supported Values:
                  Name Type
                  "smallChecker" string
                  "smallCrosshatch" string
                  "smallDiagonalLeft" string
                  "smallDiagonalRight" string
                  "smallDiamond" string
                  "smallTriangle" string
                  "largeChecker" string
                  "largeCrosshatch" string
                  "largeDiagonalLeft" string
                  "largeDiagonalRight" string
                  "largeDiamond" string
                  "largeTriangle" string
                  "none" string
                  Default Value:
                  • "none"
                  Source:

                  styleDefaults.nodeDefaults.icon.shape :string

                  Default shape of the icon. Can take the name of a built-in shape or the svg path commands for a custom shape.
                  Supported Values:
                  Name Type
                  "square" string
                  "plus" string
                  "diamond" string
                  "triangleUp" string
                  "triangleDown" string
                  "human" string
                  "rectangle" string
                  "star" string
                  "circle" string
                  Default Value:
                  • "circle"
                  Source:

                  styleDefaults.nodeDefaults.icon.source :string

                  The URI of the node image
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.sourceHover :string

                  The optional URI of the node hover image. If not defined, the source image will be used.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.sourceHoverSelected :string

                  The optional URI of the selected image on hover. If not defined, the sourceSelected image will be used. If the sourceSelected image is not defined, the source image will be used.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.sourceSelected :string

                  The optional URI of the selected image. If not defined, the source image will be used.
                  Default Value:
                  • null
                  Source:

                  styleDefaults.nodeDefaults.icon.style :object

                  The default style object defining the style of the icon.
                  Default Value:
                  • null
                  Deprecated:
                  • This attribute is deprecated, use the svgStyle attribute instead.
                    Source:

                    styleDefaults.nodeDefaults.icon.svgStyle :object

                    The default style object defining the style of the icon.
                    Default Value:
                    • null
                    Source:

                    styleDefaults.nodeDefaults.icon.valign :string

                    Default vertical alignment for the icon relative to the given background.
                    Supported Values:
                    Name Type
                    "top" string
                    "bottom" string
                    "center" string
                    Default Value:
                    • "center"
                    Source:

                    styleDefaults.nodeDefaults.icon.width :number

                    Default icon width.
                    Default Value:
                    • null
                    Source:

                    styleDefaults.nodeDefaults.labelStyle :string

                    The CSS style string defining the style of the primary label.
                    Default Value:
                    • null
                    Source:

                    styleDefaults.nodeDefaults.showDisclosure :string

                    Determines when to display the expand/collapse button.
                    Supported Values:
                    Name Type
                    "off" string
                    "on" string
                    Default Value:
                    • "on"
                    Source:
                    Promoted link styles
                    Default Value:
                    • null
                    Source:

                    styleDefaults.promotedLink.color :string

                    Default promoted link color.
                    Default Value:
                    • null
                    Source:

                    styleDefaults.promotedLink.endConnectorType :string

                    Specifies the type of end connector on the promoted link.
                    Supported Values:
                    Name Type
                    "arrowOpen" string
                    "arrow" string
                    "arrowConcave" string
                    "circle" string
                    "rectangle" string
                    "rectangleRounded" string
                    "none" string
                    Default Value:
                    • "none"
                    Source:

                    styleDefaults.promotedLink.startConnectorType :string

                    Specifies the type of start connector on the promoted link.
                    Supported Values:
                    Name Type
                    "arrowOpen" string
                    "arrow" string
                    "arrowConcave" string
                    "circle" string
                    "rectangle" string
                    "rectangleRounded" string
                    "none" string
                    Default Value:
                    • "none"
                    Source:

                    styleDefaults.promotedLink.style :string|object

                    The default promoted link style attribute can be string or object. The promoted style string represents Link style type with following values: solid, dash, dot(default), dashDot. The promoted style string representation has been deprecated. Consider specifying stroke-dasharray in the promoted style object. The promoted style object represents the CSS style of the link. User defined custom CSS Styles will be applied directly on the link.
                    Default Value:
                    • null
                    Deprecated:
                    • This attribute is deprecated, use the svgStyle attribute instead.
                      Source:

                      styleDefaults.promotedLink.svgStyle :object

                      The promoted style object represents the CSS style of the link. User defined custom CSS Styles will be applied directly on the link.
                      Default Value:
                      • null
                      Source:

                      styleDefaults.promotedLink.width :number

                      Default link width in pixels.
                      Default Value:
                      • 1.0
                      Source:

                      tooltip :object

                      An object containing an optional callback function for tooltip customization.
                      Default Value:
                      • null
                      Source:

                      tooltip.renderer :function(object)

                      A function that returns a custom tooltip. The function takes a dataContext argument, provided by the diagram, with the following properties:
                      • parentElement: The tooltip element. The function can directly modify or append content to this element.
                      • id: The id of the hovered diagram object
                      • type : The type of the hovered diagram object - "link", "promotedLink" or "node"
                      • label: The label of the hovered diagram object.
                      • component: ojDiagram widget constructor
                      • data : relevant data for the object
                        • data object for the node, if the object type is 'node'
                        • data object for the link, if the object type is 'link'
                        • an array of data objects that correspond to links represented by the promoted link
                        The function may return an HTML element, which will be appended to the tooltip, or a tooltip string.
                      Default Value:
                      • null
                      Source:

                      touchResponse :string

                      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 component will instantly trigger the touch gesture and consume the page pan events if the component does not require an internal feature that requires a touch start gesture like panning or zooming. If touchResponse is auto, the component will behave like touchStart if it determines that it is not rendered within scrolling content and if component panning is not available for those components that support the feature.
                      Supported Values:
                      Name Type
                      "touchStart" string
                      "auto" string
                      Default Value:
                      • "auto"
                      Source:

                      trackResize :string

                      Defines whether the component will automatically render in response to changes in size. If set to off, then the application is responsible for calling refresh to render the component at the new size.
                      Supported Values:
                      Name Type
                      "on" string
                      "off" string
                      Default Value:
                      • "on"
                      Inherited From:
                      Source:

                      translations :Object

                      A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

                      If this component has (or inherits) translations, their documentation immediately follows this doc entry.

                      Default Value:
                      • an object containing all resources relevant to the component and all its superclasses, or null if none
                      Inherited From:
                      Source:
                      Examples

                      Initialize the component, overriding some translated resources. This syntax leaves the other translations intact at create time, but not if called after create time:

                      // Foo is InputDate, InputNumber, etc.
                      $( ".selector" ).ojFoo({ "translations": { someKey: "someValue",
                                                                 someOtherKey: "someOtherValue" } });

                      Get or set the translations option, after initialization:

                      // Get one.  (Foo is InputDate, InputNumber, etc.)
                      var value = $( ".selector" ).ojFoo( "option", "translations.someResourceKey" );
                      
                      // Get all.  (Foo is InputDate, InputNumber, etc.)
                      var values = $( ".selector" ).ojFoo( "option", "translations" );
                      
                      // Set one, leaving the others intact.  (Foo is InputDate, InputNumber, etc.)
                      $( ".selector" ).ojFoo( "option", "translations.someResourceKey", "someValue" );
                      
                      // Set many.  Any existing resource keys not listed are lost.  (Foo is InputDate, InputNumber, etc.)
                      $( ".selector" ).ojFoo( "option", "translations", { someKey: "someValue",
                                                                          someOtherKey: "someOtherValue" } );

                      translations.componentName :string

                      Used to describe the data visualization type for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Diagram"
                      Source:

                      translations.labelAndValue :string

                      Used to display a label and its value.

                      See the translations option for usage examples.

                      Default Value:
                      • "{0}: {1}"
                      Inherited From:
                      Source:

                      translations.labelClearSelection :string

                      Text shown for clearing multiple selection on touch devices.

                      See the translations option for usage examples.

                      Default Value:
                      • "Clear Selection"
                      Inherited From:
                      Source:

                      translations.labelCountWithTotal :string

                      Used to display a count out of a total.

                      See the translations option for usage examples.

                      Default Value:
                      • "{0} of {1}"
                      Inherited From:
                      Source:

                      translations.labelDataVisualization :string

                      Label for data visualizations used for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Data Visualization"
                      Inherited From:
                      Source:

                      translations.labelInvalidData :string

                      Text shown when the component receives invalid data.

                      See the translations option for usage examples.

                      Default Value:
                      • "Invalid data"
                      Inherited From:
                      Source:

                      translations.labelNoData :string

                      Text shown when the component receives no data.

                      See the translations option for usage examples.

                      Default Value:
                      • "No data to display"
                      Inherited From:
                      Source:

                      Used for the promoted link tooltip - promoted link consists a single link.

                      See the translations option for usage examples.

                      Default Value:
                      • "{0} link"
                      Source:

                      translations.promotedLinkAriaDesc :string

                      Used to describe promoted link type for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Indirect"
                      Source:

                      Used for the promoted link tooltip - promoted link consists multiple links.

                      See the translations option for usage examples.

                      Default Value:
                      • "{0} links"
                      Source:

                      translations.stateCollapsed :string

                      Used to describe the collapsed state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Collapsed"
                      Inherited From:
                      Source:

                      translations.stateDrillable :string

                      Used to describe a drillable object for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Drillable"
                      Inherited From:
                      Source:

                      translations.stateExpanded :string

                      Used to describe the expanded state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Expanded"
                      Inherited From:
                      Source:

                      translations.stateHidden :string

                      Used to describe the hidden state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Hidden"
                      Inherited From:
                      Source:

                      translations.stateIsolated :string

                      Used to describe the isolated state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Isolated"
                      Inherited From:
                      Source:

                      translations.stateMaximized :string

                      Used to describe the maximized state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Maximized"
                      Inherited From:
                      Source:

                      translations.stateMinimized :string

                      Used to describe the minimized state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Minimized"
                      Inherited From:
                      Source:

                      translations.stateSelected :string

                      Used to describe the selected state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Selected"
                      Inherited From:
                      Source:

                      translations.stateUnselected :string

                      Used to describe the unselected state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Unselected"
                      Inherited From:
                      Source:

                      translations.stateVisible :string

                      Used to describe the visible state for accessibility.

                      See the translations option for usage examples.

                      Default Value:
                      • "Visible"
                      Inherited From:
                      Source:

                      zoomRenderer :function(object)

                      An optional callback function to update the node in response to changes in zoom level. The function takes a single argument, provided by the component, with the following properties:
                      • component: A reference to the Diagram widget constructor.
                      • data: The data object for the node.
                      • parentElement: A parent group element that takes a custom SVG fragment as the node content. Modifications of the parentElement are not supported.
                      • rootElement: An SVG fragment created as a node content.
                      • state: An object that reflects the current state of the diagram node. The object has the following properties
                        • hovered: hovered state, boolean.
                        • selected: selected state, boolean.
                        • focused: focused state, boolean.
                        • zoom: zoom state, number.
                      • previousState: An object that reflects the previous state of the diagram node. The object has the following properties
                        • hovered: hovered state, boolean.
                        • selected: selected state, boolean.
                        • focused: focused state, boolean.
                        • zoom: zoom state, number.
                      • id: Node id.
                      • type: Object type = node.
                      • label: Node label.
                      The function should return one of the following:
                      • an object - DOM element of the created or modified content (an SVG fragment as Diagram Node content).
                      • nothing : Indicates that the node content should be removed.
                      Default Value:
                      • null
                      Source:

                      zooming :string

                      Specifies whether component zooming is allowed.
                      Supported Values:
                      Name Type
                      "auto" string
                      "none" string
                      Default Value:
                      • "none"
                      Source:

                      Binding Attributes

                      Binding attributes are similar to component options, but are exposed only via the ojComponent binding.

                      template :string|null

                      The knockout template used for stamping an SVG fragment or other data visualization as a diagram node. Only a single SVG element or DVT is supported when using knockout templates at this time. This attribute is only exposed via the ojComponent binding, and is not a component option.
                      Default Value:
                      • null
                      Source:

                      tooltip.template :string|null

                      The knockout template used to render the content of the tooltip. This attribute is only exposed via the ojComponent binding, and is not a component option. The following variables are also passed into the template:
                      • parentElement: The tooltip element. The function can directly modify or append content to this element.
                      • id: The id of the hovered diagram object
                      • type : The type of the hovered diagram object - "link" or "node"
                      • label: The label of the hovered diagram object.
                      Default Value:
                      • null
                      Source:

                      Context Objects

                      Each context object contains, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component. It can have additional properties to further specify the desired node. See getContextByNode for more details.

                      Properties:
                      Name Type Description
                      subId string Sub-id string to identify a particular dom node.

                      Following are the valid subIds:

                      Context for diagram link at a specified index.

                      Properties:
                      Name Type
                      index number
                      Source:

                      oj-diagram-node

                      Context for diagram node at a specified index.

                      Properties:
                      Name Type
                      index number
                      Source:

                      Sub-ID's

                      Each subId locator object contains, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component. It can have additional properties to further specify the desired node. See getNodeBySubId and getSubIdByNode methods for more details.

                      Properties:
                      Name Type Description
                      subId string Sub-id string to identify a particular dom node.

                      Following are the valid subIds:

                      Sub-ID for diagram link at a specified index.

                      Properties:
                      Name Type
                      index number
                      Source:
                      Example

                      Get the first diagram link:

                      var nodes = $( ".selector" ).ojDiagram( "getNodeBySubId", {'subId': 'oj-diagram-link', 'index': 0} );

                      oj-diagram-node

                      Sub-ID for diagram node at a specified index.

                      Properties:
                      Name Type
                      index number
                      Source:
                      Example

                      Get the first diagram node:

                      var nodes = $( ".selector" ).ojDiagram( "getNodeBySubId", {'subId': 'oj-diagram-node', 'index': 0} );

                      oj-diagram-tooltip

                      Sub-ID for the the diagram tooltip.

                      Source:
                      Example

                      Get the tooltip object of the diagram, if displayed:

                      var nodes = $( ".selector" ).ojDiagram( "getNodeBySubId", {'subId': 'oj-diagram-tooltip'} );

                      Events

                      beforeCollapse

                      Triggered immediately before any container node in the diagram is collapsed.
                      Properties:
                      Name Type Description
                      data Object event payload
                      Properties
                      Name Type Description
                      nodeId string the id of the collapsing object
                      Source:
                      Examples

                      Initialize the component with the beforeCollapse callback:

                      $(".selector").ojDiagram({
                        'beforeCollapse': function (event, data) {}
                      });

                      Bind an event listener to the ojbeforeCollapse event:

                      $(".selector").on({
                        'ojbeforeCollapse': function (event, data) {};
                      });

                      beforeExpand

                      Triggered immediately before any container node in the diagram is expanded.
                      Properties:
                      Name Type Description
                      data Object event payload
                      Properties
                      Name Type Description
                      nodeId string the id of the expanding object
                      Source:
                      Examples

                      Initialize the component with the beforeExpand callback:

                      $(".selector").ojDiagram({
                        'beforeExpand': function (event, data) {}
                      });

                      Bind an event listener to the ojbeforeExpand event:

                      $(".selector").on({
                        'ojbeforeExpand': function (event, data) {};
                      });

                      collapse

                      Triggered when a node has been collapsed.
                      Properties:
                      Name Type Description
                      data Object event payload
                      Properties
                      Name Type Description
                      nodeId string the id of the collapsed object
                      Source:
                      Examples

                      Initialize the component with the collapse callback:

                      $(".selector").ojDiagram({
                        'collapse': function (event, data) {}
                      });

                      Bind an event listener to the ojcollapse event:

                      $(".selector").on({
                        'ojcollapse': function (event, data) {};
                      });

                      destroy

                      Triggered before the component is destroyed. This event cannot be canceled; the component will always be destroyed regardless.

                      Inherited From:
                      Source:
                      Examples

                      Initialize component with the destroy callback

                      // Foo is Button, InputText, etc.
                      $(".selector").ojFoo({
                        'destroy': function (event, data) {}
                      });

                      Bind an event listener to the destroy event

                      $(".selector").on({
                        'ojdestroy': function (event, data) {
                            // verify that the component firing the event is a component of interest
                            if ($(event.target).is(".mySelector")) {
                                window.console.log("The DOM node id for the destroyed component is : %s", event.target.id);
                            }
                        };
                      });

                      expand

                      Triggered when a node has been expanded. The ui object contains one property, "nodeId", which is the id of the node that has been expanded.
                      Properties:
                      Name Type Description
                      data Object event payload
                      Properties
                      Name Type Description
                      nodeId string the id of the expanded object
                      Source:
                      Examples

                      Initialize the component with the expand callback:

                      $(".selector").ojDiagram({
                        'expand': function (event, data) {}
                      });

                      Bind an event listener to the ojexpand event:

                      $(".selector").on({
                        'ojexpand': function (event, data) {};
                      });

                      optionChange

                      Fired whenever a supported component option changes, whether due to user interaction or programmatic intervention. If the new value is the same as the previous value, no event will be fired. The event listener will receive two parameters described below:
                      Properties:
                      Name Type Description
                      event Event jQuery event object
                      ui Object event payload
                      Properties
                      Name Type Argument Description
                      option string the name of the option that changed.
                      previousValue Object an Object holding the previous value of the option. When previousValue is not a primitive type, i.e., is an Object, it may hold the same value as the value property.
                      value Object an Object holding the current value of the option.
                      subproperty Object <nullable>
                      an Object holding information about the subproperty that changed.
                      Properties
                      Name Type Description
                      path string the subproperty path that changed.
                      previousValue Object an Object holding the previous value of the subproperty.
                      value Object an Object holding the current value of the subproperty.
                      optionMetadata Object information about the option that changed
                      Properties
                      Name Type Description
                      writeback string "shouldWrite" or "shouldNotWrite". For use by the JET writeback mechanism; 'shouldWrite' indicates that the value should be written to the observable.
                      Inherited From:
                      Source:
                      Examples

                      Initialize component with the optionChange callback

                      // Foo is Button, InputText, etc.
                      $(".selector").ojFoo({
                        'optionChange': function (event, ui) {}
                      });

                      Bind an event listener to the ojoptionchange event

                      $(".selector").on({
                        'ojoptionchange': function (event, ui) {
                            // verify that the component firing the event is a component of interest
                            if ($(event.target).is(".mySelector")) {
                                window.console.log("option that changed is: " + ui['option']);
                            }
                        };
                      });

                      Methods

                      collapse(nodeId, vetoable)

                      Collapses an expanded node. When vetoable is set to false, beforeExpand event will still be fired but the event cannot be veto.
                      Parameters:
                      Name Type Description
                      nodeId String The id of the node to collapse
                      vetoable boolean Whether the event should be vetoable
                      Source:
                      Returns:
                      When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.

                      expand(nodeId, vetoable)

                      Expands a collapsed parent node. When vetoable is set to false, beforeExpand event will still be fired but the event cannot be veto.
                      Parameters:
                      Name Type Description
                      nodeId String The id of the node to expand
                      vetoable boolean Whether the event should be vetoable
                      Source:
                      Returns:
                      When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.

                      getContextByNode(node) → {Object|null}

                      Returns an object with context for the given child DOM node. This will always contain the subid for the node, defined as the 'subId' property on the context object. Additional component specific information may also be included. For more details on returned objects, see context objects.
                      Parameters:
                      Name Type Description
                      node Element The child DOM node
                      Source:
                      Returns:
                      The context for the DOM node, or null when none is found.
                      Type
                      Object | null
                      Example
                       // Foo is ojInputNumber, ojInputDate, etc.
                      // Returns {'subId': oj-foo-subid, 'property1': componentSpecificProperty, ...}
                      var context = $( ".selector" ).ojFoo( "getContextByNode", nodeInsideComponent );
                      Returns an object with the following properties for automation testing verification of the diagram link at the specified index.
                      Parameters:
                      Name Type Description
                      linkIndex number Link index
                      Properties:
                      Name Type Description
                      color string Link color
                      label string Link label
                      endConnectorType string The type of end connector on the link
                      endNode string The id of the end node.
                      selected boolean The selected state of the link
                      startConnectorType string The type of start connector on the link
                      startNode string The id of the start node.
                      style string Link style
                      tooltip string Link tooltip
                      width number Link width
                      Source:
                      Returns:
                      An object containing properties for the link at the given index, or null if none exists.
                      Type
                      Object | null

                      getLinkCount() → {Number}

                      Returns number of diagram links
                      Source:
                      Returns:
                      The number of links
                      Type
                      Number

                      getNode(nodeIndex) → {Object|null}

                      Returns an object with the following properties for automation testing verification of the diagram node at the specified index.
                      Parameters:
                      Name Type Description
                      nodeIndex String Node index
                      Properties:
                      Name Type Description
                      background string The background style for the node.
                      icon Object | null The icon for the node, or null if none exists.
                      Properties
                      Name Type Description
                      color string The color of the icon
                      shape string The shape of the icon
                      label string Node label
                      selected boolean The selected state of the node
                      tooltip string Node tooltip
                      Source:
                      Returns:
                      An object containing properties for the node at the given index, or null if none exists.
                      Type
                      Object | null

                      getNodeBySubId(locator) → {Element|null}

                      Returns the component DOM node indicated by the locator parameter.

                      If the locator or its subId is null, then this method returns the element on which this component was initialized.

                      If a non-null subId is provided but no corresponding node can be located, then this method returns null.

                      This method is intended for use in test automation only, and should not be used in a production environment.

                      Parameters:
                      Name Type Description
                      locator Object An Object containing, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component.

                      If this component has (or inherits) any subIds, then they are documented in the Sub-ID's section of this document.

                      Some components may support additional fields of the locator Object, to further specify the desired node.

                      Inherited From:
                      Source:
                      Returns:
                      The DOM node located by the locator, or null if none is found.
                      Type
                      Element | null
                      Example

                      Get the node for a certain subId:

                      // Foo is ojInputNumber, ojInputDate, etc.
                      var node = $( ".selector" ).ojFoo( "getNodeBySubId", {'subId': 'oj-some-sub-id'} );

                      getNodeCount() → {Number}

                      Returns number of diagram nodes
                      Source:
                      Returns:
                      The number of nodes
                      Type
                      Number
                      Returns an object with the following properties for automation testing verification of the promoted link between specified nodes.
                      Parameters:
                      Name Type Description
                      startNodeIndex number Start node index
                      endNodeIndex number End node index
                      Properties:
                      Name Type Description
                      color string Link color
                      endConnectorType string The type of end connector on the link
                      endNode string The id of the end node.
                      selected boolean The selected state of the link
                      startConnectorType string The type of start connector on the link
                      startNode string The id of the start node.
                      style string Link style
                      tooltip string Link tooltip
                      width number Link width
                      count number Number of links it represents
                      Source:
                      Returns:
                      An object containing properties for the link at the given index, or null if none exists.
                      Type
                      Object | null

                      getSubIdByNode(node) → {Object|null}

                      Returns the subId string for the given DOM node in this component. For details, see getNodeBySubId and the Sub-ID's section of this document.

                      This method is intended for use in test automation only, and should not be used in a production environment.

                      Parameters:
                      Name Type Description
                      node Element DOM node in this component
                      Inherited From:
                      Source:
                      Returns:
                      The subId for the DOM node, or null if none is found.
                      Type
                      Object | null
                      Example

                      Get the subId for a certain DOM node:

                      // Foo is ojInputNumber, ojInputDate, etc.
                      var locator = $( ".selector" ).ojFoo( "getSubIdByNode", nodeInsideComponent );

                      option(optionName, value) → {Object|undefined}

                      This method has several overloads, which get and set component options and their fields. The functionality is unchanged from that provided by JQUI. See the examples for details on each overload.

                      Parameters:
                      Name Type Argument Description
                      optionName string | Object <optional>
                      the option name (string, first two overloads), or the map (Object, last overload). Omitted in the third overload.
                      value Object <optional>
                      a value to set for the option. Second overload only.
                      Inherited From:
                      Source:
                      Returns:
                      The getter overloads return the retrieved value(s). When called via the public jQuery syntax, the setter overloads return the object on which they were called, to facilitate method chaining.
                      Type
                      Object | undefined
                      Examples

                      First overload: get one option:

                      This overload accepts a (possibly dot-separated) optionName param as a string, and returns the current value of that option.

                      var isDisabled = $( ".selector" ).ojFoo( "option", "disabled" ); // Foo is Button, Menu, etc.
                      
                      // For object-valued options, dot notation can be used to get the value of a field or nested field.
                      var startIcon = $( ".selector" ).ojButton( "option", "icons.start" ); // icons is object with "start" field

                      Second overload: set one option:

                      This overload accepts two params: a (possibly dot-separated) optionName string, and a new value to which that option will be set.

                      $( ".selector" ).ojFoo( "option", "disabled", true ); // Foo is Button, Menu, etc.
                      
                      // For object-valued options, dot notation can be used to set the value
                      // of a field or nested field, without altering the rest of the object.
                      $( ".selector" ).ojButton( "option", "icons.start", myStartIcon ); // icons is object with "start" field

                      Third overload: get all options:

                      This overload accepts no params, and returns a map of key/value pairs representing all the component options and their values.

                      var options = $( ".selector" ).ojFoo( "option" ); // Foo is Button, Menu, etc.

                      Fourth overload: set one or more options:

                      This overload accepts a single map of option-value pairs to set on the component. Unlike the first two overloads, dot notation cannot be used.

                      $( ".selector" ).ojFoo( "option", { disabled: true, bar: 42 } ); // Foo is Button, Menu, etc.

                      refresh()

                      Refreshes the component.

                      Inherited From:
                      Source:
                      Returns:
                      When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.

                      renderDefaultFocus(context)

                      Renders default focus effect for the diagram node
                      Parameters:
                      Name Type Description
                      context Object property object with the following fields
                      • {Function} component - ojDiagram widget constructor
                      • {Object} data - a data object for the node
                      • {SVGElement} parentElement - a parent group element that takes a custom SVG fragment as the node content. Used for measurements and reading properties. Modifications of the parentElement are not supported
                      • {SVGElement} rootElement - an SVG fragment created as a node content passed for subsequent modifications
                      • {Object} state - property object with the following boolean properties: hovered, selected, focused, zoom
                      • {Object} previousState - property object with the following boolean properties: hovered, selected, focused, zoom
                      • {string} id - node id
                      • {string} type - object type - node
                      • {string} label - object label
                      Source:
                      Returns:
                      When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.

                      renderDefaultHover(context)

                      Renders default hover effect for the diagram node
                      Parameters:
                      Name Type Description
                      context Object property object with the following fields
                      • {Function} component - ojDiagram widget constructor
                      • {Object} data - a data object for the node
                      • {SVGElement} parentElement - a parent group element that takes a custom SVG fragment as the node content. Used for measurements and reading properties. Modifications of the parentElement are not supported
                      • {SVGElement} rootElement - an SVG fragment created as a node content passed for subsequent modifications
                      • {Object} state - property object with the following boolean properties: hovered, selected, focused, zoom
                      • {Object} previousState - property object with the following boolean properties: hovered, selected, focused, zoom
                      • {string} id - node id
                      • {string} type - object type - node
                      • {string} label - object label
                      Source:
                      Returns:
                      When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.

                      renderDefaultSelection(context)

                      Renders default selection effect for the diagram node
                      Parameters:
                      Name Type Description
                      context Object property object with the following fields
                      • {Function} component - ojDiagram widget constructor
                      • {Object} data - a data object for the node
                      • {SVGElement} parentElement - a parent group element that takes a custom SVG fragment as the node content. Used for measurements and reading properties. Modifications of the parentElement are not supported
                      • {SVGElement} rootElement - an SVG fragment created as a node content passed for subsequent modifications
                      • {Object} state - property object with the following boolean properties: hovered, selected, focused, zoom
                      • {Object} previousState - property object with the following boolean properties: hovered, selected, focused, zoom
                      • {string} id - node id
                      • {string} type - object type - node
                      • {string} label - object label
                      Source:
                      Returns:
                      When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.

                      whenReady() → {Promise}

                      Returns a promise that is resolved when the component is finished rendering. This can be used to determine when it is okay to call automation and other APIs on the component.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Promise

                      Non-public Methods

                      Note: Extending JET components is not currently supported. Thus, non-public methods are for internal use only.

                      <protected> _AddActiveable(options)

                      Add touch and mouse listeners to toggle oj-active class
                      Parameters:
                      Name Type Description
                      options !Object | !jQuery This parameter can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
                      Properties
                      Name Type Argument Description
                      element jQuery The element(s) to receive the oj-active class on active Required if afterToggle is specified.
                      afterToggle function(string) <nullable>
                      Optional callback function called each time the active classes have been toggled, after the toggle. The event.type string is passed and indicates whether the classes were added or removed. The active classes are added on "touchstart" or "mousedown" or "mouseenter" and the active classes are removed on "touchend" or "touchcancel" or "mouseup" or "mouseleave". Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-active are applied," can enforce those rules in this callback.
                      Inherited From:
                      Source:
                      See:

                      <protected> _AddHoverable(options)

                      Add mouse listners to toggle oj-hover class
                      Parameters:
                      Name Type Description
                      options !Object | !jQuery This param can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
                      Properties
                      Name Type Argument Description
                      element jQuery The element(s) to receive the oj-hover class on hover Required if afterToggle is specified.
                      afterToggle function(string) <nullable>
                      Optional callback function called each time the hover classes have been toggled, after the toggle. The string "mouseenter" or "mouseleave" is passed, indicating whether the classes were added or removed. Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-hover are applied," can enforce those rules in this callback.
                      Inherited From:
                      Source:
                      See:

                      <protected> _AfterCreate()

                      This method is called after _ComponentCreate, but before the create event is fired. The JET base component does tasks here that must happen after the component (subclass) has created itself in its override of _ComponentCreate. Notably, the base component handles the rootAttributes and contextMenu options here, since those options operate on the component root node, which for some components is created in their override of _ComponentCreate.

                      Subclasses should override this method only if they have tasks that must happen after a superclass's implementation of this method, e.g. tasks that must happen after the context menu is set on the component.

                      Overrides of this method should call this._super first.

                      Inherited From:
                      Source:

                      <protected> _AfterCreateEvent()

                      This method is called after the create event is fired. Components usually should not override this method, as it is rarely correct to wait until after the create event to perform a create-time task.

                      An example of a correct usage of this method is Dialog's auto-open behavior, which needs to happen after the create event.

                      Only behaviors (like Dialog auto-open behavior) should occur in this method. Component initialization must occur earlier, before the create event is fired, so that create listeners see a fully inited component.

                      Overrides of this method should call this._super first.

                      Do not confuse this method with the _AfterCreate method, which is more commonly used.

                      Inherited From:
                      Source:

                      <protected> _CompareOptionValues(option, value1, value2) → {boolean}

                      Compares 2 option values for equality and returns true if they are equal; false otherwise.

                      Parameters:
                      Name Type Description
                      option String the name of the option
                      value1 Object first value
                      value2 Object another value
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      boolean

                      <protected> _ComponentCreate()

                      All component create-time initialization lives in this method, except the logic that specifically needs to live in _InitOptions, _AfterCreate, or _AfterCreateEvent, per the documentation for those methods. All DOM creation must happen here, since the intent of _AfterCreate, which is called next, is to contain superclass logic that must run after that DOM is created.

                      Overrides of this method should call this._super first.

                      Summary of create-time methods that components can override, in the order that they are called:

                      1. _InitOptions
                      2. _ComponentCreate (this method)
                      3. _AfterCreate
                      4. (The create event is fired here.)
                      5. _AfterCreateEvent

                      For all of these methods, the contract is that overrides must call this._super first, so e.g., the _ComponentCreate entry means baseComponent._ComponentCreate, then _ComponentCreate in any intermediate subclasses, then _ComponentCreate in the leaf subclass.

                      Inherited From:
                      Source:

                      <protected> _ConvertLocatorToSubId(locator) → {string|null}

                      Converts the specified locator object into a subId string.
                      Parameters:
                      Name Type Description
                      locator Object
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      string | null

                      <protected> _ConvertSubIdToLocator(subId) → {Object|null}

                      Converts the specified subId string into a locator object.
                      Parameters:
                      Name Type Description
                      subId string
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Object | null

                      <protected> _create()

                      This method is final in JET. Components should instead override one or more of the overridable create-time methods listed in _ComponentCreate.

                      Inherited From:
                      Source:

                      <protected> _CreateDvtComponent(context, callback, callbackObj)

                      Called by _create to instantiate the specific DVT component instance. Subclasses must override.
                      Parameters:
                      Name Type Description
                      context dvt.Context
                      callback Function
                      callbackObj Object
                      Inherited From:
                      Source:

                      <protected> _FixRendererContext(context) → {Object}

                      Prepares a custom renderer context object for either the JQuery or custom element syntax, removing and exposing keys as needed.
                      Parameters:
                      Name Type Description
                      context Object The renderer context object.
                      Inherited From:
                      Source:
                      Returns:
                      The cleaned up renderer context.
                      Type
                      Object

                      <protected> _focusable(options)

                      Sets JET's "focus" CSS classes when the element is focused and removes them when focus is lost.

                      The oj-focus class is set on all focuses.

                      Some components additionally have an oj-focus-highlight class, which applies a focus indicator that is appropriate on a subset of the occasions that oj-focus is appropriate. Those components should pass true for the applyHighlight param, in which case the oj-focus-highlight class is set if appropriate given the current focus highlight policy.

                      Focus highlight policy

                      The focus highlight policy supports the 3 values listed below. By default, it is retrieved from the $focusHighlightPolicy SASS variable, shared by many components and patterns. Components with different needs, including those exposing a component-specific SASS variable or other API for this, should see the getFocusHighlightPolicy parameter below. Valid focus highlight policies:

                      Policy Description
                      "nonPointer" Indicates that the component should apply the oj-focus-highlight class only for focuses not resulting from pointer (touch or mouse) interaction. (In the built-in themes, the SASS variable defaults to this value.)
                      "all" Indicates that the component should apply the class for all focuses.
                      "none" Indicates that the component should never apply the class, because the application has taken responsibility for applying the class when needed for accessibility.
                      Toggling the classes

                      Components that toggle these focus classes outside of this API must maintain the invariant that oj-focus-highlight is applied to a given element in a (not necessarily strict) subset of cases that oj-focus is applied to that element.

                      Typically the specified element should be within the component subtree, in which case the classes will automatically be removed from the element when the component is destroyed, when its disabled option is set to true, and when _NotifyDetached() is called.

                      As a minor exception, for components that wrap themselves in a new root node at create time, if the specified element is within the root node's subtree but not within the init node's subtree, then at destroy time only, the classes will not be removed, since destroy() is expected to remove such nodes.

                      If the element is NOT in the component subtree, then the caller is responsible for removing the classes at the times listed above.

                      Listeners

                      If setupHandlers is not passed, or if setupHandlers is passed and uses _on to register its listeners as seen in the example, then the listeners are not invoked when the component is disabled, and the listeners are automatically cleaned up when the component is destroyed. Otherwise, the caller is responsible for ensuring that the disabled state is handled correctly, and removing the listeners at destroy time.

                      Related API's

                      Non-component internal callers should see oj.DomUtils.makeFocusable(). Per its JSDoc (unpublished; see the source), it has a couple of additional usage considerations.

                      Parameters:
                      Name Type Description
                      options !Object | !jQuery This param can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
                      Properties
                      Name Type Argument Description
                      element jQuery The element(s) to receive the oj-focus classes on focus. Required if setupHandlers not passed; ignored otherwise.
                      applyHighlight boolean true if the oj-focus-highlight class should be applied when appropriate. false or omitted if that class should never be applied.
                      afterToggle function(string) <nullable>
                      Optional callback function called each time the focus classes have been toggled, after the toggle. The string "focusin" or "focusout" is passed, indicating whether the classes were added or removed. Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-focus are applied," can enforce those rules in this callback.
                      getFocusHighlightPolicy function() <nullable>
                      Optional if applyHighlight is true; ignored otherwise. Components with a component-specific focus policy mechanism should pass a function that always returns one of the three valid values listed above, keeping in mind that this method can be called on every focus. See the example.
                      recentPointer function() <nullable>
                      Relevant iff applyHighlight is true and the focus highlight policy is "nonPointer"; ignored otherwise. Recent pointer activity is considered to have occurred if (a) a mouse button or finger has recently been down or up, or (b) this optional callback function returns true. Components wishing to additionally take into account (say) recent pointer movements can supply a function returning true if those movements have been detected, keeping in mind that this method can be called on every focus. See the example.
                      setupHandlers function(function(!jQuery),function(!jQuery)) <nullable>
                      Can be omitted by components whose focus classes need to be added and removed on focusin and focusout, respectively. Components needing to add/remove those classes in response to other events should specify this parameter, which is called once, immediately. See the examples.
                      Inherited From:
                      Source:
                      Examples

                      Opt into the highlight behavior, and specify a function to be called every time the classes are toggled:

                      var self = this;
                      this._focusable({
                          'element': this.element, 
                          'applyHighlight': true, 
                          'afterToggle' : function() {
                              self._toggleDefaultClasses();
                          }
                      });

                      Arrange for mouse movement to be considered in addition to mouse/finger up/down. Also supply a component-specific focusHighlightPolicy:

                      var self = this;
                      this._focusable({
                          'element': someElement, 
                          'applyHighlight': true, 
                          'recentPointer' : function() {
                              // A timestamp-based approach avoids the risk of getting stuck in an inaccessible 
                              // state if (say) mouseenter is not followed by mouseleave for some reason.
                              var millisSincePointerMove = Date.now() - _myPointerMoveTimestamp;
                              var isRecent = millisSincePointerMove < myThreshold;
                              return isRecent;
                          },
                          'getFocusHighlightPolicy' : function() {
                              // Return the value of a component-specific SASS $variable, component option, or other 
                              // component-specific mechanism, either "all", "none", or "nonPointer".  SASS variables
                              // should be pulled into JS once statically on load, not per-instance or per-focus.
                          }
                      });

                      Add/remove the focus classes in response to events other than focusin/focusout:

                      var self = this;
                      this._focusable({
                          'applyHighlight': myBooleanValue, 
                          'setupHandlers': function( focusInHandler, focusOutHandler) {
                              self._on( self.element, {
                                  // This example uses focus/blur listeners, which don't bubble, rather than the 
                                  // default focusin/focusout (which bubble).  This is useful when one focusable  
                                  // element is a descendant of another.
                                  focus: function( event ) {
                                      focusInHandler($( event.currentTarget ));
                                  },
                                  blur: function( event ) {
                                      focusOutHandler($( event.currentTarget ));
                                  }
                              });
                          }
                      });

                      Alternate usage of setupHandlers, which simply stashes the handlers so they can be called from the component's existing handlers:

                      var self = this;
                      this._focusable({
                          'applyHighlight': myBooleanValue, 
                          'setupHandlers': function( focusInHandler, focusOutHandler) {
                              self._focusInHandler = focusInHandler;
                              self._focusOutHandler = focusOutHandler;
                          }
                      });

                      <protected> _GetChildStyleClasses() → {Object}

                      Returns a map of the style classes associated with a component's children.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Object

                      <protected> _GetComponentDeferredDataPaths() → {Object}

                      Returns an object containing the top level options key and subkeys for deferred data options. 'root' is used for top level keys. For example, {'areaLayers': ['areaDataLayer/areas', 'areaDataLayer/markers'] indicates that we should check this.options['areaLayers'][i]['areaDataLayer']['areas'] and this.options['areaLayers'][i]['areaDataLayer']['markers']. To indicate a top level option, use the options key 'root', i.e. {'root': ['items']}.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Object

                      <protected> _GetComponentNoClonePaths() → {Object}

                      Returns an object containing the no clone paths for a component. For example, {'areaLayers': {'areaDataLayer': {'areas': true, 'markers': true}}} indicates that we should check this.options['areaLayers'][i]['areaDataLayer']['areas'] and this.options['areaLayers'][i]['areaDataLayer']['markers']. The base implementation will handle the basic case where the deferred data path contains only top level data options.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Object

                      <protected> _GetComponentStyleClasses() → {Array}

                      Returns the style classes associated with the component.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Array

                      <protected> _getCreateOptions()

                      This method is not used in JET. Components should instead override _InitOptions.

                      Inherited From:
                      Source:

                      <protected> _GetDataContext(options) → {Object}

                      Returns the data context passed to data function callbacks.
                      Parameters:
                      Name Type Description
                      options Object The options to retrieve the data context for
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Object

                      <protected> _GetDvtComponent(element) → {Object}

                      Returns a DVT component associated with a DOMElement
                      Parameters:
                      Name Type Description
                      element Element The DOMElement to get the DVT component from.
                      Inherited From:
                      Source:
                      Returns:
                      The DVT component associated with the DOMElement or null
                      Type
                      Object

                      <protected> _GetEventForSyntax(event) → {Object}

                      Given an event, returns the appropriate event for the component syntax. For custom elements, if the event is a JQuery event, this method will return the unwrapped original event.
                      Parameters:
                      Name Type Description
                      event Object [description]
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Object

                      <protected> _GetEventTypes() → {Array}

                      Returns an array of supported event types. Used in conjunction with _setOptions to skip unnecessary rendering when event listeners are bound. Subclasses must override to return supported event types.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Array

                      <protected> _GetFirstBracketedString(subId) → {string}

                      Returns the first bracketed substring in the specified string.
                      Parameters:
                      Name Type Description
                      subId string
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      string

                      <protected> _GetFirstIndex(subId) → {number}

                      Converts a string containing a single index in the form '[index]' into the numerical index.
                      Parameters:
                      Name Type Description
                      subId string
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      number

                      <protected> _GetIndexPath(subId) → {Array}

                      Converts a string containing indices in the form '[index0][index1]...[indexN]' to an array of indices.
                      Parameters:
                      Name Type Description
                      subId string
                      Inherited From:
                      Source:
                      Returns:
                      The resulting array to be used for locator indexPath.
                      Type
                      Array

                      <protected> _GetReadingDirection() → {string}

                      Determines whether the component is LTR or RTL.

                      Component responsibilities:

                      • All components must determine directionality exclusively by calling this protected superclass method. (So that any future updates to the logic can be made in this one place.)
                      • Components that need to know the directionality must call this method at create-time and from refresh(), and cache the value.
                      • Components should not call this at other times, and should instead use the cached value. (This avoids constant DOM queries, and avoids any future issues with component reparenting (i.e. popups) if support for directional islands is added.)

                      App responsibilities:

                      • The app specifies directionality by setting the HTML "dir" attribute on the <html> node. When omitted, the default is "ltr". (Per-component directionality / directional islands are not currently supported due to inadequate CSS support.)
                      • As with any DOM change, the app must refresh() the component if the directionality changes dynamically. (This provides a hook for component housekeeping, and allows caching.)
                      Default Value:
                      • "ltr"
                      Inherited From:
                      Source:
                      Returns:
                      the reading direction, either "ltr" or "rtl"
                      Type
                      string

                      <protected> _GetSavedAttributes(element) → {Object|null}

                      Gets the saved attributes for the provided element.

                      If you don't override _SaveAttributes and _RestoreAttributes, then this will return null.

                      If you override _SaveAttributes to call _SaveAllAttributes, then this will return all the attributes. If you override _SaveAttributes/_RestoreAttributes to do your own thing, then you may also have to override _GetSavedAttributes to return whatever you saved if you need access to the saved attributes.

                      Parameters:
                      Name Type Description
                      element Object jQuery selection, should be a single entry
                      Inherited From:
                      Source:
                      Returns:
                      savedAttributes - attributes that were saved for this element in _SaveAttributes, or null if none were saved.
                      Type
                      Object | null

                      <protected> _GetStringFromIndexPath(indexPath) → {string}

                      Converts an indexPath array to a string of the form '[index0][index1]...[indexN]'.
                      Parameters:
                      Name Type Description
                      indexPath Array
                      Inherited From:
                      Source:
                      Returns:
                      The resulting string.
                      Type
                      string

                      <protected> _GetTranslationMap() → {Object}

                      Returns a map containing keys corresponding to the string ids in ojtranslations.js and values corresponding to the toolkit constants for the DvtBundle objects. This map must be guaranteed to be a new instance so that subclasses can add their translations to it.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      Object

                      <protected> _HandleEvent(event)

                      Called by the component to process events. Subclasses should override to delegate DVT component events to their JQuery listeners.
                      Parameters:
                      Name Type Description
                      event Object
                      Inherited From:
                      Source:

                      <protected> _init()

                      JET components should almost never implement this JQUI method. Please consult an architect if you believe you have an exception. Reasons:

                      • This method is called at create time, after the create event is fired. It is rare for that to be the appropriate time to perform a create-time task. For those rare cases, we have the _AfterCreateEvent method, which is preferred over this method since it is called only at that time, not also at re-init time (see next).
                      • This method is also called at "re-init" time, i.e. when the initializer is called after the component has already been created. JET has not yet identified any desired semantics for re-initing a component.
                      Inherited From:
                      Source:

                      <protected> _InitOptions(originalDefaults, constructorOptions)

                      This method is called before _ComponentCreate, at which point the component has not yet been rendered. Component options should be initialized in this method, so that their final values are in place when _ComponentCreate is called.

                      This includes getting option values from the DOM, where applicable, and coercing option values (however derived) to their appropriate data type if needed.

                      No work other than setting options should be done in this method. In particular, nothing should be set on the DOM until _ComponentCreate, e.g. setting the disabled DOM attribute from the disabled option.

                      A given option (like disabled) appears in the constructorOptions param iff the app set it in the constructor:

                      • If it appears in constructorOptions, it should win over what's in the DOM (e.g. disabled DOM attribute). If for some reason you need to tweak the value that the app set, then enable writeback when doing so: this.option('foo', bar, {'_context': {writeback: true, internalSet: true}}).
                      • If it doesn't appear in constructorOptions, then that option definitely is not bound, so writeback is not needed. So if you need to set the option (e.g. from a DOM attribute), use this.option('foo', bar, {'_context': {internalSet: true}}).

                      Overrides of this method should call this._super first.

                      Parameters:
                      Name Type Argument Description
                      originalDefaults Object original default options defined on the component and its ancestors
                      constructorOptions Object <nullable>
                      options passed into the widget constructor
                      Inherited From:
                      Source:

                      <protected> _IsCustomElement() → {boolean}

                      Determines whether the component is being rendered as a custom element.
                      Inherited From:
                      Source:
                      Returns:
                      True if the component is being rendered as a custom element
                      Type
                      boolean

                      <protected> _IsEffectivelyDisabled() → {boolean}

                      Determines whether this component is effectively disabled, i.e. it has its 'disabled' attribute set to true or it has been disabled by its ancestor component.

                      Inherited From:
                      Source:
                      Returns:
                      true if the component has been effectively disabled, false otherwise
                      Type
                      boolean

                      <protected> _IsFlowingLayoutSupported() → {boolean}

                      Returns whether flowing layout is supported for the component. If this returns true, the component will render at the preferred size of the component if the user doesn't specify the width and height in the div. If this returns false, the component will always render at the browser- computed width and height.
                      Inherited From:
                      Source:
                      Returns:
                      Type
                      boolean

                      <protected> _LoadResources()

                      Called once during component creation to load resources.
                      Inherited From:
                      Source:

                      <protected> _MakeReady()

                      Called by component to declare rendering is finished. This method currently handles the ready state for the component whenReady API, the page level BusyContext, and the static whenReady API for the custom element version of this component.
                      Inherited From:
                      Source:

                      <protected> _NotifyAttached()

                      Notifies the component that its subtree has been connected to the document programmatically after the component has been created.

                      Inherited From:
                      Source:

                      <protected> _NotifyContextMenuGesture(menu, event, eventType)

                      When the contextMenu option is set, this method is called when the user invokes the context menu via the default gestures: right-click, Press & Hold, and Shift-F10. Components should not call this method directly.

                      The default implementation simply calls this._OpenContextMenu(event, eventType). Overrides of this method should call that same method, perhaps with additional params, not menu.open().

                      This method may be overridden by components needing to do things like the following:

                      • Customize the launcher or position passed to _OpenContextMenu(). See that method for guidance on these customizations.
                      • Customize the menu contents. E.g. some components need to enable/disable built-in commands like Cut and Paste, based on state at launch time.
                      • Bail out in some cases. E.g. components with UX approval to use PressHoldRelease rather than Press & Hold can override this method to say if (eventType !== "touch") this._OpenContextMenu(event, eventType);. When those components detect the alternate context menu gesture (e.g. PressHoldRelease), that separate listener should call this._OpenContextMenu(), not this method (_NotifyContextMenuGesture()), and not menu.open().

                      Components needing to do per-launch setup like the above tasks should do so in an override of this method, not in a beforeOpen listener or an _OpenContextMenu() override. This is discussed more fully here.

                      Parameters:
                      Name Type Description
                      menu Object The JET Menu to open as a context menu. Always non-null.
                      event Event What triggered the menu launch. Always non-null.
                      eventType string "mouse", "touch", or "keyboard". Never null.
                      Inherited From:
                      Source:

                      <protected> _NotifyDetached()

                      Notifies the component that its subtree has been removed from the document programmatically after the component has been created.

                      Inherited From:
                      Source:

                      <protected> _NotifyDetached()

                      Notifies the component that its subtree has been removed from the document programmatically after the component has been created.

                      Inherited From:
                      Source:

                      <protected> _NotifyHidden()

                      Notifies the component that its subtree has been made hidden programmatically after the component has been created.

                      Inherited From:
                      Source:

                      <protected> _NotifyShown()

                      Notifies the component that its subtree has been made visible programmatically after the component has been created.

                      Inherited From:
                      Source:

                      <protected> _NotReady()

                      Called by component to declare rendering is not finished. This method currently handles the ready state for the component whenReady API, the page level BusyContext, and the static whenReady API for the custom element version of this component.
                      Inherited From:
                      Source:

                      <protected> _OpenContextMenu(event, eventType, openOptions, submenuOpenOptions, shallow)

                      The only correct way for a component to open its context menu is by calling this method, not by calling Menu.open() or _NotifyContextMenuGesture(). This method should be called in two cases:

                      • This method is called by _NotifyContextMenuGesture() and its overrides. That method is called when the baseComponent detects the default context menu gestures: right-click, Press & Hold, and Shift-F10.
                      • Components with UX-approved support for alternate context menu gestures like PressHoldRelease should call this method directly when those gestures are detected.

                      Components needing to customize how the context menu is launched, or do any per-launch setup, should do so in the caller of this method, (which is one of the two callers listed above), often by customizing the params passed to this method (_OpenContextMenu) per the guidance below. This setup should not be done in the following ways:

                      • Components should not perform setup in a beforeOpen listener, as this can cause a race condition where behavior depends on who got their listener registered first: the component or the app. The only correct component use of a beforeOpen listener is when there's a need to detect whether something else launched the menu.
                      • Components should not override this method (_OpenContextMenu), as this method is final. Instead, customize the params that are passed to it.

                      Guidance on setting OpenOptions fields:

                      Launcher:

                      Depending on individual component needs, any focusable element within the component can be the appropriate launcher for this launch.

                      Browser focus returns to the launcher on menu dismissal, so the launcher must at least be focusable. Typically a tabbable (not just focusable) element is safer, since it just focuses something the user could have focused on their own.

                      By default (i.e. if openOptions is not passed, or if it lacks a launcher field), the component init node is used as the launcher for this launch. If that is not focusable or is suboptimal for a given component, that component should pass something else. E.g. components with a "roving tabstop" (like Toolbar) should typically choose the current tabstop as their launcher.

                      The :focusable and :tabbable selectors may come in handy for choosing a launcher, e.g. something like this.widget().find(".my-class:tabbable").first().

                      Position:

                      By default, this method applies positioning that differs from Menu's default in the following ways: (The specific settings are subject to change.)

                      • For mouse and touch events, the menu is positioned relative to the event, not the launcher.
                      • For touch events, "my" is set to "start>40 center", to avoid having the context menu obscured by the user's finger.

                      Usually, if position needs to be customized at all, the only thing that needs changing is its "of" field, and only for keyboard launches (since mouse/touch launches should almost certainly keep the default "event" positioning). This situation arises anytime the element relative to which the menu should be positioned for keyboard launches is different than the launcher element (the element to which focus should be returned upon dismissal). For this case, { "position": {"of": eventType==="keyboard" ? someElement : "event"} } can be passed as the openOptions param.

                      Be careful not to clobber useful defaults by specifying too much. E.g. if you only want to customize "of", don't pass other fields like "my", since your value will be used for all modalities (mouse, touch, keyboard), replacing the modality-specific defaults that are usually correct. Likewise, don't forget the eventType==="keyboard" check if you only want to customize "of" for keyboard launches.

                      InitialFocus:

                      This method forces initialFocus to "menu" for this launch, so the caller needn't specify it.

                      Parameters:
                      Name Type Argument Description
                      event Event What triggered the context menu launch. Must be non-null.
                      eventType string "mouse", "touch", or "keyboard". Must be non-null. Passed explicitly since caller knows what it's listening for, and since events like contextmenu and click can be generated by various input modalities, making it potentially error-prone for this method to determine how they were generated.
                      openOptions Object <optional>
                      Options to merge with this method's defaults, which are discussed above. The result will be passed to Menu.open(). May be null or omitted. See also the shallow param.
                      submenuOpenOptions Object <optional>
                      Options to be passed through to Menu.open(). May be null or omitted.
                      shallow boolean <optional>
                      Whether to perform a deep or shallow merge of openOptions with this method's default value. The default and most commonly correct / useful value is false.
                      • If true, a shallow merge is performed, meaning that the caller's position object, if passed, will completely replace this method's default position object.
                      • If false or omitted, a deep merge is performed. For example, if the caller wishes to tweak position.of while keeping this method's defaults for position.my, position.at, etc., it can pass {"of": anOfValue} as the position value.

                      The shallow param is n/a for submenuOpenOptions, since this method doesn't apply any defaults to that. (It's a direct pass-through.)

                      Inherited From:
                      Source:

                      <protected> _ProcessStyles()

                      Create dummy divs for style classes and merge style class values with json . options object
                      Inherited From:
                      Source:

                      <protected> _ReleaseResources()

                      Release resources held by this component, for example, remove listeners. This is called during destroy. _SetupResources will set up resources needed by this component, and is called during _create.

                      This base class default implementation does nothing.

                      Component subclasses can opt in by overriding _SetupResources and _ReleaseResources.
                      Inherited From:
                      Source:

                      <protected> _RemoveActiveable(element)

                      Remove touch and mouse listeners that were registered in _AddActiveable
                      Parameters:
                      Name Type Description
                      element jQuery The same element passed to _AddActiveable
                      Inherited From:
                      Source:
                      See:

                      <protected> _RemoveHoverable(element)

                      Remove mouse listners that were registered in _AddHoverable
                      Parameters:
                      Name Type Description
                      element jQuery The same element passed to _AddHoverable
                      Inherited From:
                      Source:
                      See:

                      <protected> _Render(isResize)

                      Called to render the component at the current size.
                      Parameters:
                      Name Type Description
                      isResize boolean (optional) Whether it is a resize rerender.
                      Inherited From:
                      Source:

                      <protected> _RestoreAllAttributes()

                      Restores all the element's attributes which were saved in _SaveAllAttributes. This method is final in JET.

                      If a subclass wants to save/restore all attributes on create/destroy, then the subclass can override _SaveAttributes and call _SaveAllAttributes and also override _RestoreAttributes and call _RestoreAllAttributes.

                      Inherited From:
                      Source:

                      <protected> _RestoreAttributes()

                      Restore the attributes saved in _SaveAttributes.

                      _SaveAttributes is called during _create. And _RestoreAttributes is called during _destroy.

                      This base class default implementation does nothing.

                      We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_GetSavedAttributes/_RestoreAttributes.

                      Inherited From:
                      Source:

                      <protected> _SaveAllAttributes(element)

                      Saves all the element's attributes within an internal variable. _RestoreAllAttributes will restore the attributes from this internal variable.

                      This method is final in JET. Subclasses can override _RestoreAttributes and call _RestoreAllAttributes.

                      The JSON variable will be held as:

                      [
                        {
                        "element" : element[i],
                        "attributes" :
                          {
                            attributes[m]["name"] : {"attr": attributes[m]["value"]
                          }
                        }
                      ]
                      
                      Parameters:
                      Name Type Description
                      element Object jQuery selection to save attributes for
                      Inherited From:
                      Source:

                      <protected> _SaveAttributes(element)

                      Saves the element's attributes. This is called during _create. _RestoreAttributes will restore all these attributes and is called during _destroy.

                      This base class default implementation does nothing.

                      We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_RestoreAttributes.

                      Parameters:
                      Name Type Description
                      element Object jQuery selection to save attributes for
                      Inherited From:
                      Source:

                      <protected> _SetRootAttributes()

                      Reads the rootAttributes option, and sets the root attributes on the component's root DOM element. See rootAttributes for the set of supported attributes and how they are handled.

                      Inherited From:
                      Source:
                      Throws:
                      if unsupported attributes are supplied.

                      <protected> _SetupResources()

                      Sets up needed resources for this component, for example, add listeners. This is called during _create. _ReleaseResources will release resources help by this component, and is called during destroy.

                      This base class default implementation does nothing.

                      Component subclasses can opt in by overriding _SetupResources and _ReleaseResources.
                      Inherited From:
                      Source:

                      <protected> _UnregisterChildNode()

                      Remove all listener references that were attached to the element.
                      Inherited From:
                      Source:

                      <protected> _UserOptionChange(key, value, optionMetadata)

                      Sets an option change that was driven by user gesture. Used in conjunction with _setOption to ensure that the correct optionMetadata flag for writeback is set.
                      Parameters:
                      Name Type Description
                      key string The name of the option to set.
                      value Object The value to set for the option.
                      optionMetadata Object The optionMetadata for the optionChange event
                      Inherited From:
                      Source: