InstanceGraphAPI

• webVis API Reference
• InstanceGraphAPI

Interface InstanceGraphAPI

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.

Hierarchy

• InstanceGraphAPI
  • ContextAPI

Index

Methods

add addCustomNode collectRuntimeNodesOfType getEnabledAuxNodes getMetadata getProperties getProperty getRootNodeId getStatistics invertEnabledStates isNodeDeletable isNodeType registerCustomProperty remove requestActiveSceneVolume requestAuxRootNodeIds requestFullSceneVolume requestL3DInformation requestNodeIdsByBoxVolume requestRootNodeIds resetProperties resetProperty setParent setProperty

Methods

add

• add(options): 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
• add(dataURI, parentID?, usage?, label?, contentType?, initialProperties?, cacheStrategy?): number

• Parameters

  • dataURI: string

    Specifies the URI to the data resource.

  • Optional parentID: number

    Specifies the parent Node ID of the added Node.

  • Optional usage: UsageString

    The usage parameter allows to define how the resource should be inserted in the InstanceGraph.

  • Optional label: string

    Specifies a custom label for the added Node.

  • Optional contentType: string

    Specifies the MimeType of the data resource.

  • Optional initialProperties: InitialNodeProperties

    Specifies initialProperties of the added Node.

  • Optional cacheStrategy: CacheStrategy

    Specifies the strategy which is used when a data cache is requested from the Hub.

  Returns number

  The id of added Node

  Deprecated

  Adds a new Node to the InstanceGraph.

addCustomNode

• addCustomNode(customNodeType, data, dataType?): 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.

  • Optional dataType: AttachmentType

    {AttachmentType="json"} Specifies the type of the data.

  Returns number

collectRuntimeNodesOfType

• collectRuntimeNodesOfType(nodeType, subType?): number[]

• Returns a list of all existing runtime Node ids of a specified type.

  Parameters

  • nodeType: NodeType

    The Node type to collect.

  • Optional subType: string

    The sub type to collect. Only used for Custom-Nodes.

  Returns number[]

  A list of runtime Node ids of the specified type.

getEnabledAuxNodes

• getEnabledAuxNodes(nodeID?): Promise<number[]>

• Parameters

  • Optional nodeID: number

    Specifies the entry point of the subtree traversal (default: 0)

  Returns Promise<number[]>

  An Array of all enabled aux Node id's

  Deprecated

  This function will no longer be available in future webvis releases

  Traverses the subtree of a given nodeID and collects all enabled aux Nodes.

getMetadata

• getMetadata(nodeID): Promise<{
      [key: string]: string;
  }>

• Returns a JSON object containing the metadata for the given nodeID.

  Parameters

  • nodeID: number

    The id of a Node.

  Returns Promise<{
      [key: string]: string;
  }>

  A JSON object containing the requested metadata.

getProperties

• getProperties<T>(nodeID, properties): Promise<PropertyType<T>[]>

• Returns the values of the properties on the Node with the matching id.

  Type Parameters

  • T extends string

  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.

getProperty

• getProperty<T>(nodeID, property): Promise<PropertyType<T>>

• Returns the value of the property on the Node with the matching id.

  Type Parameters

  • T extends string

  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.

getRootNodeId

• getRootNodeId(target, includeTarget?): number

• Returns the root Node id of the given Node or Topology Element.

  Parameters

  • target: number | TopologyHandle

    Specifies the target Node or Topology Element.

  • Optional includeTarget: boolean

    Controls 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.

getStatistics

• getStatistics(nodeType?, nodeID?, recursive?): Promise<any>

• Traverses the subtree of a given nodeID and collects all statistics (currently only available for AUX-Nodes).

  Parameters

  • Optional nodeType: NodeType

    Specifies the target Node type.

  • Optional nodeID: number

    Specifies the entry point of the subtree traversal (default: 0).

  • Optional recursive: boolean

  Returns Promise<any>

  An Object of Type/Count pairs.

invertEnabledStates

• invertEnabledStates(): void

• Inverts all enabled states.

  Returns void

isNodeDeletable

• isNodeDeletable(nodeID): boolean

