An abstract base class for the ISelectionIndicatorInstaller, IFocusIndicatorInstaller and IHighlightIndicatorInstaller implementations that draws an oriented rectangle using a template.
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.OrientedRectangleIndicatorInstaller
See Also
Constructors
Initializes a new instance of the OrientedRectangleIndicatorInstaller class without fixed bounds.
Remarks
Initializes a new instance of the OrientedRectangleIndicatorInstaller class with fixed bounds and a string.
Remarks
The given IOrientedRectangle is used for all items as object that is added to the ICanvasObjectGroup in the addCanvasObject method.
If the template property is not set, the templateKey is used to lookup a IVisualTemplate in the resources of the CanvasComponent. If there is none, a default template is used.
Properties
Gets or sets the IVisualTemplate to use for this indicator.
Remarks
Methods
This the main method of the interface that performs the installation of an item's visual representation in the canvas by adding ICanvasObjects.
Parameters
A map of options to pass to the method.
- context - ICanvasContext
- The context that contains the information required to install the visual representation.
- group - ICanvasObjectGroup
- The canvas object group to add the newly generated ICanvasObject to.
- item - Object
- The item to install.
Returns
- ↪ICanvasObject
- The newly generated ICanvasObject for the item's visual representation.
nullif nothing was installed.
See Also
Implements
Factory method that returns an IOrientedRectangle for a given user object.
Remarks
This method is called for the object to add to the ICanvasObjectGroup, if there are no fixed bounds set on this instance (i.e. the parameterless constructor was used to instantiate this class).
This implementation returns null for every given object.
Returns
See Also
Constants
A string that will be used to find the IVisualTemplate for drawing the focus indicator.
Remarks
yfiles-focus-template and yfiles-label-focus-template CSS classes.See Also
A string that will be used to find the IVisualTemplate for drawing the highlight indicator.
Remarks
yfiles-highlight-template and yfiles-label-highlight-template CSS classes.See Also
A string that will be used to find the IVisualTemplate for drawing the selection indicator.
Remarks
yfiles-selection-template and yfiles-label-selection-template CSS classes.