documentationfor yFiles for HTML 2.6

PrepareRenderContextEventArgs

The event arguments for the event handler used by raisePrepareRenderContextEvent

Inheritance Hierarchy

PrepareRenderContextEventArgs

Remarks

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

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.view.PrepareRenderContextEventArgs

See Also

CanvasComponent.addPrepareRenderContextListener

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.

Throws

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