A specialization of the HighlightIndicatorManager<T> class that delegates its work to WebGLGraphModelManager.
Remarks
Type Details
- yFiles module
- view
Constructors
Creates a new instance.
Remarks
Parameters
A map of options to pass to the method.
- nodeStyle - WebGLNodeIndicatorStyle | WebGLBeaconNodeIndicatorStyle
- The style to use for the node highlight rendering. This option sets the nodeStyle property on the created object.
- edgeStyle - WebGLEdgeIndicatorStyle
- The style to use for the edge highlight rendering. This option sets the edgeStyle property on the created object.
- nodeLabelStyle - WebGLLabelIndicatorStyle
- The style to use for the node label highlight rendering. This option sets the nodeLabelStyle property on the created object.
- edgeLabelStyle - WebGLLabelIndicatorStyle
- The style to use for the edge label highlight rendering. This option sets the edgeLabelStyle property on the created object.
Properties
Gets the canvas instance this instance is managing.
Remarks
Defined in
Gets or sets the model that describes the domain for the highlight.
Remarks
Defined in
Gets or sets the style to use for the edge label highlight rendering.
Gets or sets the style to use for the edge highlight rendering.
Gets or sets whether this ModelManager<T> is enabled.
Remarks
If the manager is disabled, it will not install the IRenderTreeElements into the associated CanvasComponent.
The default is true, i.e. this manager is enabled by default.
Property Value
true if enabled; false otherwise.Defined in
Gets or sets the item collection that determines which items are highlighted.
Defined in
Gets or sets the style to use for the node label highlight rendering.
Gets or sets the style to use for the node highlight rendering.
Methods
Installs an item and adds it to this manager's set of managed items.
Remarks
false, the item will not be installed.Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to add.
Returns
- ↪IRenderTreeElement?
- The newly created render tree element or
nullif nothing was installed.
Overrides
Called by installItem to retrieve the renderer for a given item.
Remarks
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to find a renderer for.
Returns
- ↪IObjectRenderer<IModelItem>?
- A renderer or
null
Implements
Called by installItem to retrieve the render tree group for a given item.
Remarks
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to find a render tree group for.
Returns
- ↪IRenderTreeGroup?
- An IRenderTreeGroup or
null
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
canvasComponentisnull.
Overrides
Installs a member of the collection into the canvas using the IObjectRenderer<T> which is returned by getRenderer.
Parameters
A map of options to pass to the method.
- item - IModelItem
- The member to install.
Returns
- ↪IRenderTreeElement?
- The new render tree element or
nullif the item was not installed.
Defined in
Called when this manager gets disabled.
Implements
Called when this manager gets enabled.
Implements
Uninstalls the provided item and removes it from this manager's set of managed items.
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to remove.
Overrides
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 IRenderTreeElement.
Parameters
A map of options to pass to the method.
- renderTreeElement - IRenderTreeElement
- The render tree element that has been associated with the renderer.