Installs visual representations of items in a CanvasComponent.
Inheritance Hierarchy
Remarks
This interface is most prominently used by ModelManager<T> and its descendants to manage visuals in the canvas.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.ICanvasObjectInstaller
See Also
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
options - Object
A map of options to pass to the method.
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
Static Methods
create
(addCanvasObject: function(ICanvasContext, ICanvasObjectGroup, any):ICanvasObject) : ICanvasObjectInstallerCreates an implementation of the interface ICanvasObjectInstaller by using the given function as implementation for its addCanvasObject method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- addCanvasObject - function(ICanvasContext, ICanvasObjectGroup, any):ICanvasObject
- A function for ICanvasObjectInstaller's single abstract method addCanvasObject.
Returns
- ↪ICanvasObjectInstaller
- An instance of the ICanvasObjectInstaller interface based on the given function.