StripeDecorator<TStripe extends IStripe>
Helps in decorating the lookup method of IStripe instances by providing access to decorators for the most common types.
Remarks
Predefined LookupDecorator<TDecoratedType,TInterface> are made available through properties like e.g. positionHandler. 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 columns and rows on the TableDecorator which is returned by decorator on an ITable.
This decorator can be used to conveniently decorate the lookup of IStripes in an ITable. It serves as a factory for predefined LookupDecorator<TDecoratedType,TInterface> instances that are specifically useful for the IStripe type.
Type Parameters
- TStripe: IStripe
Type Details
- yFiles module
- view
See Also
Constructors
Initializes a new instance of the StripeDecorator<T> class.
Parameters
A map of options to pass to the method.
- interfaceType - Constructor<TStripe>
- decorator - ILookupDecorator
- The decorator to use.
Properties
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IEditLabelHelper type for the TStripes this instance has been created for.
Remarks
Property Value
Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IStripeInputRenderer type for the type of items this instance has been created for.
Remarks
Custom IStripeInputRenderer implementations can be used to change the way the look of an item is represented during the default interactions in a CanvasComponent. This interface is mainly used by the TableEditorInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the ITable's lookup.
Implementations of IStripeInputRenderer will be passed a StripeInputRenderTag as render tag.
Property Value
TModelItem interface this instance uses as the generic type parameter.Gets a LookupDecorator<TDecoratedType,TInterface> that decorates the IPositionHandler type for the type of items this instance has been created for.
Remarks
Property Value
TModelItem interface this instance uses as the generic type parameter.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(TStripe, 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(TStripe, Constructor, IContextLookup):any
- The generic callback to add to the lookup chain.
Signature Details
function(arg1: TStripe, arg2: Constructor, arg3: IContextLookup) : anyEncapsulates a method that has three parameters and returns a value of the type specified by theTResultparameter.Parameters
- arg1 - TStripe
- 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<TStripe,TInterface>Creates a LookupDecorator<TDecoratedType,TInterface> for TStripes 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<TStripe,TInterface>
- A new LookupDecorator<TDecoratedType,TInterface> for the specified interface.
Removes an IContextLookupChainLink that has been added by one of the various decorators for stripes.
Parameters
A map of options to pass to the method.
- link - IContextLookupChainLink
- The lookup chain link to remove.