An IVisualCreator for use in a CanvasComponent that renders a IGraph instance in a sloppy overview style.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.GraphOverviewSvgVisualCreator
See Also
Constructors
Creates a new instance for the given graph.
Properties
Gets or sets the overview edge style.
See Also
Gets or sets the overview group node style.
See Also
Gets or sets the overview node style.
See Also
Methods
This method is called by the framework to create a Visual that will be included into the IRenderContext.
Remarks
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context that describes where the visual will be used.
Returns
- ↪Visual
- The visual to include in the canvas object visual tree. This may be
null.
See Also
Implements
Returns and/or configures a edge style for the given edge to render.
Parameters
A map of options to pass to the method.
- edge - IEdge
- The edge to render.
Returns
- ↪IEdgeStyle
- The style or
nullif no visualization should be drawn.
See Also
Obtains the IVisualCreator for the given edge.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context.
- edge - IEdge
- The edge.
Returns
- ↪IVisualCreator
- The visual creator that is obtained from the getEdgeStyle's getVisualCreator method.
See Also
Returns and/or configures a group node style for the given node to render.
Parameters
A map of options to pass to the method.
- node - INode
- The group node to render.
Returns
- ↪INodeStyle
- The style or
nullif no visualization should be drawn.
See Also
Obtains the IVisualCreator for the given group node.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context.
- node - INode
- The group node.
Returns
- ↪IVisualCreator
- The visual creator that is obtained from the getGroupNodeStyle's getVisualCreator method.
See Also
Returns and/or configures a node style for the given node to render.
Parameters
A map of options to pass to the method.
- node - INode
- The node to render.
Returns
- ↪INodeStyle
- The style or
nullif no visualization should be drawn.
See Also
Obtains the IVisualCreator for the given node.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context.
- node - INode
- The node.
Returns
- ↪IVisualCreator
- The visual creator that is obtained from the getNodeStyle's getVisualCreator method.
See Also
This method updates or replaces a previously created Visual for inclusion in the IRenderContext.
Remarks
The CanvasComponent uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to createVisual. Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.
I most cases oldVisual is a visual instance that has been returned by the createVisual method of this instance. This is, however, not guaranteed. Implementations have to be aware of this.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context that describes where the visual will be used in.
- oldVisual - Visual
- The visual instance to be updated.
Returns
- ↪Visual
oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.