API REFERENCE
GridColumnGroupRef
Fields, allowed values, and APIs that use GridColumnGroupRef.
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.
export interface GridColumnGroupRef<
TData = GridData,
TContext = unknown,
> extends GridLiveRef<TData> {
readonly id: string;
getDefinition(): Readonly<GridColumnGroupDef<TData, TContext>> | null;
getChildren(): ReadonlyArray<
GridColumnRef<TData, unknown, TContext> | GridColumnGroupRef<TData, TContext>
>;
getLeafColumns(): ReadonlyArray<GridColumnRef<TData, unknown, TContext>>;
getParent(): GridColumnGroupRef<TData, TContext> | null;
isExpanded(): boolean;
isPadding(): boolean;
isDisplayed(): boolean;
setExpanded(expanded: boolean): Promise<boolean>;
}APIs using this type
- getColumnGroup
Finds a current column group by ID. Returns null if absent.
- getColumnGroups
Reads current column group objects.