Skip to content

VariantArray ​

Introduction ​

An array holding vtkVariants.

Methods ​

extend ​

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

ArgumentTypeRequiredDescription
publicAPIYesobject on which methods will be bounds (public)
modelYesobject on which data structure will be bounds (protected)
initialValuesIVariantArrayInitialValuesYes(default: {})

getComponent ​

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

ArgumentTypeRequiredDescription
tupleIdxNumberYes
compIdxNumberNo

getData ​

getDataType ​

getName ​

getNumberOfComponents ​

getNumberOfTuples ​

getNumberOfValues ​

getTuple ​

ArgumentTypeRequiredDescription
idxNumberYes
tupleToFillArray<any>No

getTupleLocation ​

ArgumentTypeRequiredDescription
idxNumberNo

getValue ​

Get the value at a flat array index.

newClone ​

newInstance ​

Method used to create a new instance of vtkVariantArray

ArgumentTypeRequiredDescription
initialValuesIVariantArrayInitialValuesYesfor 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()).

ArgumentTypeRequiredDescription
tupleIdxNumberYes
compIdxNumberYes
valueYes

setData ​

ArgumentTypeRequiredDescription
arrayArray<any>Yes
numberOfComponentsNumberYes

setName ​

setValue ​

Set the value at a flat array index.