C

WebGLShapeNodeStyle

Show Usages
A node style for geometric shapes for use in WebGL2 rendering.
Implements
Inheritance Hierarchy

Remarks

Note that unlike other INodeStyle implementations, this class is immutable. All properties are read-only and immutable, and the class cannot be subclassed, either.

See Also

API

WebGLImageNodeStyle, WebGLGroupNodeStyle

Members

No filters for this type

Constructors

WebGLShapeNodeStyle

(
shape?: WebGLShapeNodeShape
fill?: Color
stroke?: WebGLStroke
effect?: WebGLEffect
keepIntrinsicAspectRatio?: boolean
zoomVisibilityPolicy?: WebGLZoomVisibilityPolicy
)
Creates a new shape node style that is rendered with WebGL2.

This style can be applied to nodes that are rendered by the WebGLGraphModelManager. The preferred way of calling the constructor is using option arguments, as there are many defaults and optional arguments.

To use the default value for a color option, set it to null.

Parameters

shape?: WebGLShapeNodeShape
conversion
The shape of the node. Defaults to WebGLShapeNodeShape.ELLIPSE.
fill?: Color
conversion
The background color of the node. Defaults to Color.WHITE.
stroke?: WebGLStroke
conversion
The border color of the node. Defaults to Color.BLACK.
effect?: WebGLEffect
conversion
The effect around the node. Defaults to WebGLEffect.NONE.
keepIntrinsicAspectRatio?: boolean
Whether to keep the intrinsic aspect ratio of the shape.
zoomVisibilityPolicy?: WebGLZoomVisibilityPolicy
The zoom visibility policy. Defaults to null.

Properties

effect

: WebGLEffect
readonly
Gets the set of applied effects on this style.
readonlyfinal

fill

: Color
readonly
Gets the fill color for the shape background.
readonlyfinal

keepIntrinsicAspectRatio

: boolean
readonly
Gets a value indicating whether to keep the intrinsic aspect ratio of the shape.
The default value is false.
readonlyfinal

renderer

: INodeStyleRenderer
readonly
Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given node and this style instance.
The idiom for retrieving, e.g. an IVisualCreator implementation for a given style is:
const creator = style.renderer.getVisualCreator(node, style)
const visual = creator.createVisual(context)
readonlyfinal

shape

: WebGLShapeNodeShape
readonly
Gets the shape of the style.
readonlyfinal

stroke

: WebGLStroke
readonly
Gets the stroke around the shape.
readonlyfinal

zoomVisibilityPolicy

: WebGLZoomVisibilityPolicy
readonly
Gets the zoom visibility policy or null if no policy is set.
Note that WebGLZoomVisibilityPolicy is bound to a specific CanvasComponent instance and cannot be shared across multiple CanvasComponents. Therefore, when using this style with multiple CanvasComponents, a separate instance of this style must be created for each CanvasComponent, each configured with a dedicated WebGLZoomVisibilityPolicy instance.
readonlyfinal

Methods

clone

(): Object
Create a clone of this object.
final

Return Value

Object
A clone of this object.