Interface IScriptDesc

interface IScriptDesc {
    color?: string;
    colorMapping?: string | ITypedDump | ((v) => string);
    description?: string;
    domain?: [number, number];
    fixed?: boolean;
    frozen?: boolean;
    groupRenderer?: string;
    label: string;
    labelAsHTML?: boolean | IStyleHTMLWrapper;
    map?: ITypedDump;
    numberFormat?: string;
    range?: [number, number];
    renderer?: string;
    script?: string;
    summary?: string;
    summaryAsHTML?: boolean | IStyleHTMLWrapper;
    summaryRenderer?: string;
    type: string;
    visible?: boolean;
    width?: number;
}

Hierarchy (view full)

Properties

color? colorMapping? description? domain? fixed? frozen? groupRenderer? label labelAsHTML? map? numberFormat? range? renderer? script? summary? summaryAsHTML? summaryRenderer? type visible? width?

Properties

Optional color

color?: string

color of this column

Deprecated

not used anymore

Optional colorMapping

colorMapping?: string | ITypedDump | ((v) => string)

color mapping

Type declaration

    • (v): string

    • Parameters

      • v: number

      Returns string

Optional description

description?: string

column description

Optional domain

domain?: [number, number]

either map or domain should be available

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 map

map?: ITypedDump

dump of mapping function

Optional numberFormat

numberFormat?: string

d3 format number Format

Default

0.3n

Optional range

range?: [number, number]

Default

[0,1]

Optional renderer

renderer?: string

default renderer to use

Optional script

script?: string

the function to use, it has two parameters: children (current children) and values (their row values)

Default

'return Math.max.apply(Math,values)'

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

Settings

Member Visibility

Theme

On This Page

colorcolorMappingdescriptiondomainfixedfrozengroupRendererlabellabelAsHTMLmapnumberFormatrangerendererscriptsummarysummaryAsHTMLsummaryRenderertypevisiblewidth