documentationfor yFiles for HTML 3.0.0.2

PrepareRenderContextEventArgs

The event arguments for the event handler used by prepare-render-context

Inheritance Hierarchy

PrepareRenderContextEventArgs

Remarks

This event argument can be used to modify the context during exportContent and invalidate

Type Details

yFiles module: view

See Also

CanvasComponent.prepare-render-context

Constructors

PrepareRenderContextEventArgs

(context: IRenderContext)

Initializes a new instance of the PrepareRenderContextEventArgs class.

Parameters

options - Object
A map of options to pass to the method.

context - IRenderContext: The initial context which can be modified by the event handlers using the context property.

Properties

context

: IRenderContext

Gets or sets the context.

Property Value

The context that can be modified, wrapped, or exchanged by the event handlers. This value may not be null.

Throws

Exception({ name: 'ArgumentError' }): If the argument is null.