HighlightIndicatorManager<Textends ILookup>
A ModelManager<T> implementation that manages the visual decorations of highlighted elements in a canvas.
Remarks
For each item that should be highlighted this class uses the ILookup mechanism of the items to lookup an IHighlightIndicatorInstaller implementation which will do the actual installation of the decoration in the canvas.
See GraphHighlightIndicatorManager for a specialized subclass for graph items that uses item styles for the visualization.
Type Parameters
- T: ILookup
- The type of the items.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.HighlightIndicatorManager
See Also
Constructors
Creates a new instance.
Remarks
If a new HighlightIndicatorManager<T> instance of this is set to a GraphComponent's highlightIndicatorManager property, the old instance is uninstalled and the new instance is installed automatically.
If a new HighlightIndicatorManager<T> instance is not set via the highlightIndicatorManager property, it is important to call the install life-cycle method.
Properties
Gets the canvas instance this instance is managing.
Remarks
Defined in
Gets or sets whether this ModelManager<T> is enabled.
Remarks
If the manager is disabled, it will not install the ICanvasObjects into the associated CanvasComponent.
The default is true, i.e. this manager is enabled by default.
Defined in
Gets or sets the item collection that determines which items are highlighted.
Remarks
null, in which case no elements are considered highlighted.Methods
Adds another highlight.
Parameters
A map of options to pass to the method.
- item - T
- The item to highlight.
See Also
Installs an item and adds it to this managers set of managed items.
Remarks
Parameters
A map of options to pass to the method.
- item - T
- The item to add.
Returns
- ↪ICanvasObject
- The newly created canvas object or
nullif nothing was installed.
See Also
Defined in
Called by installItem to retrieve the installer for a given item.
Remarks
Parameters
A map of options to pass to the method.
- item - T
- The item to find a canvas object group for.
Returns
- ↪ICanvasObjectGroup
- An ICanvasObjectGroup or
null
See Also
Implements
Called by installItem to retrieve the installer for a given item.
Remarks
Parameters
A map of options to pass to the method.
- item - T
- The item to find an installer for.
Returns
- ↪ICanvasObjectInstaller
- An installer or
null
See Also
Implements
Installs this instance in the given CanvasComponent instance.
Remarks
If this manager instance is set to a CanvasComponent instance using one of the properties focusIndicatorManager, selectionIndicatorManager, or highlightIndicatorManager, this method is called automatically.
In all other cases, this method must be called before using this manager instance.
Overriders must either call the base implementation or set the canvasComponent.
Parameters
A map of options to pass to the method.
- canvas - CanvasComponent
- The CanvasComponent instance to install this manager instance in.
Throws
- Exception({ name: 'ArgumentError' })
- if
canvasisnull.
Overrides
Installs a member of the collection into the canvas using the ICanvasObjectDescriptor which is returned by getInstaller.
Parameters
A map of options to pass to the method.
- item - T
- The member to install.
Returns
- ↪ICanvasObject
- The canvas object that has been returned by the installer.
Defined in
Called when this manager gets disabled.
Called when this manager gets enabled.
Removes an item from the current highlight selection.
Parameters
A map of options to pass to the method.
- item - T
- The item whose highlight decorator will be removed.
See Also
Uninstalls the provided item and removes it from this managers set of managed items.
Parameters
A map of options to pass to the method.
- item - T
- The item to remove.
See Also
Defined in
Uninstalls this instance from the given CanvasComponent instance.
Remarks
If this manager instance has been set to a CanvasComponent instance using one of the properties focusIndicatorManager, selectionIndicatorManager, or highlightIndicatorManager, this method is called automatically when the property value is changed.
In all other cases, this method must be called when this manager instance is not used anymore.
Overriders must either call the base implementation or set the canvasComponent to null.
Parameters
A map of options to pass to the method.
- canvas - CanvasComponent
- The CanvasComponent to remove this manager instance from.
Overrides
Removes the given ICanvasObject.
Parameters
A map of options to pass to the method.
- canvasObject - ICanvasObject
- The canvas objects that have been associated with the descriptor.