Class PageAnnotationsAttributes

Attributes of the annotations on a page.

Hierarchy

  • PageAnnotationsAttributes

Constructors

constructor

Properties

additionalProperties? annotations globalAnnotations widgetMapping

Constructors

constructor

Properties

Optional additionalProperties

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

annotations

annotations: {
    [key: string]: AnnotationInPage;
}

Map of annotation UUID to annotation object, keyed by annotation ID.

Type declaration

globalAnnotations

globalAnnotations: string[]

List of annotation IDs that apply to the entire page rather than a specific widget.

widgetMapping

widgetMapping: {
    [key: string]: string[];
}

Map from widget ID to the list of annotation IDs displayed on that widget.

Type declaration

  • [key: string]: string[]

Settings

Member Visibility

Theme

Generated using TypeDoc