documentationfor yFiles for HTML 3.0.0.3

LabelDecorator

Helps in decorating the lookup method of ILabel instances by providing access to decorators for the most common types.

Inheritance Hierarchy
LabelDecorator

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

Properties

Methods