An IObjectRenderer<IGraph> for use in a CanvasComponent that renders an IGraph instance in an abstract, schematic overview style.
Remarks
This implementation uses a HtmlCanvasVisual for drawing the overview graph. The graph elements' visual appearance can be customized by overriding paintNode, paintGroupNode, or paintEdge.
Type Details
- yFiles module
- view
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 - IGraph
- 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 - IGraph
- 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 - IGraph
- 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.
Returns
- ↪IVisualCreator
- An implementation of IVisualCreator to create or update the visualization.
Implements
Callback that paints the specified edge.
Remarks
Does nothing if the edge's style is VOID_EDGE_STYLE.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderContext - IRenderContext
- The render context of the CanvasComponent.
- ctx - CanvasRenderingContext2D
- The canvas context to use for painting.
- edge - IEdge
- The edge to be painted.
Callback method that paints the specified node.
Remarks
Does nothing if the group node's style is VOID_NODE_STYLE.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderContext - IRenderContext
- The render context of the CanvasComponent.
- ctx - CanvasRenderingContext2D
- The canvas context to use for painting.
- node - INode
- The group node to be painted.
Callback method that paints the specified node.
Remarks
Does nothing if the node's style is VOID_NODE_STYLE.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- renderContext - IRenderContext
- The render context of the CanvasComponent.
- ctx - CanvasRenderingContext2D
- The canvas context to use for painting.
- node - INode
- The node to be painted.