API REFERENCE
GridColumnRef
GridColumnRef의 필드와 허용 값, 이 타입을 사용하는 API입니다.
타입 정의
물음표(?)는 선택 항목이고 readonly는 직접 변경하지 않는 값입니다. 유니온(|)은 허용된 형태 중 하나를 뜻합니다. 함수는 해당 시점에 Grid가 호출할 콜백입니다.
export interface GridColumnRef<
TData = GridData,
TValue = unknown,
TContext = unknown,
> extends GridLiveRef<TData, TValue> {
readonly id: string;
getDefinition(): Readonly<ColumnDef<TData, TValue, TContext>> | null;
getActualWidth(): number | null;
isVisible(): boolean;
getPinned(): 'left' | 'right' | null;
getSort(): GridColumnSortState | null;
getAggFunc(): string | null;
isPivotActive(): boolean;
getParent(): GridColumnGroupRef<TData, TContext> | null;
setWidth(width: number): Promise<boolean>;
setVisible(visible: boolean): Promise<boolean>;
setPinned(side: 'left' | 'right' | null): Promise<boolean>;
setSort(direction: 'asc' | 'desc' | null, options?: { multi?: boolean }): Promise<boolean>;
setAggFunc(name: string | null): Promise<boolean>;
getFilterModel(): Promise<unknown>;
setFilterModel(model: unknown | null): Promise<boolean>;
}이 타입을 사용하는 API
- getColumn
식별자로 현재 열 객체를 찾습니다. 없는 열은 null이며 초기 columnDefs 복사본이 아닌 현재 상태를 조회합니다.
- getColumns
현재 열 객체 목록을 읽습니다. 열 너비·순서·표시 상태를 앱과 연결할 때 사용합니다.