Skip to main content

RectAnnotationDatum

@elastic/charts • Exports


@elastic/charts / RectAnnotationDatum

Interface: RectAnnotationDatum

The descriptive object of a rectangular annotation

Contents​

Properties​

coordinates​

coordinates: Object

The coordinates for the 4 rectangle points.

Type declaration​

x0?​

x0?: PrimitiveValue

The minuimum value on the x axis. If undefined, the minuimum value of the x domain will be used.

x1?​

x1?: PrimitiveValue

The maximum value on the x axis. If undefined, the maximum value of the x domain will be used.

y0?​

y0?: PrimitiveValue

The minimum value on the y axis. If undefined, the minimum value of the y domain will be used.

y1?​

y1?: PrimitiveValue

The maximum value on the y axis. If undefined, the maximum value of the y domain will be used.

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:893


details?​

details?: string

A textual description of the annotation

Source​

packages/charts/src/chart_types/xy_chart/utils/specs.ts:914


Generated using typedoc-plugin-markdown and TypeDoc