CanvasView

Source (.js)Source (.d.ts)

Introduction

vtkCanvasView provides a way to create a canvas view.

Methods

extend

Method used to decorate a given object (publicAPI+model) with vtkCanvasView characteristics.

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	ICanvasViewInitialValues	No	(default: {})

getCanvas

Get the canvas element

getCursor

Get the used cursor

getInteractive

getInteractor

Get the interactor

getRenderable

getRenderers

getRenderersByReference

getSize

Get the size of the canvas view

getSizeByReference

Get the size of the canvas view

getUseBackgroundImage

getUseOffScreen

isInViewport

newInstance

Method used to create a new instance of vtkCanvasView

Argument	Type	Required	Description
initialValues	ICanvasViewInitialValues	No	for pre-setting some of its content

setBackgroundImage

Argument	Type	Required	Description
backgroundImage	HTMLImageElement	Yes	The background image HTML element.

setCanvas

Argument	Type	Required	Description
canvas	HTMLCanvasElement	Yes	The canvas HTML element.

setContainer

Argument	Type	Required	Description
container	HTMLElement	Yes	The container HTML element.

setCursor

Argument	Type	Required	Description
cursor	String	Yes	The used cursor.

setInteractor

Argument	Type	Required	Description
interactor		Yes

setSize

Set the size of the canvas view.

Argument	Type	Required	Description
width	Number	Yes	The width of the canvas view.
height	Number	Yes	The height of the canvas view.

setSize

Set the size of the canvas view.

Argument	Type	Required	Description
size	Size	Yes	The size of the canvas view.

setSizeFrom

Set the size of the canvas view.

Argument	Type	Required	Description
size	Size	Yes	The size of the canvas view.

setUseBackgroundImage

Argument	Type	Required	Description
useBackgroundImage		Yes

setUseOffScreen

Argument	Type	Required	Description
useOffScreen		Yes

setViewStream

Argument	Type	Required	Description
viewStream		Yes

traverseAllPasses