Helps in decorating the lookup method of INode instances by providing access to decorators for the most common types.
Remarks
Predefined LookupDecorator<TDecoratedType,TInterface> are made available through properties like e.g. highlightDecorator. Note that the list of possible decorations that are available using this class is not exhaustive in any way. This is merely a way to provide access to those interfaces that are more commonly being decorated by the developer.
Typically, a configured instance of this class is available through nodeDecorator on the GraphDecorator which is returned by decorator on an IGraph.
This decorator can be used to conveniently decorate the lookup of INodes in an IGraph. It serves as a factory for predefined LookupDecorator<TDecoratedType,TInterface> instances that are specifically useful for the INode type.
Examples
The node can be decorated in various ways. setImplementation decorates the node's lookup to return the same instance for each node.
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setImplementation(
new ConstantSizeConstraintProvider()
)
setImplementation with a predicate decorates the node's lookup only to return the same instance for each node for which the predicate returns true
.
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setImplementation(
(node) => node.tag !== null,
new ConstantSizeConstraintProvider()
)
setFactory calls the provided factory method to return a new instance of the queried type created for the given node or for nodes for which the predicate returns true
, respectively:
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setFactory(
(node) => new CustomSizeConstraintProvider(node)
)
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setFactory(
(node) => node.tag !== null,
(node) => new CustomSizeConstraintProvider(node)
)
setImplementationWrapper calls the provided factory method to return a new instance of the queried type which wraps the default implementation, once for all nodes and once only for nodes for which the predicate returns true
.
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setImplementationWrapper(
(node, originalProvider) =>
new SizeConstraintProviderWrapper(node, originalProvider)
)
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setImplementationWrapper(
(node) => node.tag !== null,
(node, originalProvider) =>
new SizeConstraintProviderWrapper(node, originalProvider)
)
Finally hideImplementation hides the default implementation by letting the lookup always return null
for all nodes and for nodes for which the predicate returns true
, respectively
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.hideImplementation()
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.hideImplementation(
(node) => node.tag !== null
)
Each of these methods returns a IContextLookupChainLink which can be used to remove the modified behavior again:
/**
* @param {!IGraph} graph
*/
registerLookup(graph) {
this.chainLink =
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setFactory(
(node) => new CustomSizeConstraintProvider(node)
)
}
/**
* @param {!IGraph} graph
*/
deregisterLookup(graph) {
graph.decorator.nodeDecorator.remove(this.chainLink)
}
registerLookup(graph: IGraph): void {
this.chainLink =
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setFactory(
(node) => new CustomSizeConstraintProvider(node)
)!
}
deregisterLookup(graph: IGraph): void {
graph.decorator.nodeDecorator.remove(this.chainLink)
}
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.NodeDecorator
See Also
Constructors
Initializes a new instance of the NodeDecorator class.
Parameters
A map of options to pass to the method.
- decorator - ILookupDecorator
- The decorator to use, which can be
null
.
Properties
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IClipboardHelper type for INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IEditLabelHelper type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IFocusIndicatorInstaller type for INodes this instance has been created for.
Remarks
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IGroupBoundsCalculator type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IHandleProvider type for INodes this instance has been created for.
Remarks
Custom IHandleProvider implementations provide interactive draggable handles for the user to change the geometry or other aspects of INodes in the GraphComponent. This interface is mainly used by the HandleInputMode in the GraphEditorInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's lookup.
When the decorated IHandleProvider provides a set of handles that may change over time, a call to requeryHandles may be necessary to refresh the displayed handles.
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IHighlightIndicatorInstaller type for INodes this instance has been created for.
Remarks
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the INodeInsetsProvider type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILassoTestable type for INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IMarqueeTestable type for INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IMementoSupport type for INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the INodeReshapeSnapResultProvider type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the INodeSnapResultProvider type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IObstacleProvider type for INodes this instance has been created for.
Remarks
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IPortCandidateProvider type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IPositionHandler type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IReshapeHandleProvider type for the INodes this instance has been created for.
Remarks
Custom IReshapeHandleProvider implementations can be used to change the number and type of IHandles that can be used by the user to reshape the INodes in interactively in the editor. This interface is mainly used by the GraphEditorInputMode which passes the IHandles to the HandleInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's lookup.
When the decorated IReshapeHandleProvider provides a set of handles that may change over time, a call to requeryHandles may be necessary to refresh the displayed handles.
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IReshapeHandler type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ISelectionIndicatorInstaller type for INodes this instance has been created for.
Remarks
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IShapeGeometry type for the INodes this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the INodeSizeConstraintProvider type for the INodes this instance has been created for.
Remarks
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ISnapLineProvider type for the INodes this instance has been created for.
Remarks
See Also
Methods
getDecoratorFor
<TInterface>(type: Class, decorateNulls?: boolean, nullIsFallback?: boolean) : LookupDecorator<INode,TInterface>Creates a LookupDecorator<TDecoratedType,TInterface> for INodes that can be used to decorate TInterface
types of the nodes.
Type Parameters
- TInterface
- The type of the interface that should be decorated of the instances'
.
Parameters
A map of options to pass to the method.
- type - Class
- The type of the interface that should be decorated of the instances' lookup.
- decorateNulls - boolean
- if set to
true
null
values will be decorated, otherwise not. - nullIsFallback - boolean
- if set to
true
null
values will be treated as fallback values, otherwise they will be used as the final result.
Returns
- ↪LookupDecorator<INode,TInterface>
- A new LookupDecorator<TDecoratedType,TInterface> for the specified interface.
$class
property on JavaScript classes inheriting from yFiles classes is only valid once an instance of this subclass was created. Call fixType, first or instantiate the class at least once.Removes an IContextLookupChainLink again that has been added by one of the various decorators for nodes.
Parameters
A map of options to pass to the method.
- lookup - IContextLookupChainLink
- The lookup chain link to remove.
Examples
/**
* @param {!IGraph} graph
*/
registerLookup(graph) {
this.chainLink =
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setFactory(
(node) => new CustomSizeConstraintProvider(node)
)
}
/**
* @param {!IGraph} graph
*/
deregisterLookup(graph) {
graph.decorator.nodeDecorator.remove(this.chainLink)
}
registerLookup(graph: IGraph): void {
this.chainLink =
graph.decorator.nodeDecorator.sizeConstraintProviderDecorator.setFactory(
(node) => new CustomSizeConstraintProvider(node)
)!
}
deregisterLookup(graph: IGraph): void {
graph.decorator.nodeDecorator.remove(this.chainLink)
}