Documentation / @ripl/charts / ChartAnnotations

Class: ChartAnnotations

Defined in: charts/src/components/annotation.ts:117

Renders chart ChartAnnotations (reference lines, shaded bands, and point markers) into the plot area, resolving their values through the supplied axis scales. Annotations whose value cannot be mapped (e.g. an x annotation against a categorical x axis) are skipped. The overlay is redrawn each call, which is inexpensive for the handful of annotations a chart typically carries.

Extends

• ChartComponent

Constructors

Constructor

new ChartAnnotations(options): ChartAnnotations

Defined in: charts/src/components/annotation.ts:122

Parameters

Parameter	Type
options	ChartComponentOptions

Returns

ChartAnnotations

Overrides

ChartComponent.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
parent?	public	EventBus<EventMap>	The parent event bus that emitted events bubble up to, if any.	ChartComponent.parent	core/src/core/event-bus.ts:107
renderer	protected	Renderer	-	ChartComponent.renderer	charts/src/components/_base/index.ts:23
scene	protected	Scene	-	ChartComponent.scene	charts/src/components/_base/index.ts:22
defaultKey	readonly	typeof defaultKey	The key under which resources are retained when no explicit key is provided.	ChartComponent.defaultKey	core/src/core/disposer.ts:11

Accessors

$events

Get Signature

get $events(): keyof TEventMap[]

Defined in: core/src/core/event-bus.ts:114

The event types this bus can emit. The base returns an empty list; subclasses override it to declare their emittable events (type-checked against their EventMap), so tooling such as the devtools can enumerate them, including events added by custom subclasses.

Returns

keyof TEventMap[]

Inherited from

ChartComponent.$events

---

context

Get Signature

get protected context(): Context<Element, Record<string, unknown>>

Defined in: charts/src/components/_base/index.ts:25

Returns

Context<Element, Record<string, unknown>>

Inherited from

ChartComponent.context

Methods

destroy()

destroy(): void

Defined in: charts/src/components/annotation.ts:304

Removes the annotation elements from the scene.

Returns

void

Overrides

ChartComponent.destroy

---

dispose()

protected dispose(key?): void

Defined in: core/src/core/disposer.ts:25

Disposes all resources under the given key, or all resources if no key is provided.

Parameters

Parameter	Type
key?	PropertyKey

Returns

void

Inherited from

ChartComponent.dispose

---

emit()

Call Signature

emit<TEvent>(event): TEvent

Defined in: core/src/core/event-bus.ts:185

Emits an event, invoking all matching handlers and bubbling to the parent if applicable. Handlers for the event's own type run first, then EVENT_WILDCARD subscriptions.

Type Parameters

Type Parameter	Default type
TEvent extends Event<undefined>	Event<undefined>

Parameters

Parameter	Type
event	TEvent

Returns

TEvent

Inherited from

ChartComponent.emit

Call Signature

emit<TEvent>(type, data): Event<EventMap[TEvent]>

Defined in: core/src/core/event-bus.ts:186

Emits an event, invoking all matching handlers and bubbling to the parent if applicable. Handlers for the event's own type run first, then EVENT_WILDCARD subscriptions.

Type Parameters

Type Parameter
TEvent extends keyof EventMap

Parameters

Parameter	Type
type	TEvent
data	EventMap[TEvent]

Returns

Event<EventMap[TEvent]>

Inherited from

ChartComponent.emit

---

has()

has(type): boolean

Defined in: core/src/core/event-bus.ts:123

Returns whether there are any listeners registered for the given event type. Wildcard subscriptions (EVENT_WILDCARD) are not listeners for any concrete type, so a bus observed only through the wildcard still reports false here.

Parameters

Parameter	Type
type	keyof EventMap

Returns

boolean

Inherited from

ChartComponent.has

---

off()

off<TEvent>(type, handler): void

Defined in: core/src/core/event-bus.ts:144

Removes a previously registered handler for the given event type.

Type Parameters

Type Parameter
TEvent extends keyof EventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<EventMap[TEvent]>

Returns

void

Inherited from

ChartComponent.off

---

on()

on<TEvent>(type, handler, options?): Disposable

Defined in: core/src/core/event-bus.ts:131

Subscribes a handler to the given event type and returns a disposable for cleanup. Pass EVENT_WILDCARD to receive every event emitted on the bus regardless of type.

Type Parameters

Type Parameter
TEvent extends keyof EventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<EventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

ChartComponent.on

---

once()

once<TEvent>(type, handler, options?): Disposable

Defined in: core/src/core/event-bus.ts:159

Subscribes a handler that is automatically removed after it fires once.

Type Parameters

Type Parameter
TEvent extends keyof EventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<EventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

ChartComponent.once

---

render()

render(annotations, scales, plot, clip?): void

Defined in: charts/src/components/annotation.ts:149

Draws (or redraws) the given annotations within the plot rectangle.

Parameters

Parameter	Type	Default value	Description
annotations	ChartAnnotation[]	undefined	The annotations to render.
scales	AnnotationScales	undefined	The x/y value scales used to position them.
plot	AnnotationPlot	undefined	The plot rectangle they are drawn within.
clip	boolean	false	When true, mask the annotations to plot so they don't bleed past the plot edges while a navigator pans/zooms (which rescales the axes). Defaults to false.

Returns

void

---

retain()

protected retain(value, key?): void

Defined in: core/src/core/disposer.ts:14

Registers a disposable resource under an optional key for later cleanup.

Parameters

Parameter	Type	Default value
value	Disposable	undefined
key	PropertyKey	Disposer.defaultKey

Returns

void

Inherited from

ChartComponent.retain