API REFERENCE

CanonicalRangeChange

Fields, allowed values, and APIs that use CanonicalRangeChange.

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 CanonicalRangeChange =
  | { readonly kind: 'added'; readonly id: number; readonly range: CanonicalRange }
  | { readonly kind: 'extended'; readonly id: number; readonly range: CanonicalRange }
  | {
      readonly kind: 'subtracted';
      readonly id: number;
      readonly range: CanonicalRange;
      readonly sourceId: number;
    }
  | { readonly kind: 'removed'; readonly id: number; readonly range: CanonicalRange };

Contracts containing this type