StringArray

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

Introduction

Points and cells may sometimes have associated data that are stored as strings, e.g. labels for information visualization projects. This class provides a clean way to store and access those strings.

Methods

extend

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

getComponent

Get the data component at the location specified by tupleIdx and compIdx.

Argument	Type	Required	Description
tupleIdx	Number	Yes
compIdx	Number	No

getData

getDataType

getName

getNumberOfComponents

getNumberOfTuples

getNumberOfValues

getTuple

Argument	Type	Required	Description
idx	Number	Yes
tupleToFill	Array[String]	No

getTupleLocation

Argument	Type	Required	Description
idx	Number	No

getValue

Get the value at a flat array index.

newClone

newInstance

Method used to create a new instance of vtkStringArray

Argument	Type	Required	Description
initialValues	IStringArrayInitialValues	Yes	for pre-setting some of its content

setComponent

Set the data component at the location specified by tupleIdx and compIdx to value. Note that i is less than NumberOfTuples and j is less than NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).

Argument	Type	Required	Description
tupleIdx	Number	Yes
compIdx	Number	Yes
value	String	Yes

setData

Argument	Type	Required	Description
array	Array[String]	Yes
numberOfComponents	Number	Yes

setName

setValue

Set the value at a flat array index.