cheetah-grid/src/js/ts-types/define.ts

Cheetah Grid is a high performance grid engine that works on canvas

/* eslint-disable @typescript-eslint/ban-types */
import type { ColorDef } from "./base";
import type { ListGridAPI } from "./grid-engine";

// ****** Column Icon Options *******
export interface FontIcon<T> {
  font?: string;
  content?: T extends object ? keyof T & string : string;
  className?: string;
  tagName?: string;
  isLiga?: boolean;
  width?: number;
  height?: number;
  color?: string;
  offsetTop?: number;
  offsetLeft?: number;
}

export interface ImageIcon<T> {
  src: T extends object ? keyof T & string : string;
  width?: number;
  height?: number;
}

export interface PathIcon<T> {
  path: T extends object ? keyof T & string : string;
  width: number;
  height: number;
  color?: string;
}

export interface SvgIcon<T> {
  svg: T extends object ? keyof T & string : string;
  width?: number;
  height?: number;
}

export interface NamedIcon<T> {
  name: T extends object ? keyof T & string : string;
  width?: number;
  height?: number;
}

export type ColumnIconOption<T> =
  | FontIcon<T>
  | ImageIcon<T>
  | PathIcon<T>
  | SvgIcon<T>
  | NamedIcon<T>;

// ****** Column Menu Items Options *******
export type ColumnMenuItemOptions =
  | ColumnMenuItemOption[]
  | SimpleColumnMenuItemOption[]
  | OldSimpleColumnMenuItemOption[]
  | string
  | ColumnMenuItemObjectOptions;
export interface ColumnMenuItemOption {
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  value: any;
  label: string;
  classList?: string[];
  html?: string;
}
export interface SimpleColumnMenuItemOption {
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  value: any;
  label: string;
}
/** @internal */
export interface OldSimpleColumnMenuItemOption {
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  value: any;
  caption: string;
}
export interface ColumnMenuItemObjectOptions {
  [value: string]: string;
}

// ****** Style Options *******
export type Visibility = "visible" | "hidden";

// ****** TextStyle Options *******
export type TextOverflow = "clip" | "ellipsis" | string /* a char */;
export type LineClamp = number | "auto";

// ****** Color Options *******
export interface StylePropertyFunctionArg {
  row: number;
  col: number;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  grid: ListGridAPI<any>;
  context: CanvasRenderingContext2D;
}

export type ColorPropertyDefine =
  | ColorDef
  | ((args: StylePropertyFunctionArg) => string)
  | ((args: StylePropertyFunctionArg) => CanvasGradient)
  | ((args: StylePropertyFunctionArg) => CanvasPattern)
  | ((
      args: StylePropertyFunctionArg
    ) => string | CanvasGradient | CanvasPattern | undefined);

export type ColorsPropertyDefine =
  | ColorPropertyDefine
  | (ColorDef | null)[]
  | ((args: StylePropertyFunctionArg) => (ColorDef | null)[]);

export type FontPropertyDefine =
  | string
  | ((args: StylePropertyFunctionArg) => string);

// ****** Indicator Options *******
export type IndicatorStyle = "triangle" | "none";
export type IndicatorObject = {
  style?: IndicatorStyle;
  color?: ColorDef;
  size?: number | string;
};
export type IndicatorDefine = IndicatorObject | IndicatorStyle;

// ****** TreeStyle Options *******

export type TreeLineStyle = "none" | "solid";
export type TreeBranchIconStyle = "chevron_right" | "expand_more" | "none";
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type TreeBranchIconStyleColumnIcon = ColumnIconOption<any>;
export type TreeBranchIconStyleDefine =
  | TreeBranchIconStyle
  | TreeBranchIconStyleColumnIcon
  | ((args: StylePropertyFunctionArg) => TreeBranchIconStyle)
  | ((args: StylePropertyFunctionArg) => TreeBranchIconStyleColumnIcon);