API REFERENCE

SyGridFullWidthRenderer

Fields, allowed values, and APIs that use SyGridFullWidthRenderer.

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 interface SyGridFullWidthRenderer<TData = GridData> {
  readonly mode?: SyGridFullWidthMode;
  readonly create: (params: SyGridFullWidthRenderParams<TData>) => HTMLElement | { readonly gui: HTMLElement };
  readonly refresh?: (instance: HTMLElement | { readonly gui: HTMLElement }, params: SyGridFullWidthRenderParams<TData>) => boolean;
  readonly destroy?: (instance: HTMLElement | { readonly gui: HTMLElement }, params: SyGridFullWidthRenderParams<TData>) => void;
}

APIs using this type