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. 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 labelDecorator 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. setImplementation decorates the label's lookup to return the same instance for each label.
graph.decorator.labelDecorator.editLabelHelperDecorator.setImplementation(
new ConstantEditLabelHelper()
)setImplementation 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.labelDecorator.editLabelHelperDecorator.setImplementation(
(label) => label.tag !== null,
new ConstantEditLabelHelper()
)setFactory 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.labelDecorator.editLabelHelperDecorator.setFactory(
(label) => new CustomEditLabelHelper(label)
)
graph.decorator.labelDecorator.editLabelHelperDecorator.setFactory(
(label) => label.tag !== null,
(label) => new CustomEditLabelHelper(label)
)setImplementationWrapper 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.labelDecorator.editLabelHelperDecorator.setImplementationWrapper(
(label, original) => new EditLabelHelperWrapper(label, original)
)
graph.decorator.labelDecorator.editLabelHelperDecorator.setImplementationWrapper(
(label) => label.tag !== null,
(label, original) => new EditLabelHelperWrapper(label, original)
)graph.decorator.labelDecorator.editLabelHelperDecorator.setImplementationWrapper(
(label, original) => new EditLabelHelperWrapper(label!, original)
)
graph.decorator.labelDecorator.editLabelHelperDecorator.setImplementationWrapper(
(label) => label.tag !== null,
(label, original) => new EditLabelHelperWrapper(label!, original)
)Finally hideImplementation 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.labelDecorator.editLabelHelperDecorator.hideImplementation()
graph.decorator.labelDecorator.editLabelHelperDecorator.hideImplementation(
(label) => label.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.labelDecorator.editLabelHelperDecorator.setFactory(
(label) => new CustomEditLabelHelper(label)
)
}
/**
* @param {!IGraph} graph
*/
deregisterLookup(graph) {
graph.decorator.labelDecorator.remove(this.chainLink)
}registerLookup(graph: IGraph): void {
this.chainLink =
graph.decorator.labelDecorator.editLabelHelperDecorator.setFactory(
(label) => new CustomEditLabelHelper(label)
)!
}
deregisterLookup(graph: IGraph): void {
graph.decorator.labelDecorator.remove(this.chainLink)
}Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.LabelDecorator
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, which can be
null.
Properties
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IClipboardHelper type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IEditLabelHelper type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IFocusIndicatorInstaller type for ILabels this instance has been created for.
Remarks
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.
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IHighlightIndicatorInstaller type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelModelParameterFinder type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelModelParameterProvider type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelSnapContextHelper type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILassoTestable type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IMarqueeTestable type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IMementoSupport type for ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IObstacleProvider type for ILabels this instance has been created for.
Remarks
See Also
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IPositionHandler type for the ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ISelectionIndicatorInstaller type for ILabels this instance has been created for.
Remarks
Methods
getDecoratorFor
<TInterface>(type: Class, decorateNulls?: boolean, nullIsFallback?: boolean) : 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.
- type - Class
- The type of the interface that should be decorated of the instances' lookup.
- decorateNulls - boolean
- if set to
truenullvalues will be decorated, otherwise not. - nullIsFallback - boolean
- if set to
truenullvalues will be treated as fallback values, otherwise they will be used as the final result.
Returns
- ↪LookupDecorator<ILabel,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 labels.
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.labelDecorator.editLabelHelperDecorator.setFactory(
(label) => new CustomEditLabelHelper(label)
)
}
/**
* @param {!IGraph} graph
*/
deregisterLookup(graph) {
graph.decorator.labelDecorator.remove(this.chainLink)
}registerLookup(graph: IGraph): void {
this.chainLink =
graph.decorator.labelDecorator.editLabelHelperDecorator.setFactory(
(label) => new CustomEditLabelHelper(label)
)!
}
deregisterLookup(graph: IGraph): void {
graph.decorator.labelDecorator.remove(this.chainLink)
}