Skip to main content

api.getReactiveState()

Description​

Gets the state object with the reactive properties of the Grid

Usage​

api.getReactiveState(): object;

Returns​

The method returns an object with the following parameters:

  { 
   columns: array, // an array with columns data
   data: array, // an array with data for the table
   dynamic: object, // an object with the number of rows in a dynamic dataset
   editor: object,// an object with data for the open editor
   filter: (obj: any) => boolean, // the filtering function; the filter-rows action handler
   scroll: object, // on object with the scroll configuration
   selected: string | number, // the id of the selected row
   selectedRows: array, // an object with the ids of the selected rows
   sizes: object, // an object with the table sizes configuration
   sort: object,  // an object with the sorting configuration
   split: number, // the number of frozen columns
   tree: boolean, // tree structure state
   flatData: array // actual data;in case of tree structure,it's a plain dataset with the "level" marker to specify each item's level in hierarchy  
  }

The Grid properties detailed description you can find here: Grid properties overview.

Example​

To get the current value from the Store, add $ before the variable:

const { data, columns } = getData();

export default function App() {
    const api = useRef(null);
    let rSelected;

    if (api.current) {
        rSelected = api.current.getReactiveState().selected;
        console.log(rSelected); // outputs the currently selected row id
    }

    return (
        <Grid data={data} columns={columns} api={api} />
    );
}

Related articles: