API REFERENCE

ColumnDef

ColumnDef의 필드와 허용 값, 이 타입을 사용하는 API입니다.

타입 정의

물음표(?)는 선택 항목이고 readonly는 직접 변경하지 않는 값입니다. 유니온(|)은 허용된 형태 중 하나를 뜻합니다. 함수는 해당 시점에 Grid가 호출할 콜백입니다.

typescript
export interface ColumnDef<TData = GridData, TValue = unknown, TContext = unknown> {
  field: GridFieldPath<TData>;
  colId?: string;
  headerName?: string;
  headerTooltip?: string;
  sortable?: boolean;
  sort?: 'asc' | 'desc' | null;
  sortIndex?: number;
  filter?:
    | ColumnFilterDecl
    | string
    | GridFilterDefinition<TData, TValue, unknown, TContext>;
  valueGetter?: GridCallback<[ValueGetterParams<TData, TValue, TContext>], TValue> | string;
  formula?: string;
  valueFormatter?: GridCallback<[ValueFormatterParams<TData, TValue, TContext>], string> | string;
  tooltipField?: GridFieldPath<TData>;
  tooltipValueGetter?: GridCallback<[ValueGetterParams<TData, TValue, TContext>], unknown> | string;
  cellRenderer?:
    | string
    | CellRenderer<TData, TValue>
    | GridRendererDefinition<TData, TValue, TContext>;
  cellRendererMeta?: Record<string, unknown>;
  cellEditor?: GridCellEditorDeclaration<TData, TValue, TContext>;
  floatingFilterComponent?:
    | string
    | GridFloatingFilterDefinition<unknown, TContext>;
  cellClass?:
    | string
    | string[]
    | GridCallback<[CellCallbackParams<TData, TValue, TContext>], string>;
  cellClassRules?: Record<
    string,
    GridCallback<[CellCallbackParams<TData, TValue, TContext>], boolean> | string
  >;
  cellStyle?:
    | Record<string, string | number>
    | GridCallback<
        [CellCallbackParams<TData, TValue, TContext>],
        Record<string, string | number> | null | undefined
      >
    | ReadonlyArray<
        | Record<string, string | number>
        | GridCallback<
            [CellCallbackParams<TData, TValue, TContext>],
            Record<string, string | number> | null | undefined
          >
      >;
  width?: number;
  minWidth?: number;
  maxWidth?: number;
  flex?: number;
  resizable?: boolean;
  reorderable?: boolean;
  pinned?: 'left' | 'right' | null;
  columnGroupShow?: 'open' | 'closed';
  aggFunc?: 'sum' | 'avg' | 'min' | 'max' | 'count' | string;
  hidden?: boolean;
  hide?: boolean;
  editable?: boolean;
  editor?: 'text' | 'number' | 'date' | 'select' | 'checkbox' | 'textarea' | 'autocomplete' | 'largeText';
  valueParser?: GridCallback<[ValueParserParams<TData, TValue, TContext>], TValue>;
  valueSetter?: GridCallback<
    [ValueSetterParams<TData, TValue, TContext>],
    boolean | void
  >;
  comparator?: GridCallback<[TValue, TValue, Readonly<TData>, Readonly<TData>], number>;
  options?: ReadonlyArray<{ value: unknown; label: string; disabled?: boolean }>;
  min?: number | Date | string;
  max?: number | Date | string;
  step?: number;
  decimals?: number;
  nullable?: boolean;
  allowEmpty?: boolean;
  storeAs?: 'date' | 'iso';
  rows?: number;
  maxRows?: number;
  cols?: number;
  maxLength?: number;
  rowDrag?: boolean;
  wrapText?: boolean;
  autoHeight?: boolean;
  rowSpan?: (params: SyGridRowSpanParams<TData>) => number;
  colSpan?: (params: SyGridColSpanParams<TData>) => number;
}

이 타입을 사용하는 API

이 타입을 포함하는 계약