Helps in decorating the lookup method of ILabel instances by providing access to decorators for the most common types.
Remarks
Predefined LookupDecorator<TDecoratedType,TInterface> are made available through properties like e.g. highlightRenderer. 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 labels on the GraphDecorator which is returned by decorator on an IGraph.
This decorator can be used to conveniently decorate the lookup of ILabels in an IGraph. It serves as a factory for predefined LookupDecorator<TDecoratedType,TInterface> instances that are specifically useful for the ILabel type.
Examples
The label can be decorated in various ways. addConstant decorates the label's lookup to return the same instance for each label.
graph.decorator.labels.editLabelHelper.addConstant(
new ConstantEditLabelHelper(),
)
addConstant with a predicate decorates the label's lookup only to return the same instance for each label for which the predicate returns true
.
graph.decorator.labels.editLabelHelper.addConstant(
(label) => label.tag !== null,
new ConstantEditLabelHelper(),
)
addFactory calls the provided factory method to return a new instance of the queried type created for the given label or for labels for which the predicate returns true
, respectively:
graph.decorator.labels.editLabelHelper.addFactory(
(label) => new CustomEditLabelHelper(label),
)
graph.decorator.labels.editLabelHelper.addFactory(
(label) => label.tag !== null,
(label) => new CustomEditLabelHelper(label),
)
addWrapperFactory calls the provided factory method to return a new instance of the queried type which wraps the default implementation, once for all labels and once only for labels for which the predicate returns true
.
graph.decorator.labels.editLabelHelper.addWrapperFactory(
(label, original) => new EditLabelHelperWrapper(label!, original),
)
graph.decorator.labels.editLabelHelper.addWrapperFactory(
(label) => label.tag !== null,
(label, original) => new EditLabelHelperWrapper(label!, original),
)
Finally hide hides the default implementation by letting the lookup always return null
for all labels and for labels for which the predicate returns true
, respectively
graph.decorator.labels.editLabelHelper.hide()
graph.decorator.labels.editLabelHelper.hide((label) => label.tag !== null)
Each of these methods returns a IContextLookupChainLink which can be used to remove the modified behavior again:
registerLookup(graph: IGraph): void {
this.chainLink = graph.decorator.labels.editLabelHelper.addFactory(
(label) => new CustomEditLabelHelper(label),
)!
}
deregisterLookup(graph: IGraph): void {
graph.decorator.labels.remove(this.chainLink)
}
Type Details
- yFiles module
- view
See Also
Constructors
Initializes a new instance of the LabelDecorator class.
Parameters
A map of options to pass to the method.
- decorator - ILookupDecorator
- The decorator to use.
Properties
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IClipboardHelper type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IEditLabelHelper type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IFocusRenderer<ILabel> type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IHandleProvider type for ILabels 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 ILabels 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.
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IHighlightRenderer<ILabel> type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelModelParameterFinder type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelModelParameterProvider type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILassoTestable type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IMarqueeTestable type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IMementoSupport type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IObstacleProvider type for ILabels this instance has been created for.
Remarks
Property Value
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IPositionHandler type for the ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ISelectionRenderer<ILabel> type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ISnapReferenceProvider type for ILabels this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelSnapResultProvider type for ILabels this instance has been created for.
Remarks
Property Value
Methods
Adds an IContextLookupChainLink.
Remarks
Parameters
A map of options to pass to the method.
- link - IContextLookupChainLink
- The lookup chain link to add.
addGenericLookup
(genericLink: function(ILabel, Constructor, IContextLookup):any) : IContextLookupChainLinkAdds a generic callback as a chain link to the lookup.
Remarks
Parameters
A map of options to pass to the method.
- genericLink - function(ILabel, Constructor, IContextLookup):any
- The generic callback to add to the lookup chain.
Signature Details
function(arg1: ILabel, arg2: Constructor, arg3: IContextLookup) : any
Encapsulates a method that has three parameters and returns a value of the type specified by theTResult
parameter.Parameters
- arg1 - ILabel
- The first parameter of the method that this delegate encapsulates.
- arg2 - Constructor
- The second parameter of the method that this delegate encapsulates.
- arg3 - IContextLookup
- The third parameter of the method that this delegate encapsulates.
Returns
- any
- The return value of the method that this delegate encapsulates.
Returns
- ↪IContextLookupChainLink
- An IContextLookupChainLink that has been added to the lookup.
getDecoratorFor
<TInterface>(interfaceType: Constructor<TInterface>) : LookupDecorator<ILabel,TInterface>Creates a LookupDecorator<TDecoratedType,TInterface> for ILabels that can be used to decorate TInterface
types of the labels.
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.
- interfaceType - Constructor<TInterface>
- The type of the interface that should be decorated of the instances' lookup.
Returns
- ↪LookupDecorator<ILabel,TInterface>
- A new LookupDecorator<TDecoratedType,TInterface> for the specified interface.
Removes an IContextLookupChainLink that has been added by one of the various decorators for labels.
Parameters
A map of options to pass to the method.
- link - IContextLookupChainLink
- The lookup chain link to remove.
Examples
registerLookup(graph: IGraph): void {
this.chainLink = graph.decorator.labels.editLabelHelper.addFactory(
(label) => new CustomEditLabelHelper(label),
)!
}
deregisterLookup(graph: IGraph): void {
graph.decorator.labels.remove(this.chainLink)
}