ng2-qgrid/core/selection/selection.model.d.ts

Angular Grid

import { Resource } from '../resource/resource';
import { ColumnModel } from '../column-type/column.model';

/**
 * A class that allows to control selection function of the q-grid.
 *
 * ### Suggested Links
 *
 * * [Scroll View](/doc/api/scroll-view.html)
 * * [selection.service.js](https://github.com/qgrid/ng2/blob/master/core/selection/selection.service.js)
 */
export declare interface SelectionModel {
	/**
	 * Controls if click on the q-grid body should select row or not.
	 *
	 * * `'body'` click on the q-grid body leads to row select/unselect.
	 * * `'custom'` only select checkbox click leads to row select/unselect.
	 */
	area?: 'custom' | 'body';

	/**
	 * Selection primitive.
	 *
	 * * `'row'` user can select rows by clicking on checkboxes or q-grid body area.
	 * * `'cell'` `default` user can select cells clicking on the q-grid body area.
	 * * `'column'` user can select columns by clicking on the q-grid body area.
	 * * `'mix'` user can select both rows and cells, rows are selectable by clicking on row-indicator column.
	 */
	unit?: 'row' | 'cell' | 'column' | 'mix';

	/**
	 * Selection mode.
	 *
	 * * `'single'`
	 * * `'multiple'`
	 * * `'range'`
	 */
	mode?: 'single' | 'multiple' | 'range';

	/**
	 * List of selected items.
	 */
	items?: any[];

	/**
	 * Set of map function, that can convert column and row to nessesary format.
	 *
	 * * `'column'` custom column key will be stored in the items property.
	 * * `'row'` custom row id will be stored in the items property.
	 */
	key?: {
		row: (row: any) => any,
		column?: (column: ColumnModel) => any
	};

	/**
	 * Keyboard shortcuts to control selection behavior. Changed.
	 */
	shortcut?: {[key: string]: string};
}