AnnotatedCubeActor

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

Introduction

All propertyObjects may have any of the following keys:

• text: the face text (default “”)
• faceColor: the face color (default “white”)
• faceRotation: the face rotation, in degrees (default 0)
• fontFamily: the font family to use (default Arial)
• fontColor: the font color (default “black”)
• fontStyle: the CSS style for the text (default “normal”)
• fontSizeScale: A function that takes the face resolution and returns the pixel size of the font (default (resolution) => resolution / 1.8)
• edgeThickness: the face edge/border thickness, which is a fraction of the cube resolution (default 0.1)
• edgeColor: the color of each face’s edge/border (default “white”) resolution: the pixel resolution of a face, i.e. pixel side length (default 200) If a key is not specified, then the default value is used.

Methods

extend

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

newInstance

Method use to create a new instance of vtkAnnotatedCubeActor

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

setDefaultStyle

Set the default style.

Argument	Type	Required	Description
style	IStyle	Yes

setXMinusFaceProperty

The -X face property.

Argument	Type	Required	Description
prop	IFaceProperty	Yes	The -X face property.

setXPlusFaceProperty

The +X face property.

Argument	Type	Required	Description
prop	IFaceProperty	Yes	+X face property

setYMinusFaceProperty

The -Y face property.

Argument	Type	Required	Description
prop	IFaceProperty	Yes	The -Y ace property.

setYPlusFaceProperty

The +Y face property.

Argument	Type	Required	Description
prop	IFaceProperty	Yes	The +Y face property.

setZMinusFaceProperty

The -Z face property.

Argument	Type	Required	Description
prop	IFaceProperty	Yes	The -Z face property.

setZPlusFaceProperty

The +Z face property.

Argument	Type	Required	Description
prop	IFaceProperty	Yes	The +Z face property.