IGraphElementIdAcceptor

Show usages

Interface for classes that can store the GraphML id attribute of GraphML core elements

Inheritance Hierarchy

IGraphElementIdAcceptor

GraphElementIdAcceptor

Type Details

yfiles module: view-graphml
yfiles-umd modules: view-graphml, view
Legacy UMD name: yfiles.graphml.IGraphElementIdAcceptor

Methods

storeEdgeId

(context: IParseContext, edge: IEdge, id: string)

Store the value of the id attribute for the given edge.

Parameters

options - Object
A map of options to pass to the method.

context - IParseContext: The current parse context.
edge - IEdge: The current edge element
id - string: The id of the edge's XML representation

storeGraphId

(context: IParseContext, graph: IGraph, id: string)

Store the value of the id attribute for the given graph.

Parameters

options - Object
A map of options to pass to the method.

context - IParseContext: The current parse context.
graph - IGraph: The current graph element
id - string: The id of the graph's XML representation

storeNodeId

(context: IParseContext, node: INode, id: string)

Store the value of the id attribute for the given node.

Parameters

options - Object
A map of options to pass to the method.

context - IParseContext: The current parse context.
node - INode: The current node element
id - string: The id of the node's XML representation

storePortId

(context: IParseContext, port: IPort, id: string)

Store the value of the id attribute for the given port.

Parameters

options - Object
A map of options to pass to the method.

context - IParseContext: The current parse context.
port - IPort: The current port element
id - string: The id of the port's XML representation

Static Methods

create

() : IGraphElementIdAcceptor

Creates an implementation of the interface IGraphElementIdAcceptor from the given definition.

Remarks

The given object must contain exactly the abstract members of the IGraphElementIdAcceptor interface. No member may be omitted and no additional members can be added. While additional custom members can later be added directly on the instance, this is discouraged.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

storeGraphId - function(IParseContext, IGraph, string):void: Store the value of the id attribute for the given graph.
This property holds the implementation for storeGraphId.
storeNodeId - function(IParseContext, INode, string):void: Store the value of the id attribute for the given node.
This property holds the implementation for storeNodeId.
storeEdgeId - function(IParseContext, IEdge, string):void: Store the value of the id attribute for the given edge.
This property holds the implementation for storeEdgeId.
storePortId - function(IParseContext, IPort, string):void: Store the value of the id attribute for the given port.
This property holds the implementation for storePortId.

Returns

↪IGraphElementIdAcceptor: An instance of the IGraphElementIdAcceptor interface based on the given definition.