InsightArray

Method summary

Methods

method

getDimension ( ) → {insight.enums.EntityDataDimension}

The dimension of this Array entity.

details

Returns:

returns table

Type	Description
type insight.enums.EntityDataDimension	The dimension of this Array entity

Example

examples

var arr = scenario.getArray('INTEGER_ARRAY');
arr.getDimension();

Back to Top

method

getIterator ( sortKeys ) → {InsightArrayIterator}

Retrieve an iterator for the Insight Array.

Parameters:

params

Name	Type	Argument	Default	Description
sortKeys	type boolean	optional	false	Flag to use default JavaScript sorting for keys

details

Returns:

returns table

Type	Description
type InsightArrayIterator	Iterator class for the InsightArray

Example

examples

var arr = scenario.getArray('INTEGER_ARRAY');
var iter = arr.getIterator();
while( var valueObject = iter.next() ) {
     var key = valueObject.key;
     var value = valueObject.value;
}

Back to Top

method

getKeys ( ) → {Array.<Array.<PrimitiveType>>}

Gets all the populated (composite) keys.

details

Returns:

returns table

Type	Description
type Array.<Array.<PrimitiveType>>	An array of the composite keys which can be used to fetch values with getValue( compositeKey )

Example

examples

var arr = scenario.getArray('INTEGER_ARRAY');
var keys = arr.getKeys();

Back to Top

method

getName ( ) → {string}

The name of this Array entity.

details

Returns:

returns table

Type	Description
type string	The name of this Array entity

Example

examples

var arr = scenario.getArray('INTEGER_ARRAY');
arr.getName();

Back to Top

method

getValue ( key ) → {PrimitiveType|null|undefined}

Gets the value of the element with the given indices.

Parameters:

params

Name	Type	Description
key	type Array.<PrimitiveType> | PrimitiveType	The indices of the array element

details

Returns:

returns table

Type	Description
type PrimitiveType | null | undefined	The value for this key (which can be null), or undefined if the array does not contain the key

Example

examples

array.getValue(["x1", 2, false]);

Back to Top

method

size ( ) → {number}

The size of the array.

details

Returns:

returns table

Type	Description
type number	The size of the array

Example

examples

array.size();

Back to Top

method

toObjectArray ( ) → {Array.<Object.<{key: (Array.<PrimitiveType>|PrimitiveType), value: PrimitiveType}>>}

Converts the Insight Array into an array of plain javascript objects.

details

Returns:

returns table

Type	Description
type Array.<Object.<{key: (Array.<PrimitiveType>|PrimitiveType), value: PrimitiveType}>>	An array of items.

Example

examples

var arr = scenario.getArray('ARRAY1');
arr.toObjectArray(); // e.g. [{key: ['x1', 'y1'], value: '1,1'}, {key: ['x1', 'y2'], value: '1,2'}]

Back to Top