Interface IBuilderAdapterDataProps

interface IBuilderAdapterDataProps {
    aggregationStrategy?: IAggregationStrategy;
    colorMappingFunctionTypes?: {
        [colorMappingFunctionType: string]: IColorMappingFunctionConstructor;
    };
    columnTypes?: {
        [columnType: string]: IColumnConstructor;
    };
    data: any[];
    defaultRanking?: boolean | "noSupportTypes";
    deriveColors?: boolean;
    deriveColumns?: boolean | string[];
    filterGlobally?: boolean;
    highlight?: number;
    jumpToSearchResult?: boolean;
    mappingFunctionTypes?: {
        [mappingFunctionType: string]: IMappingFunctionConstructor;
    };
    propagateAggregationState?: boolean;
    restore?: any;
    selection?: number[];
    showTopN?: number;
    singleSelection?: boolean;
    stringTopNCount?: number | readonly string[];
    taskExecutor?: "direct" | "scheduled";
    onHighlightChanged?(highlight): void;
    onSelectionChanged?(selection): void;
}

Hierarchy

Properties

aggregationStrategy?: IAggregationStrategy

aggregation strategy to show upon grouping, see also showTopN

Default

'item'
colorMappingFunctionTypes?: {
    [colorMappingFunctionType: string]: IColorMappingFunctionConstructor;
}

Type declaration

columnTypes?: {
    [columnType: string]: IColumnConstructor;
}

Type declaration

data: any[]
defaultRanking?: boolean | "noSupportTypes"
deriveColors?: boolean
deriveColumns?: boolean | string[]
filterGlobally?: boolean

whether the filter should be applied to all rankings regardless where they are default: false

highlight?: number
jumpToSearchResult?: boolean

jump to search results such that they are visible default: false

mappingFunctionTypes?: {
    [mappingFunctionType: string]: IMappingFunctionConstructor;
}

Type declaration

propagateAggregationState?: boolean

whether to propagate a collapse operation to its children

Default

true
restore?: any
selection?: number[]
showTopN?: number

show top N rows as sample rows

Default

10
singleSelection?: boolean

allow just single selected rows @default: false

stringTopNCount?: number | readonly string[]
taskExecutor?: "direct" | "scheduled"

specify the task executor to use direct = no delay, scheduled = run when idle

Methods