Skip to content

AnnotationQuerySpec🔗

Definition🔗

class AnnotationQuerySpec:
    query: dashboardv2beta1.DataQueryKind
    enable: bool
    hide: bool
    icon_color: str
    name: str
    built_in: typing.Optional[bool]
    filter_val: typing.Optional[dashboardv2beta1.AnnotationPanelFilter]
    # Placement can be used to display the annotation query somewhere else on the dashboard other than the default location.
    placement: str
    # Mappings define how to convert data frame fields to annotation event fields.
    mappings: typing.Optional[dict[str, dashboardv2beta1.AnnotationEventFieldMapping]]
    # Catch-all field for datasource-specific properties. Should not be available in as code tooling.
    legacy_options: typing.Optional[dict[str, object]]

Methods🔗

to_json🔗

Converts this object into a representation that can easily be encoded to JSON.

def to_json() -> dict[str, object]

from_json🔗

Builds this object from a JSON-decoded dict.

@classmethod
def from_json(data: dict[str, typing.Any]) -> typing.Self

See also🔗

AnnotationQuerySpec