Base class for Visuals that use an HTMLCanvasElement for the visualization to render into a CanvasRenderingContext2D.
Inheritance Hierarchy
Visual
HtmlCanvasVisual
Remarks
Note that instances of this class cannot be used anywhere where a Visual is required. The visualization is implemented by the render method. This means that this kind of visual does not work in a SvgVisualGroup and wrapping the visual will not work as there is no SVGElement that could be put into another SVG container. These kind of visuals can be used at the top-level of a CanvasComponent's IRenderTreeElements, only.
Type Details
- yFiles module
- view
See Also
Methods
Paints onto the context using HTML Canvas operations.
Remarks
Implementations should not destroy the context's state, but should make sure to restore the state to the previously active state. This is especially true for the transformation and clip.
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 HTML Canvas context to use for rendering.