-
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:
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:
-
Type
-
Promise
-
getDescendantsConnectivity(nodeData) : {string}
-
Indicates whether the specified object contains links
that should be discovered in order to display promoted links.
Parameters:
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