Type Alias MappingRecordType

MappingRecordType: {
    exportable?: boolean;
    filterable?: {
        active: boolean;
        filterKey?: string;
        titleOverride?: string;
        type?: string;
    };
    formatter?: AllFormatterConfigTypes;
    middleware?: ((data: any) => any);
    orderable?: boolean;
    orderKey?: string;
    selectable?: boolean;
    title: string;
    visible?: boolean;
    width?: string;
}

Type declaration

  • Optionalexportable?: boolean

    If its true or not set, the column is exportable and will be added in the export file. If false, the column is not exportable.

  • Optionalfilterable?: {
        active: boolean;
        filterKey?: string;
        titleOverride?: string;
        type?: string;
    }

    If set, the column is filterable. If false, the column is not filterable.

    • active: boolean

      If true, the filter is active. If false, the filter is disabled for the field.

    • OptionalfilterKey?: string

      The key to send to the server. If not set, the key is the same as the field name. If set, the key is the value of the key. Useful when the server expects a different key as it serves in the DTO.

    • OptionaltitleOverride?: string

      If set, this title will be shown in the Search Panel. If not set, the title is the same as the field title defined in "title" key.

    • Optionaltype?: string

      The filter type. The filter type is used to determine the filter input field. The possible values are 'text', 'number', 'date', 'status'.

  • Optionalformatter?: AllFormatterConfigTypes

    The formatter configuration object for the column. The formatter is a special component to format the data in the cell. There are 9 types of formatters built-in: 'Boolean', 'DateTime', 'Highlighter', 'HTML', 'LongText', 'Operations', 'Status', 'Strong', 'Tailwind'. You can set the formatter type and the configuration object for the formatter. For example, a 'Strong' type of formatter makes the text bold in cell, and a 'DateTime' type of formatter formats the date. You can define your own custom formatter as well. Check the documentation 'Custom formatters' section for more information.

  • Optionalmiddleware?: ((data: any) => any)

    A function to modify the data after it gets from the server but before showing in the cell. This function is called before the data is shown in the cell. You can modify the data here. For example, you can format a date, or you can show a different value based on the raw data.

      • (data): any

      • Parameters

        • data: any

          The raw data of the cell

        Returns any

        The modified/formatted/tweaked data to show in the cell

  • Optionalorderable?: boolean

    If true, the column is orderable/sortable. If false, the column is not orderable/sortable.

  • OptionalorderKey?: string

    You can set a custom order key for the column. If not set, the order key is the same as the field name. Useful when the server expects a different key as it serves in the DTO.

  • Optionalselectable?: boolean

    If true, the column is selectable in the Column Selector Panel. If false, the column is not selectable.

  • title: string

    The title of the column shown in the thead.

  • Optionalvisible?: boolean

    If true, the column is visible. If false, the column is hidden in grid.

  • Optionalwidth?: string

    Sets the width of the column. If not set, the column width is auto. Example values: '100px', '10%'.

Settings

Member Visibility