NodePropertyAdapter

class ui.nodeProperties.NodePropertyAdapter()

This class serves as a proxy to the Model class. It is used by the NodeProperties to communicate with the Model.

Constructors

ui.nodeProperties.NodePropertyAdapter.constructor()
NodePropertyAdapter(): NodePropertyAdapter

Returns: NodePropertyAdapter

Properties

ui.nodeProperties.NodePropertyAdapter.formatProperty

optional

formatProperty: (key: string, value: string) => [HTMLTemplateResult, HTMLTemplateResult]

This callback can be used to format properties before adding them to the DOM

ui.nodeProperties.NodePropertyAdapter.formatUserData

optional

formatUserData: (key: string, value: string) => [HTMLTemplateResult, HTMLTemplateResult]

This callback can be used to format user data before adding them to the DOM

ui.nodeProperties.NodePropertyAdapter.model

optional

model: IModel

The Model where the node will be queried.

Methods

ui.nodeProperties.NodePropertyAdapter.getNodeName()
getNodeName(nodeId: number): string

Get the name of the node

Parameters

nodeId: number

The node to gather information from

Returns: string

The name of the node
ui.nodeProperties.NodePropertyAdapter.getProperties()
getProperties(nodeId: number): Promise

Collects all the properties from a given node

Parameters

nodeId: number

The id of the node

Returns: Promise

A table containing the properties as [name, value] tuples
ui.nodeProperties.NodePropertyAdapter.getUserData()
getUserData(nodeId: number): Promise

Collects all the user data from a given node

Parameters

nodeId: number

The id of the node

Returns: Promise

A table containing the user data as [name, value] tuples