Editor Timeline Array

TimelineArrayEditorOptions

interface TimelineArrayEditorOptions {
  readonly runtime: StructuredEditorRuntime;
  readonly title: string;
  readonly range?: DataGridTimelineRange
}

---

TimelineArrayEditor

Structured editor for Timeline event arrays.

class TimelineArrayEditor {
  getValue(): DataGridTimelineEvent[];

  componentDidRender(): void | Promise<void>;

  beforeAutoSave(): boolean;

  beforeDisconnect(): void;

  render(...args: Parameters<TextEditor['render']>): ReturnType<TextEditor['render']>;
}

---

moveTimelineEvent

export function moveTimelineEvent(
  event: DataGridTimelineEvent,
  delta: number,
  range: DataGridTimelineRange,
): DataGridTimelineEvent;

---

niceTimelineStep

export function niceTimelineStep(range: DataGridTimelineRange): number;

---

normalizeDataGridTimelineArray

export function normalizeDataGridTimelineArray(value: unknown): DataGridTimelineEvent[] | undefined;

---

parseDataGridTimelineArray

export function parseDataGridTimelineArray(
  value: unknown,
  fallback: readonly DataGridTimelineEvent[] = [],
): DataGridTimelineEvent[];

---

resizeTimelineEvent

export function resizeTimelineEvent(
  event: DataGridTimelineEvent,
  edge: 'start' | 'end',
  delta: number,
  range: DataGridTimelineRange,
): DataGridTimelineEvent;

---

DataGridTimelineEvent (Extended from index.tsx)

interface DataGridTimelineEvent {
  readonly start: number;
  readonly end: number;
  readonly label?: string
}

---

DataGridTimelineRange

interface DataGridTimelineRange {
  readonly start: number;
  readonly end: number
}

---

createTimelineRow

export function createTimelineRow(event: DataGridTimelineEvent): TimelineRow;

---

updateTimelineEvent

export function updateTimelineEvent(
  rows: readonly TimelineRow[],
  id: number,
  event: DataGridTimelineEvent,
): TimelineRow[];

---

updateTimelineLabel

export function updateTimelineLabel(
  rows: readonly TimelineRow[],
  id: number,
  label: string,
): TimelineRow[];

---

updateTimelineNumber

export function updateTimelineNumber(
  rows: readonly TimelineRow[],
  id: number,
  key: 'start' | 'end',
  text: string,
): TimelineRow[];

---

reorderTimelineRows

export function reorderTimelineRows(
  rows: readonly TimelineRow[],
  from: number,
  to: number,
): TimelineRow[] | undefined;

---

serializeTimelineRows

export function serializeTimelineRows(rows: readonly TimelineRow[]): string;

---

validTimelineRow

export function validTimelineRow(row: TimelineRow): boolean;

---

eventOutsideRange

export function eventOutsideRange(
  event: DataGridTimelineEvent,
  range: DataGridTimelineRange,
): boolean;

---

timelineGeometry

export function timelineGeometry(
  event: DataGridTimelineEvent,
  range: DataGridTimelineRange,
): { readonly left: number; readonly width: number };

---

TimelineRow

interface TimelineRow {
  readonly id: number;
  readonly event: DataGridTimelineEvent;
  readonly startText: string;
  readonly endText: string
}

---

TimelinePointerMode

export type TimelinePointerMode = 'move' | 'start' | 'end';

---

TimelinePanelIds

interface TimelinePanelIds {
  readonly visualTab: string;
  readonly visualPanel: string;
  readonly rawTab: string;
  readonly rawPanel: string
}

---

TimelineEditorContent

export function TimelineEditorContent({
  value,
  locale,
  onChange,
  onValidityChange,
  range,
}: TimelineEditorContentProps);

---

TimelineEventList

export function TimelineEventList({
  rows,
  selected,
  range,
  locale,
  onRowsChange,
  onSelect,
}: TimelineEventListProps);

---

TimelineModeTabs

export function TimelineModeTabs({ mode, ids, locale, onModeChange }: TimelineModeTabsProps);

---

TimelineEditorMode

export type TimelineEditorMode = 'visual' | 'raw';

---

TimelineRawPanel

export function TimelineRawPanel({
  id,
  labelledBy,
  raw,
  invalid,
  locale,
  onChange,
}: TimelineRawPanelProps);

---

TimelineTrack

export function TimelineTrack({
  rows,
  selected,
  range,
  locale,
  onSelect,
  onEventChange,
}: TimelineTrackProps);