IGraphElementResolver

Show usages

Interface for classes can resolve graph elements based on their GraphML id attribute(s).

Inheritance Hierarchy

IGraphElementResolver

GraphElementIdAcceptor

Type Details

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

Methods

resolveEdge

(context: IParseContext, id: string) : IEdge

Resolve the GraphML id to an IEdge instance.

Parameters

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

context - IParseContext: The current parse context.
id - string: The id that should be resolved.

Returns

↪IEdge: The IEdge that is defined by this GraphML id, or null if no such edge exists yet.

resolveGraph

(context: IParseContext, id: string) : IGraph

Resolve the GraphML id to an IGraph instance.

Parameters

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

context - IParseContext: The current parse context.
id - string: The id that should be resolved.

Returns

↪IGraph: The IGraph that is defined by this GraphML id, or null if no such graph exists yet.

resolveNode

(context: IParseContext, id: string) : INode

Resolve the GraphML id to an INode instance.

Parameters

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

context - IParseContext: The current parse context.
id - string: The id that should be resolved.

Returns

↪INode: The INode that is defined by this GraphML id, or null if no such node exists yet.

resolvePort

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

Resolve the GraphML id to an IPort instance.

Remarks

The port owner is specified by the ownerId attribute.

Parameters

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

context - IParseContext: The current parse context.
ownerId - string: The GraphML id of the port owner.
id - string: The id that should be resolved.

Returns

↪IPort: The IPort that is defined by the GraphML ids, or null if no such port exists yet.

Static Methods

create

() : IGraphElementResolver

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

Remarks

The given object must contain exactly the abstract members of the IGraphElementResolver 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.

resolveNode - function(IParseContext, string):INode: Resolve the GraphML id to an INode instance.
This property holds the implementation for resolveNode.
resolveGraph - function(IParseContext, string):IGraph: Resolve the GraphML id to an IGraph instance.
This property holds the implementation for resolveGraph.
resolvePort - function(IParseContext, string, string):IPort: Resolve the GraphML id to an IPort instance.
This property holds the implementation for resolvePort.
resolveEdge - function(IParseContext, string):IEdge: Resolve the GraphML id to an IEdge instance.
This property holds the implementation for resolveEdge.

Returns

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