BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Interface QueryColumn

    One entry of the columns table of a query answer: a GET item, its alias, and where its value is in a record. Label a column with label and read its values at path; you need not know where BIM.works writes each kind of feature, or what an alias does to that.

    interface QueryColumn {
        added?: boolean;
        aggregate?: string;
        alias: string | null;
        columns?: QueryColumn[];
        groupKey?: boolean;
        hidden?: boolean;
        item?: number;
        kind?: string;
        label?: string;
        path?: string[];
        source?: string;
        unit?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    added?: boolean

    True for an entry the server added rather than the query.

    aggregate?: string

    The aggregate's keyword (COUNT, SUM, COLLECT, ...), on an aggregate column.

    alias: string | null

    The AS alias, null without one.

    columns?: QueryColumn[]

    The items inside a relation, or the features of a COLLECT, relative to one element of this column's value.

    groupKey?: boolean

    True for a group key of a grouped result.

    hidden?: boolean

    True for an item the workspace's feature visibility hides; it has no values.

    item?: number

    The index of the item in the GET list (or in its relation's list); absent for an entry the server added, such as the qid of forceGetQid.

    kind?: string

    The feature family, for styling: attribute, property, quantity, calculated, type, ...

    label?: string

    The header to show: the alias, else the text.

    path?: string[]

    The keys from the record (for a nested column, from one element of its parent's value) to the value. An array, because keys hold dots. "*" stands for every key at that level; an array met on the way holds one value per element. Absent when the item writes nothing into the records (a feature the workspace hides).

    source?: string

    The item as BQL text, without its alias.

    unit?: string

    The unit of the item's UNIT clause, as written.