Class: JsonDiagramDataSource

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

QuickNav


JsonDiagramDataSource extends oj.DiagramDataSource

Version:
  • 7.1.0
Since:
  • 3.0
Module:
  • ojjsondiagramdatasource

Module usage

See JET Module Loading for an overview of module usage within JET.

Description

JSON implementation of the oj.DiagramDataSource

Constructor

new JsonDiagramDataSource(data, options)

Parameters:
Name Type Argument Description
data Object JSON data object with following properties:
nodesAn optional array of nodes. See oj.DiagramDataSource.NodeObject section.
linksAn optional array of links. See oj.DiagramDataSource.LinkObject section.
options Object <optional>
the options set on this data source
Properties
Name Type Argument Description
childData function <optional>
Function callback to retrieve nodes and links for the specified parent. Function will return a Promise that resolves into an object with the following structure:

nodesAn array of objects for the child nodes for the given parent. See oj.DiagramDataSource.NodeObject section.
linksAn array of objects for the links for the given parent. See oj.DiagramDataSource.LinkObject section.

Methods

getCapability(feature) → {string|null}

Determines whether this DataSource supports the specified feature.
Parameters:
Name Type Description
feature string the feature in which its capabilities is inquired.
Inherited From:
Returns:
the capability of the specified feature. Returns null if the feature is not recognized.
Type
string | null

getChildCount(nodeData) → {number}

Retrieves number of child nodes
Parameters:
Name Type Description
nodeData Object A data object for the node in question. See oj.DiagramDataSource.NodeObject section.
Returns:
Number of child nodes if child count is available. The method returns 0 for leaf nodes. The method returns -1 if the child count is unknown (e.g. if the children have not been fetched).
Type
number

getData(parentData) → {Promise}

Returns child data for the given parent. The data include all immediate child nodes along with links whose endpoints both descend from the current parent node. If all the links are available upfront, they can be returned as part of the top-level data (since all nodes descend from the diagram root). If lazy-fetching links is desirable, the most optimal way to return links is as part of the data of the nearest common ancestor of the link's endpoints.
Parameters:
Name Type Description
parentData Object | null An object that contains data for the parent node. See oj.DiagramDataSource.NodeObject section. If parentData is null, the method retrieves data for top level nodes.
Returns:
Promise resolves to a component object with the following structure:

nodesAn array of objects for the child nodes for the given parent. See oj.DiagramDataSource.NodeObject section.
linksAn array of objects for the links for the given parent. See oj.DiagramDataSource.LinkObject section.

Type
Promise

getDescendantsConnectivity(nodeData) → {string}

Indicates whether the specified object contains links that should be discovered in order to display promoted links.
Parameters:
Name Type Description
nodeData Object A data object for the container node in question. See oj.DiagramDataSource.NodeObject section.
Returns:
the valid values are "connected", "disjoint", "unknown"
Type
string

handleEvent(eventType, event) → {boolean}

Handle the event
Parameters:
Name Type Description
eventType string event type
event Object event
Inherited From:
Returns:
Returns false if event is cancelled
Type
boolean

Init() → {undefined}

Initializes the instance.
Inherited From:
Returns:
Type
undefined

off(eventType, eventHandler) → {void}

Detach an event handler.

Application can call this if it no longer wants to be notified of an event that it has attached an handler to using the on method.

Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Inherited From:
Returns:
Type
void

on(eventType, eventHandler) → {void}

Attach an event handler.

Application can call this if it wants to be notified of an event. It can call the off method to detach the handler when it no longer wants to be notified.

Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Inherited From:
Returns:
Type
void