Attributes for creating or updating an annotation.

Hierarchy

  • AnnotationCreateAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Color used to render the annotation in the UI.

description: string

User-defined text attached to the annotation.

endTime?: number

End time of the annotation in milliseconds since the Unix epoch. Required for timeRegion annotations; omit or set to null for pointInTime annotations.

pageId: string

ID of the page the annotation belongs to, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

startTime: number

Start time of the annotation in milliseconds since the Unix epoch.

Kind of annotation. pointInTime annotations mark a single moment in time, while timeRegion annotations span a window of time and require an end_time.

widgetIds?: string[]

IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.

Generated using TypeDoc