Accessibility options

AccessibilityAnnouncementOptions, AccessibilityDataTableOptions, AccessibilityKeyboardNavigationOptions, AccessibilityOptions and 2 more: generated from the source of active-charts.

Exported by @workspace/active-charts. Generated from the package source; part of the index of every export.

Types#

AccessibilityAnnouncementOptions

interface AccessibilityAnnouncementOptions {
  enabled?: boolean;
  suppress?: ChartAnnouncementCategory[];
}

AccessibilityDataTableOptions

interface AccessibilityDataTableOptions {
  enabled?: boolean;
  caption?: string;
  xHeader?: string;
}

AccessibilityKeyboardNavigationOptions

Keyboard-navigation configuration for charts.

Controls whether keyboard navigation is active on navigable archetypes (Scalar charts have none) and how point-focus announcements are phrased. All properties are optional.

interface AccessibilityKeyboardNavigationOptions {
  enabled?: boolean;
  announcementMode?: KeyboardAnnouncementMode;
  wrapAround?: boolean;
  confirmDrillDown?: boolean;
}

AccessibilityOptions

Accessibility configuration for charts.

Controls ARIA labels, screen reader descriptions, data table rendering, and announcement behavior. All properties are optional — sensible defaults are applied when omitted.

interface AccessibilityOptions {
  label?: string;
  description?: string;
  dataTable?: boolean | AccessibilityDataTableOptions;
  announcements?: boolean | AccessibilityAnnouncementOptions;
  keyboardNavigation?: boolean | AccessibilityKeyboardNavigationOptions;
}

ChartAnnouncementCategory

What a live-region announcement is about, the unit a host can silence (accessibility.announcements.suppress).

type ChartAnnouncementCategory =
  'zoom' | 'legend' | 'tooltip' | 'contextMenu' | 'period' | 'selection';

KeyboardAnnouncementMode

Verbosity of keyboard-navigation screen-reader announcements.

type KeyboardAnnouncementMode = 'terse' | 'verbose';