InstanceGraphAPI¶
Interface InstanceGraphAPI
add(options: AddNodeOptions): number;
add(
dataURI: string,
parentID?: number,
usage?: UsageString,
label?: string,
contentType?: string,
initialProperties?: InitialNodeProperties,
cacheStrategy?: CacheStrategy,
): number;
addCustomNode(
customNodeType: string,
data: any,
dataType?: AttachmentType,
): number;
collectRuntimeNodesOfType(nodeType: NodeType, subType?: string): number[];
getEnabledAuxNodes(nodeID?: number): Promise<number[]>;
getMetadata(nodeID: number): Promise<{ [key: string]: string }>;
getProperties<T extends string>(
nodeID: number,
properties: T[],
): Promise<PropertyType<T>[]>;
getProperty<T extends string>(
nodeID: number,
property: T,
): Promise<PropertyType<T>>;
getRootNodeId(
target: number | TopologyHandle,
includeTarget?: boolean,
): number;
getStatistics(
nodeType?: NodeType,
nodeID?: number,
recursive?: boolean,
): Promise<any>;
invertEnabledStates(): void;
isNodeDeletable(nodeID: number): boolean;
isNodeType(nodeID: number, nodeType: NodeType): boolean;
registerCustomProperty(
name: string,
defaultValue: any,
recursive?: boolean,
): void;
remove(nodeID?: number | number[], safe?: boolean): Promise<RemoveState>;
requestActiveSceneVolume(): Promise<BoxVolume>;
requestAuxRootNodeIds(scopeNodeId?: number): Promise<number[]>;
requestFullSceneVolume(): Promise<BoxVolume>;
requestL3DInformation(targetNodeId: number): Promise<any>;
requestNodeIdsByBoxVolume(
boxVolume: BoxVolume,
includeOverlappingNodes?: boolean,
includeDisabledNodes?: boolean,
forceExpand?: boolean,
scopeNodeId?: number,
): Promise<number[]>;
requestRootNodeIds(
scopeNodeId?: number,
recursive?: boolean,
): Promise<number[]>;
resetProperties<T extends string>(
nodeID: number,
properties: T[],
recursive?: boolean,
): Promise<void>;
resetProperty<T extends string>(
nodeID: number,
property: T,
recursive?: boolean,
): Promise<void>;
setParent(nodeID: number, newParentID: number): void;
setProperty<T extends string>(
nodeID: number | number[],
property: T,
value: PropertyType<T>,
silent?: boolean,
): Promise<void>;
}
Hierarchy (View Summary)
- InstanceGraphAPI
Index
Methods
Methods
add
- add(options: AddNodeOptions): number
Adds a new Node to the InstanceGraph.
Parameters
- options: AddNodeOptions
Specifies the options for the new Node.
Returns number
The id of added Node
- options: AddNodeOptions
- add(
dataURI: string,
parentID?: number,
usage?: UsageString,
label?: string,
contentType?: string,
initialProperties?: InitialNodeProperties,
cacheStrategy?: CacheStrategy,
): number Parameters
- dataURI: string
Specifies the URI to the data resource.
OptionalparentID: numberSpecifies the parent Node ID of the added Node.
Optionalusage: UsageStringThe usage parameter allows to define how the resource should be inserted in the InstanceGraph.
Optionallabel: stringSpecifies a custom label for the added Node.
OptionalcontentType: stringSpecifies the MimeType of the data resource.
OptionalinitialProperties: InitialNodePropertiesSpecifies initialProperties of the added Node.
OptionalcacheStrategy: CacheStrategySpecifies the strategy which is used when a data cache is requested from the Hub.
Returns number
The id of added Node
- dataURI: string
add
- addCustomNode(
customNodeType: string,
data: any,
dataType?: AttachmentType,
): number Creates a custom Node with custom data which is stored in an Attachment.
Parameters
- customNodeType: string
{string} Specifies the custom Node type.
- data: any
{any} Specifies the data of the custom Node.
OptionaldataType: AttachmentType{AttachmentType="json"} Specifies the type of the data.
Returns number
- customNodeType: string
collect
- collectRuntimeNodesOfType(nodeType: NodeType, subType?: string): number[]
Returns a list of all existing runtime Node ids of a specified type.
Parameters
- nodeType: NodeType
The Node type to collect.
OptionalsubType: stringThe sub type to collect. Only used for Custom-Nodes.
Returns number[]
A list of runtime Node ids of the specified type.
- nodeType: NodeType
get
get
get
- getProperties<T extends string>(
nodeID: number,
properties: T[],
): Promise<PropertyType<T>[]> Returns the values of the properties on the Node with the matching id.
Type Parameters
Parameters
- nodeID: number
The id of the Node whose properties should be read.
- properties: T[]
The names of the properties whose value should be read.
Returns Promise<PropertyType<T>[]>
The retrieved values of the Node's properties.
- nodeID: number
get
- getProperty<T extends string>(
nodeID: number,
property: T,
): Promise<PropertyType<T>> Returns the value of the property on the Node with the matching id.
Type Parameters
Parameters
- nodeID: number
The id of the Node whose property should be read.
- property: T
The name of the property whose value should be read.
Returns Promise<PropertyType<T>>
The retrieved value of the Node property.
- nodeID: number
get
- getRootNodeId(target: number | TopologyHandle, includeTarget?: boolean): number
Returns the root Node id of the given Node or Topology Element.
Parameters
- target: number | TopologyHandle
Specifies the target Node or Topology Element.
OptionalincludeTarget: booleanControls if the target Node itself can be returned as root Node. If set to false and a root Node id is passed in, it returns the next higher root Node id.
Returns number
- The root Node id of the given Node id or Topology handle.
- target: number | TopologyHandle
get
- getStatistics(
nodeType?: NodeType,
nodeID?: number,
recursive?: boolean,
): Promise<any> Traverses the subtree of a given nodeID and collects all statistics (currently only available for AUX-Nodes).
Parameters
OptionalnodeType: NodeTypeSpecifies the target Node type.
OptionalnodeID: numberSpecifies the entry point of the subtree traversal (default: 0).
Optionalrecursive: boolean
Returns Promise<any>
An Object of Type/Count pairs.
invert
is
is
register
remove
- remove(nodeID?: number | number[], safe?: boolean): Promise<RemoveState>
Removes the Node for the given nodeID from the Scene and all related Snapshots. If no nodeID is supplied all Nodes are deleted.
Parameters
OptionalnodeID: number | number[]The id of the Node that should be removed.
Optionalsafe: booleanPerforms a safe remove which interrupt the removal process if the Node is part of one or more Snapshots.
Returns Promise<RemoveState>
request
request
request
request
request
- requestNodeIdsByBoxVolume(
boxVolume: BoxVolume,
includeOverlappingNodes?: boolean,
includeDisabledNodes?: boolean,
forceExpand?: boolean,
scopeNodeId?: number,
): Promise<number[]> Returns a List of all Node ids which are included or overlapped by the specified 3D world space Bounding Volume.
Parameters
- boxVolume: BoxVolume
Specifies the 3D world space Bounding Volume.
OptionalincludeOverlappingNodes: booleanSpecifies that the result should include Nodes which overlap the specified 3D world space Bounding Volume as well.
OptionalincludeDisabledNodes: booleanSpecifies that the result should include Nodes which are disabled as well.
OptionalforceExpand: booleanOptionalscopeNodeId: numberSpecifies the top one Node id of the subtree to be searched.
Returns Promise<number[]>
List of all NodeIds which are included or overlapped by the specified 3D world space Bounding Volume.
- boxVolume: BoxVolume
request
- requestRootNodeIds(scopeNodeId?: number, recursive?: boolean): Promise<number[]>
Returns a list of all existing root Node ids below the specified subtree.
Parameters
OptionalscopeNodeId: numberSpecifies the top one Node id of the subtree to be searched.
Optionalrecursive: booleanSpecifies if the subtree is traversed recursively.
Returns Promise<number[]>
A list of root Node ids.
reset
- resetProperties<T extends string>(
nodeID: number,
properties: T[],
recursive?: boolean,
): Promise<void> Resets the value of the specified properties on the given Node.
Type Parameters
Parameters
- nodeID: number
The id of the Node whose property should be reset.
- properties: T[]
List of properties which should be reset.
Optionalrecursive: booleanIf set to true, the properties are reset recursively.
Returns Promise<void>
- nodeID: number
reset
- resetProperty<T extends string>(
nodeID: number,
property: T,
recursive?: boolean,
): Promise<void> Resets the value of the property on the Node with the matching id.
Type Parameters
Parameters
- nodeID: number
The id of the Node whose property should be reset.
- property: T
Property which should be reset.
Optionalrecursive: booleanIf set to true, the properties are reset recursively.
Returns Promise<void>
- nodeID: number
set
set
- setProperty<T extends string>(
nodeID: number | number[],
property: T,
value: PropertyType<T>,
silent?: boolean,
): Promise<void> Sets the property named property to value on the Node with id nodeID.
Type Parameters
Parameters
- nodeID: number | number[]
The id of the Node whose property has to be set.
- property: T
The name of the property that has to be set.
- value: PropertyType<T>
The new value of the specified property.
Optionalsilent: booleanThe silent flag indicates that no NODE_CHANGED event is fired.
Returns Promise<void>
- nodeID: number | number[]
With the InstanceGraphAPI the content of webvis can be controlled and manipulated. It resembles a scene graph like tree structure of Nodes. Every Node can contain links to 3D geometry and/or group other Nodes.
The get- and set-Property functions allow setting and retrieving properties of arbitrary type on the Nodes. Properties are used to modify any Node dependent data like color, local transformation, etc. There is a set of predefined Node properties that webvis will react on, but the surrounding application might add any other property to the Nodes.