• Parameters

  • nodeID: number

  Returns boolean

  Returns true if a Node is deletable.

isNodeType

• isNodeType(nodeID, nodeType): boolean

• Parameters

  • nodeID: number

  • nodeType: NodeType

  Returns boolean

  Checks the Node's type for the given Node id.

registerCustomProperty

• registerCustomProperty(name, defaultValue, recursive?): void

• Registering a new custom property.

  Parameters

  • name: string

    The name of the new property.

  • defaultValue: any

    Specifies the default value.

  • Optional recursive: boolean

    Defines whether the property is recursive.

  Returns void

remove

• remove(nodeID?, safe?): 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

  • Optional nodeID: number | number[]

    The id of the Node that should be removed.

  • Optional safe: boolean

    Performs a safe remove which interrupt the removal process if the Node is part of one or more Snapshots.

  Returns Promise<RemoveState>

requestActiveSceneVolume

• requestActiveSceneVolume(): Promise<BoxVolume>

• Returns the active volume of currently loaded scene.

  Returns Promise<BoxVolume>

  The active volume of currently loaded scene.

requestAuxRootNodeIds

• requestAuxRootNodeIds(scopeNodeId?): Promise<number[]>

• Returns a list of all existing aux root Node ids below the specified subtree.

  Parameters

  • Optional scopeNodeId: number

    Specifies the top one Node id of the subtree to be searched.

  Returns Promise<number[]>

  A list of aux root Node ids.

requestFullSceneVolume

• requestFullSceneVolume(): Promise<BoxVolume>

• Returns the full volume of currently loaded scene.

  Returns Promise<BoxVolume>

  • The full volume of currently loaded scene.

requestL3DInformation

• requestL3DInformation(targetNodeId): Promise<any>

• Returns the L3D information of the specified Node.

  Parameters

  • targetNodeId: number

    Specifies the target Node id.

  Returns Promise<any>

  The L3D information of the specified Node

requestNodeIdsByBoxVolume

• requestNodeIdsByBoxVolume(boxVolume, includeOverlappingNodes?, includeDisabledNodes?, forceExpand?, scopeNodeId?): 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.

  • Optional includeOverlappingNodes: boolean

    Specifies that the result should include Nodes which overlap the specified 3D world space Bounding Volume as well.

  • Optional includeDisabledNodes: boolean

    Specifies that the result should include Nodes which are disabled as well.

  • Optional forceExpand: boolean

  • Optional scopeNodeId: number

    Specifies 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.

requestRootNodeIds

• requestRootNodeIds(scopeNodeId?, recursive?): Promise<number[]>

• Returns a list of all existing root Node ids below the specified subtree.

  Parameters

  • Optional scopeNodeId: number

    Specifies the top one Node id of the subtree to be searched.

  • Optional recursive: boolean

    Specifies if the subtree is traversed recursively.

  Returns Promise<number[]>

  A list of root Node ids.

resetProperties

• resetProperties<T>(nodeID, properties, recursive?): Promise<void>

• Resets the value of the specified properties on the given Node.

  Type Parameters

  • T extends string

  Parameters

  • nodeID: number

    The id of the Node whose property should be reset.

  • properties: T[]

    List of properties which should be reset.

  • Optional recursive: boolean

    If set to true, the properties are reset recursively.

  Returns Promise<void>

resetProperty

• resetProperty<T>(nodeID, property, recursive?): Promise<void>

• Resets the value of the property on the Node with the matching id.

  Type Parameters

  • T extends string

  Parameters

  • nodeID: number

    The id of the Node whose property should be reset.

  • property: T

    Property which should be reset.

  • Optional recursive: boolean

    If set to true, the properties are reset recursively.

  Returns Promise<void>

setParent

• setParent(nodeID, newParentID): void

• Parameters

  • nodeID: number

  • newParentID: number

  Returns void

setProperty

• setProperty<T>(nodeID, property, value, silent?): Promise<void>

• Sets the property named property to value on the Node with id nodeID.

  Type Parameters

  • T extends string

  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.

  • Optional silent: boolean

    The silent flag indicates that no NODE_CHANGED event is fired.

  Returns Promise<void>