IFClite TypeScript API
    Preparing search index...

    Interface BucketedChartSpec

    Every chart type except elementCount buckets rows by a dimension column and MUST declare it — there is no sentinel value that means "none".

    interface BucketedChartSpec {
        bins?: number;
        clashReportId?: string;
        comparisonId?: string;
        dimension: string;
        elementField?: ElementFieldBinding;
        filter?: ChartSourceFilter;
        id: string;
        measure: ChartMeasure;
        measureField?: ElementFieldBinding;
        sort?: "value" | "label";
        source: ChartSource;
        stackBy?: string;
        title: string;
        topN?: number;
        type: "bar" | "stackedBar" | "pie" | "treemap" | "histogram" | "timeline";
    }

    Hierarchy

    • ChartSpecCommon
      • BucketedChartSpec
    Index
    bins? clashReportId? comparisonId? dimension elementField? filter? id measure measureField? sort? source stackBy? title topN? type
    bins?: number

    Histogram bin count; Sturges' rule when absent.

    clashReportId?: string

    Saved clash report in the viewer's saved-content library (#6947). Only valid for clash. Absent means the current clash result, which is what every chart saved before this field existed reads. Dashboard and document files keep this ID; the saved report is a local dependency and is not embedded into the chart specification.

    comparisonId?: string

    Completed comparison in the viewer's canonical saved history (#6549). Only valid for compare. Absent preserves the legacy live comparison. Dashboard/document files retain this ID; the matching saved history is a local dependency and is not embedded into the chart specification.

    dimension: string

    Column id to bucket by. A date column for timeline, a number column for histogram.

    elementField?: ElementFieldBinding

    IFC field used for grouping, materialized beside the built-in element columns.

    filter?: ChartSourceFilter

    Narrows this chart's rows to those touching the matched elements, on top of the dashboard scope.

    id: string
    measure: ChartMeasure
    measureField?: ElementFieldBinding

    Numeric IFC field to sum independently of the grouping field.

    sort?: "value" | "label"

    Bucket order; default value (largest first). label sorts by label, dates chronologically.

    source: ChartSource
    stackBy?: string

    Second category column for stackedBar: one series per distinct value.

    title: string
    topN?: number

    Keep the first N buckets and fold the rest into one Other bucket.

    type: "bar" | "stackedBar" | "pie" | "treemap" | "histogram" | "timeline"

    Settings
    Member Visibility

    On This Page
    Properties