API REFERENCE

GridChartEvent

Fields, allowed values, and APIs that use GridChartEvent.

Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

typescript
export type GridChartEvent =
  | (GridChartEventSpine & {
    readonly type: 'created';
    readonly chartType: SyChartConcreteType;
    readonly projection: GridChartProjectionKind;
    readonly source: GridChartModelSource;
  })
  | (GridChartEventSpine & {
    readonly type: 'rangeChanged';
    readonly source: GridChartModelSource;
    readonly previousSource: GridChartModelSource;
  })
  | (GridChartEventSpine & {
    readonly type: 'optionsChanged';
    readonly options: GridChartOptions;
    readonly changedKeys: readonly GridChartOptionKey[];
  })
  | (GridChartEventSpine & {
    readonly type: 'destroyed';
    readonly cause: GridChartDestroyCause;
  });

Contracts containing this type