Variable AnnotationTemplatesConst

Type Declaration

• Readonlyasset: AnnotationTemplate<
      {
          assetType?: string;
          code?: string;
          lastInspection?: string
          | number
          | Date;
          name?: string;
          nextDue?: string | number | Date;
          tag?: string;
      },
  >

  An asset code with its maintenance state; the schedule on hover; button data-action "workorder". Fields: name, tag

• ReadonlybcfTopic: AnnotationTemplate<
      {
          assignedTo?: string;
          code?: string;
          dueDate?: string
          | number
          | Date;
          labels?: string[];
          priority?: string;
          snapshot?: string;
          stage?: string;
          title?: string;
          topicStatus?: string;
          topicType?: string;
      },
  >

  A BCF topic: the type's code in the status colour; the snapshot and facts on hover; buttons data-action "viewpoint" and "open". Default key "globalId"

• ReadonlycheckResult: AnnotationTemplate<
      {
          actual?: unknown;
          check?: string;
          expected?: unknown;
          object?: string;
          outcome?: "pass"
          | "warn"
          | "fail";
          rule?: string;
          rules?: {
              actual?: unknown;
              expected?: unknown;
              outcome: "pass" | "warn" | "fail";
              rule: string;
          }[];
      },
  >

  Passed, warning or failed per object, the rules on hover. A list of rules, or one flat rule

• Readonlyconversation: AnnotationTemplate<
      {
          comments?: {
              at?: string
              | number
              | Date;
              author: string;
              text: string;
          }[];
          count?: number;
          participants?: string[];
          status?: "open"
          | "closed";
          unread?: number;
      },
  >

  Participants and unread count, the last comments on hover; buttons data-action "reply" and "close"

• Readonlyissue: AnnotationTemplate<
      {
          assignee?: string;
          comments?: number;
          description?: string;
          due?: string
          | number
          | Date;
          number?: number | string;
          priority?: "high" | "normal" | "low";
          status?: "open" | "progress" | "resolved" | "closed";
          thumbnail?: string;
          title?: string;
          type?: "clash" | "question" | "defect";
      },
  >

  A status pin with its number, a card on hover; buttons data-action "open" and "zoom"

• ReadonlyobjectLabel: AnnotationTemplate<{ longName?: string; name?: string; objectType?: string }>

  Name in bold, long name below it, type with its icon. Fields: name, longName, objectType

• Readonlyprogress: AnnotationTemplate<
      {
          actualStart?: string
          | number
          | Date;
          forecastEnd?: string | number | Date;
          percent?: number;
          plannedEnd?: string | number | Date;
          plannedStart?: string | number | Date;
          status?: "track" | "late" | "done";
          task?: string;
      },
  >

  Completion as a ring; planned against forecast on hover

• Readonlyproperties: AnnotationTemplate<Record<string, unknown>>

  The name and the first three other fields as key/value rows. Fields: name, plus your query's get

• ReadonlyroomTag: AnnotationTemplate<{ area?: Quantity; longName?: string; name?: string }>

  The architectural room tag (SVG). Fields: name, longName, area

• Readonlysensor: AnnotationTemplate<
      {
          alarm?: [number | null, number | null];
          history?: number[];
          kind?: "temperature" | "co2" | "humidity" | string;
          name?: string;
          space?: string;
          unit?: string;
          updatedAt?: string | number | Date;
          value?: number;
          warn?: [number | null, number | null];
      },
  >

  A live reading in its state's colour, the recent readings on hover; stale after 15 minutes. Field: name. Defaults: key "globalId", dotBeyondMm 30000, drawn again every 30 s. warn and alarm are [low, high], either may be null