Skip to content
EliteChart

CorporateEvent

Documentation

Documentation / @elitechart/core / CorporateEvent

Defined in: corporate-events/corporate-event-types.ts:30

A single corporate event registered on the chart. Pass to chart.addCorporateEvent(...).

Example

code
chart.addCorporateEvent({
  kind: 'earnings',
  time: asTimestampMs(Date.UTC(2026, 1, 15)),
  note: 'Q4 EPS $1.42 beat',
});

Properties

id

code
readonly id: string;

Defined in: corporate-events/corporate-event-types.ts:31

kind

code
readonly kind: CorporateEventKind;

Defined in: corporate-events/corporate-event-types.ts:32

note?

code
readonly optional note?: string;

Defined in: corporate-events/corporate-event-types.ts:35

Optional short note surfaced via hover/click.

time

code
readonly time: TimestampMs;

Defined in: corporate-events/corporate-event-types.ts:33

value?

code
readonly optional value?: number;

Defined in: corporate-events/corporate-event-types.ts:37

Optional numeric value — e.g. dividend amount, split ratio numerator.