Interface IAggregateGroupColumnDesc

interface IAggregateGroupColumnDesc {
    color?: string;
    description?: string;
    fixed?: boolean;
    frozen?: boolean;
    groupRenderer?: string;
    label: string;
    labelAsHTML?: boolean | IStyleHTMLWrapper;
    renderer?: string;
    summary?: string;
    summaryAsHTML?: boolean | IStyleHTMLWrapper;
    summaryRenderer?: string;
    type: string;
    visible?: boolean;
    width?: number;
    isAggregated(ranking, group): EAggregationState;
    setAggregated(ranking, group, value): void;
}

Hierarchy (view full)

Properties

color? description? fixed? frozen? groupRenderer? label labelAsHTML? renderer? summary? summaryAsHTML? summaryRenderer? type visible? width?

Methods

isAggregated setAggregated

Properties

Optional color

color?: string

color of this column

Deprecated

not used anymore

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

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 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

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

Methods

isAggregated

setAggregated

Settings

Member Visibility

Theme

On This Page

colordescriptionfixedfrozengroupRendererlabellabelAsHTMLrenderersummarysummaryAsHTMLsummaryRenderertypevisiblewidthisAggregatedsetAggregated