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? asMap? asOrdinal? asSet? categories? color? column custom? description? fixed? frozen? groupRenderer? label? labelAsHTML? missingCategory? renderer? summary? summaryAsHTML? summaryRenderer? type? visible? width?

Properties

Optional asArray

asArray?: number | boolean | string[]

Optional asMap

asMap?: boolean

Optional asOrdinal

asOrdinal?: boolean

Optional asSet

asSet?: string | boolean

Optional categories

categories?: (string | Partial<ICategory>)[]

Optional color

color?: string

color of this column

Deprecated

not used anymore

column

column: string

Optional custom

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

Type declaration

  • [key: string]: any

Optional description

description?: string

column description

Optional fixed

fixed?: boolean

whether the column can be removed or not

Default

false

Optional frozen

frozen?: boolean

frozen column

Default

isSupportType

Optional groupRenderer

groupRenderer?: string

default group renderer to use

Optional label

label?: string

label of the column

Optional labelAsHTML

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

Optional missingCategory

missingCategory?: string | Partial<ICategory>

Optional renderer

renderer?: string

default renderer to use

Optional summary

summary?: string

column summary line (subtitle)

Optional summaryAsHTML

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

Optional summaryRenderer

summaryRenderer?: string

default summary renderer to use

Optional type

type?: string

the column type

Optional visible

visible?: boolean

is this column visible by default

Default

true

Optional width

width?: number

initial width of the column

Default

100 or 200 for strings

Settings

Member Visibility

Theme

On This Page

asArrayasMapasOrdinalasSetcategoriescolorcolumncustomdescriptionfixedfrozengroupRendererlabellabelAsHTMLmissingCategoryrenderersummarysummaryAsHTMLsummaryRenderertypevisiblewidth