syidaxgrid
Home Pricing Settings

API REFERENCE

GridFieldPath

Fields, allowed values, and APIs that use GridFieldPath.

Markdown source Features

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 GridFieldPath<TData> =
  string extends keyof TData
    ? string
    : {
        [K in StringKey<TData>]:
          | K
          | (NestedObject<TData[K]> extends never
            ? never
            : `${K}.${GridFieldPathLevel2<NestedObject<TData[K]>>}`);
      }[StringKey<TData>];

APIs using this type

  • field

    Required field path for reading a value from source rows. Use the data key, not a display heading.

  • tooltipField

    Source data field used for tooltips.

Contracts containing this type