TextActor

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

Introduction

vtkTextActor can be used to place text annotation into a window. Windows line endings (\r\n), Unix line endings (\n), and classic Mac line endings (\r) are all treated as multiline breaks.

Methods

extend

Method used to decorate a given object (publicAPI+model) with vtkActor 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	ITextActorInitialValues	No	(default: {})

getProperty

Get the property object that controls this actors properties.

Returns

Type	Description
vtkTextProperty	The vtkTextProperty instance.

makeProperty

Create a new property suitable for use with this type of TextActor.

Argument	Type	Required	Description
initialValues	ITextPropertyInitialValues	No	(default: {})

newInstance

Method used to create a new instance of vtkTextActor

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

setInput

Set the text to be displayed by the actor.

Argument	Type	Required	Description
input		Yes	The text to be displayed by the actor.

setProperty

Set the property object that controls this actors properties.

Argument	Type	Required	Description
property	vtkTextProperty	Yes	The vtkTextProperty instance.