BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Interface TemplateContext

    The second argument of a template's render

    interface TemplateContext {
        format: {
            date(value: string | number | Date): string;
            initials(name: string): string;
            number(value: number, digits?: number): string;
            quantity(value: unknown): string;
            relative(value: string | number | Date, now?: number): string;
            type(type: string | null): string;
        };
        hovered: boolean;
        icons: {
            glyph(name: string): TemplateResult;
            ifc(type: string | null): TemplateResult;
        };
        key: string;
        mergedCount: number;
        now: number;
        qid: Qid
        | null;
        state: "expanded" | "compact";
        type: string | null;
    }
    Index

    Properties

    format hovered icons key mergedCount now qid state type

    Properties

    format: {
        date(value: string | number | Date): string;
        initials(name: string): string;
        number(value: number, digits?: number): string;
        quantity(value: unknown): string;
        relative(value: string | number | Date, now?: number): string;
        type(type: string | null): string;
    }

    Type Declaration

    • date: function
      • date(value: string | number | Date): string

        Parameters

        • value: string | number | Date

        Returns string

    • initials: function
      • initials(name: string): string

        Parameters

        • name: string

        Returns string

    • number: function
      • number(value: number, digits?: number): string

        Parameters

        • value: number
        • Optionaldigits: number

        Returns string

    • quantity: function
      • quantity(value: unknown): string

        Any data value as text: a Quantity with its unit, Yes or No for a boolean, a dash for no value

        Parameters

        • value: unknown

        Returns string

    • relative: function
      • relative(value: string | number | Date, now?: number): string

        "3 min ago", "in 2 days"

        Parameters

        • value: string | number | Date
        • Optionalnow: number

        Returns string

    • type: function
      • type(type: string | null): string

        "Door" for IFCDOOR

        Parameters

        • type: string | null

        Returns string

    hovered: boolean

    The annotation, or its object in a viewer, is under the pointer. The compact state is drawn again when this changes; a template with hover "template" shows it (keep the size: change colour, shadow or a transform)

    icons: {
        glyph(name: string): TemplateResult;
        ifc(type: string | null): TemplateResult;
    }

    Type Declaration

    • glyph: function
      • glyph(name: string): TemplateResult

        A glyph: check, cross, warning, clock, chat, wrench, eye, zoom, open

        Parameters

        • name: string

        Returns TemplateResult

    • ifc: function
      • ifc(type: string | null): TemplateResult

        The icon of an IFC class, a generic object icon for a class without one

        Parameters

        • type: string | null

        Returns TemplateResult

    key: string
    mergedCount: number

    More than 1 when this annotation fronts a cluster

    now: number

    Time of this render

    qid: Qid | null
    state: "expanded" | "compact"

    "compact" at rest; "expanded" in the card that opens on hover or click (expandable templates)

    type: string | null

    IFC class of the row ("IfcDoor"), null without one

    Settings

    Member Visibility

    On This Page

    Properties