Module: GenericBehaviour

This is the base class has all the common functionalities needed for all behavioural actions. Any other behavioural action needs to extend this class.
Source:

Methods

dispatch(payload) → {Array}

Returns entry and exit set information. This method is called by firebolt when ```dispatchBehaviour``` is called dynamically or when any physical action is triggered on the chart.
Parameters:
Name Type Description
payload Object Payload information.
Properties
Name Type Description
criteria Object | Array Identifiers of data interacted with.
Source:
Returns:
Entry and exit set information.
Type
Array

setSelectionSet(addSet, selectionSet) → {GenericBehaviour}

Updates the selection set by adding uids to the instance of SelectionSet or removing them. SelectionSet keeps the information of which rows are in the entry set and exit set.
Parameters:
Name Type Description
addSet Array Array of row ids which got affected during interaction.
selectionSet SelectionSet Instance of selection set.
Source:
Returns:
Instance of behaviour.
Type
GenericBehaviour