IgxGridStateDirective

new IgxGridStateDirective(): IgxGridStateDirective

Returns IgxGridStateDirective

Event emitted when set state is called with a string. Returns the parsed state object so that it can be further modified before applying to the grid.

this.state.stateParsed.subscribe(parsedState => parsedState.sorting.forEach(x => x.strategy = NoopSortingStrategy.instance()});
stateParsed: EventEmitter<IGridState>

Defined in projects/igniteui-angular/grids/core/src/state.directive.ts:78

An object with options determining if a certain feature state should be saved.

<igx-grid [igxGridState]="options"></igx-grid>
public options = {selection: false, advancedFiltering: false};
get options(): IGridStateOptions

Defined in projects/igniteui-angular/grids/core/src/state.directive.ts:21

Returns IGridStateOptions

An object with options determining if a certain feature state should be saved.

<igx-grid [igxGridState]="options"></igx-grid>
public options = {selection: false, advancedFiltering: false};
set options(value: IGridStateOptions): void

Defined in projects/igniteui-angular/grids/core/src/state.directive.ts:25

Parameters

Returns void

Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the options property.

getState(serialize: boolean, features: keyof IGridStateOptions | keyof IGridStateOptions[]): string | IGridState

Defined in projects/igniteui-angular/grids/core/src/state.directive.ts:44

Parameters

Returns string | IGridState

Restores grid features' state based on the IGridState object passed as an argument.

setState(state: string | IGridState, features: keyof IGridStateOptions | keyof IGridStateOptions[]): void

Defined in projects/igniteui-angular/grids/core/src/state.directive.ts:62

Parameters

Returns void