Interface IBuilderAdapterCategoricalColumnDescProps

interface IBuilderAdapterCategoricalColumnDescProps {
    asArray?: number | boolean | string[];
    asMap?: boolean;
    asOrdinal?: boolean;
    asSet?: string | boolean;
    categories?: (string | Partial<ICategory>)[];
    color?: string;
    column: string;
    custom?: {
        [key: string]: any;
    };
    description?: string;
    fixed?: boolean;
    frozen?: boolean;
    groupRenderer?: string;
    label?: string;
    labelAsHTML?: boolean | IStyleHTMLWrapper;
    missingCategory?: string | Partial<ICategory>;
    renderer?: string;
    summary?: string;
    summaryAsHTML?: boolean | IStyleHTMLWrapper;
    summaryRenderer?: string;
    type?: string;
    visible?: boolean;
    width?: number;
}

Hierarchy (view full)

Properties

asArray?: number | boolean | string[]
asMap?: boolean
asOrdinal?: boolean
asSet?: string | boolean
categories?: (string | Partial<ICategory>)[]
color?: string

color of this column

Deprecated

not used anymore

column: string
custom?: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any
description?: string

column description

fixed?: boolean

whether the column can be removed or not

Default

false
frozen?: boolean

frozen column

Default

isSupportType
groupRenderer?: string

default group renderer to use

label?: string

label of the column

labelAsHTML?: boolean | IStyleHTMLWrapper

whether to render the label as HTML (unsafe) or a custom function to convert a column to its summary label in HTML

Default

false
missingCategory?: string | Partial<ICategory>
renderer?: string

default renderer to use

summary?: string

column summary line (subtitle)

summaryAsHTML?: boolean | IStyleHTMLWrapper

whether to render the description as HTML (unsafe) or a custom function to convert a column to its summary label in HTML

Default

false
summaryRenderer?: string

default summary renderer to use

type?: string

the column type

visible?: boolean

is this column visible by default

Default

true
width?: number

initial width of the column

Default

100 or 200 for strings