documentation.md

Table of Contents

• data
  • Parameters
• removeObject
  • Parameters
• actionFactory
  • Parameters
• action
  • Parameters
• shallowEqual
  • Parameters
• getTitleOf
  • Parameters
• getRecordsOf
  • Parameters
• sliceAtIndex
  • Parameters
• expanded
  • Parameters
• expandObject
  • Parameters
• indexOfObjectShallow
  • Parameters
• includesObjectShallow
  • Parameters
• hasRecords
  • Parameters

data

Data reducer containing data for visualization

Parameters

• state Array input state (optional, default [])
• action Object state modifier

Returns Object new state or current state if action undefined

removeObject

Will dispatch object telling to remove object from store

Parameters

• value Object Value to be dispatched, removed from data store

Returns Object redux action object

actionFactory

Will create factory for factory of redux actions

Parameters

• args ...string arguments you would like final functions to have

Returns Function factory with action type as argument

action

Will create redux action with value argument

Parameters

• type string arguments you would like final functions to have

Returns Function to trigger redux action

shallowEqual

Will compare keys and values of two objects

Parameters

• object1 Object First object to compare (optional, default {})
• object2 Object Second object to compare (optional, default {})

Returns Boolean true if keys and values of objects are equal

getTitleOf

Will return title of kids object

Parameters

• kids Object Kids object

Returns String Title of kids object

getRecordsOf

Will return records of kids if it has some

Parameters

• kids Object Kids object

Returns Array Records in kids object

sliceAtIndex

Will remove object from array at specified index

Parameters

• array Array Array of items
• index Number Intex of item to remove

Returns Array New array of objects

expanded

Store containing currently expanded objects

Parameters

• state Array input state (optional, default [])
• action Object state modifier

Returns Object new state or current state if action undefined

expandObject

Will dispatch object telling to expand an object

Parameters

• value Object Value to be dispatched, expanded in visualization

Returns Object redux action object

indexOfObjectShallow

Will try to find index of object in array by shallow comparing

Parameters

• array Array Array of objects
• object Object Object to find in the array

Returns Number index of found object or -1

includesObjectShallow

Will check array if IT contains the object by shallow comparing the objects

Parameters

• array Array Array of objects
• object Object Object to find in the array

Returns Boolean returns true if object is included

hasRecords

Will check whenever kids are present

Parameters

• kids Object Kids object

Returns Boolean true if kids are present