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 stripeLabelDecorator on the TableDecorator which is returned by decorator on an ITable.
This decorator can be used to conveniently decorate the lookup of ILabels in an ITable. It serves as a factory for predefined LookupDecorator<TDecoratedType,TInterface> instances that are specifically useful for the ILabel type.
Type Details
- yfiles module
- view-table
- yfiles-umd modules
- view-table, view
- Legacy UMD name
- yfiles.graph.StripeLabelDecorator
See Also
Constructors
Initializes a new instance of the StripeLabelDecorator 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 IEditLabelHelper type for the ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IFocusIndicatorInstaller type for the type of items this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IHighlightIndicatorInstaller type for the type of items this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelModelParameterFinder type for the ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ILabelModelParameterProvider type for the ILabels this instance has been created for.
Remarks
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the ISelectionIndicatorInstaller type for the type of items 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 stripe labels.
Parameters
A map of options to pass to the method.
- lookup - IContextLookupChainLink
- The lookup chain link to remove.