ScenarioDataChange

Method summary

Methods

method

addToSet ( name, values, dimension ) → {ScenarioDataChange}

Add an element to the specified set.

Parameters:

params

Name	Type	Argument	Default	Description
name	type string			The name of the set entity
values	type PrimitiveType | Array.<PrimitiveType>			one or more new values to add to the set
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension to update

details

Returns:

returns table

Type	Description
type ScenarioDataChange	Returns the data change object so calls can be chained

Example

examples

var dataTracker = scenario.modify();
dataTracker.addToSet('SET_NAME', [99,100,101]).commit();

Back to Top

method

commit ( ) → {Promise}

Commit the changes applied to this scenario data change object.

details

Returns:

returns table

Type	Description
type Promise	Resolves once the scenario has been updated on the server. Rejected with an error object if and error is encountered in the data change request or on the server whilst saving the data.

Example

examples

var dataChange = scenario.modify();
// call some 'setX' methods to request data changes to happen
dataChange.commit();

Back to Top

method

removeFromArray ( name, indices, dimension ) → {ScenarioDataChange}

Remove elements in an Insight Array.

To remove a single element a single indices should be provided. To remove multiple elements, an array of indices should be provided.

Parameters:

params

Name	Type	Argument	Default	Description
name	type string			The name of the array entity
indices	type Array.<PrimitiveType> | Array.<Array.<PrimitiveType>>			The keys of the elements to delete, each key is an array of indices
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension to update

details

Returns:

returns table

Type	Description
type ScenarioDataChange	Returns the data change object so calls can be chained

Example

examples

scenario
     .modify()
     .removeFromArray('IntegerArrayEntity', [99]) // remove a single element from an array
     .removeFromArray('IntegerArrayEntity', [[99], [100], [104], [999]]) // remove several elements from an array
     .commit(); // send batch request

Back to Top

method

removeFromSet ( name, values, dimension ) → {ScenarioDataChange}

Removes an element from the specified set.

Parameters:

params

Name	Type	Argument	Default	Description
name	type string			The name of the set entity
values	type PrimitiveType | Array.<PrimitiveType>			one or more values to remove from the set
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension to update

details

Returns:

returns table

Type	Description
type ScenarioDataChange	Returns the data change object so calls can be chained

Back to Top

method

setArrayElement ( name, elements, dimension ) → {ScenarioDataChange}

Sets the values of elements in an Insight array.

Each element is specified as a structure comprising the key (indices) and the value.

To set a single element a single element should be provided. To set multiple elements, an array of elements should be provided.

Parameters:

params

Name	Type	Argument	Default	Description
name	type string			The name of the array entity
elements	type Array.<Object.<{key: Array.<PrimitiveType>, value: PrimitiveType, dimension: (insight.enums.EntityDataDimension|undefined)}>> | Object.<{key: Array.<PrimitiveType>, value: PrimitiveType, dimension: (insight.enums.EntityDataDimension|undefined)}>			Either a single array element or an array of the elements, comprising of their indices, value and dimension(optional)
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension to update

details

Returns:

returns table

Type	Description
type ScenarioDataChange	Returns the data change object so calls can be chained

Example

examples

scenario
     .modify()
     .setArrayElement('IntegerArrayEntity', {key: [99], value: 1000}) // add or overwrite an array element
     .commit(); // send batch request

Back to Top

method

setParameter ( name, value ) → {ScenarioDataChange}

Sets a parameter.

Parameters:

params

Name	Type	Description
name	type string	The parameter name
value	type string	A string representing the new value for the parameter

details

Returns:

returns table

Type	Description
type ScenarioDataChange	Returns the data change object so calls can be chained

Back to Top

method

setScalar ( name, value, dimension ) → {ScenarioDataChange}

Update a scalar value for the associated scenario.

Parameters:

params

Name	Type	Argument	Default	Description
name	type string			The name of the scalar entity
value	type string | number | boolean | null			The new scalar value
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension to update

details

Returns:

returns table

Type	Description
type ScenarioDataChange	Returns the data change object so calls can be chained

Example

examples

var scenarioDataChange = scenario.modify();
scenarioDataChange.setScalar('SCALAR_ONE', 25);

Back to Top