Function getFilterColumns

getFilterColumns(
    client: Client,
    parameters: { id: string },
    options?: RequestOptions,
): Promise<
    {
        columnConfig?: | string & {}
        | "NONE"
        | "SYSTEM"
        | "EXPLICIT"
        | "FILTER"
        | "USER";
        columnLayoutItems?: {
            columnHeadingKey?: string;
            id?: string;
            navigableField?: {
                columnCssClass?: string;
                columnHeadingKey?: string;
                defaultSortOrder?: string;
                hiddenFieldId?: string;
                id?: string;
                name?: string;
                nameKey?: string;
                valueLoader?: { comparator?: (...)
                | (...); [key: string]: unknown };
                [key: string]: unknown;
            };
            position?: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
Returns the default columns for the given filter. Currently logged in user will be used as the user making such request.
Parameters
- client: Client
- parameters: { id: string }
  - id: string
    
    The filter id.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        columnConfig?: | string & {}
        | "NONE"
        | "SYSTEM"
        | "EXPLICIT"
        | "FILTER"
        | "USER";
        columnLayoutItems?: {
            columnHeadingKey?: string;
            id?: string;
            navigableField?: {
                columnCssClass?: string;
                columnHeadingKey?: string;
                defaultSortOrder?: string;
                hiddenFieldId?: string;
                id?: string;
                name?: string;
                nameKey?: string;
                valueLoader?: { comparator?: (...)
                | (...); [key: string]: unknown };
                [key: string]: unknown;
            };
            position?: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
- Defined in src/server/api/filters.ts:160

Function getFilterColumns

Parameters

id: string

Settings