An IObjectRenderer<HandlesRenderTag> that draws collections of IHandle instances in a CanvasComponent.
Remarks
If renderMode is set to AUTO, this renderer automatically uses WebGL if WebGLGraphModelManager is set as graphModelManager, otherwise it uses SVG.
Type Details
- yFiles module
- view
Constructors
Creates a new instance with the optional renderMode.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderMode - RenderMode
- The mode used to render the handles. See the renderMode property for details.
Properties
Gets the mode used to render the handles.
Remarks
The default value is AUTO. In this case, this renderer automatically uses WebGL if WebGLGraphModelManager is set as graphModelManager, otherwise it uses SVG.
Methods
Returns an implementation of IBoundsProvider that can determine the visible bounds of the rendering of the render tag.
Remarks
This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called. This contract enables the use of the flyweight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderTag - HandlesRenderTag
- the render tag to query the bounds for
Returns
- ↪IBoundsProvider
- An implementation of IBoundsProvider to determine the bounds of the visualization.
Implements
Returns an implementation of IHitTestable that can determine whether the rendering of the render tag has been hit at a given coordinate.
Remarks
This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called. This contract enables the use of the flyweight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderTag - HandlesRenderTag
- the render tag to do the hit testing for
Returns
- ↪IHitTestable
- An implementation of IHitTestable to determine visibility.
Implements
Returns an implementation of IVisibilityTestable that can determine if the rendering of the render tag would be visible in a given context.
Remarks
This method may always return the same instance. By contract clients will not cache instances returned but will always call this method before the methods on the instance will be called. This contract enables the use of the flyweight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderTag - HandlesRenderTag
- the render tag to query visibility for
Returns
- ↪IVisibilityTestable
- An implementation of IVisibilityTestable to determine visibility.
Implements
Returns an implementation of IVisualCreator that will create the Visual tree for the render tag.
Remarks
This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called. This contract enables the use of the flyweight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderTag - HandlesRenderTag
- the render tag to create a Visual for
Returns
- ↪IVisualCreator
- An implementation of IVisualCreator to create or update the visualization.