Skip to content

Public exports

The root entry is the application-facing convenience surface. It includes the chart with every built-in controller, common built-ins, persistence, themes, formatting, drawings, and synchronization plugins.

ts
import { FinancialChart } from "@ardinsys/financial-charts";
import "@ardinsys/financial-charts/style.css";

This page is the root-export inventory. Detailed behavior lives in the linked reference pages.

Chart construction and data

ExportsReference
FinancialChart, CoreChartOptionsFinancialChart
ChartData, TimeRangeData contracts
ChartOptions, ChartOptionsUpdate, ChartOptionsSnapshot, ChartOptionsChangeEvent, ChartOptionKey, ChartLocalizationOptions, WheelZoomModeOptions
LocaleValues, LocaleValuesMapi18n
ControllerID, ControllerType, ControllerConstructorControllers
ChartPaneSnapshot, PaneHeightsInputView and panes
ChartCrosshairOptions, ChartCrosshairState, ChartCrosshairChangeEventView and interactions
IndicatorMutationOptionsIndicator management

Events, formatting, and themes

ExportsReference
EventEmitter, ChartEventMapEvents
Formatter, DefaultFormatter, DefaultFormatterOptionsFormatting
ChartTheme, ChartThemeMap, ChartThemeKey, BuiltInChartThemeKey, ResolvedChartTheme, Gradient, defaultLightTheme, defaultDarkThemeStyling
DefaultDOMAdapterDOM adapter

ChartThemeMap registers partial definitions by key. The chart resolves each definition from its declared built-in base and exposes the active complete ResolvedChartTheme through getOptions().

Chart and indicator state

ExportsReference
CHART_STATE_VERSION, ChartState, ChartCoreState, ChartPaneStateState and persistence
ChartStateContributor, ChartStateSerializationOptions, ChartStateRestoreOptions, ChartStateRestoredEventCustom contributors
INDICATOR_STATE_VERSION, IndicatorState, IndicatorStateOptions, IndicatorStateValue, IndicatorIdentityOptions, IndicatorResolver, restoreIndicatorSerializable indicator state
MovingAverageIndicator, MovingAverageOptions, MovingAverageThemeIndicators

Drawings and annotations

ExportsReference
Drawing, DrawingOptions, DrawingAnchor, DrawingJSONDrawing base
DrawingManager, DrawingManagerOptions, DrawingManagerJSON, DrawingFactory, DrawingFactoryDescriptor, DrawingCreationFactory, DrawingDeserializer, DrawingMutationOptions, DrawingSelectionOptionsDrawingManager
TrendLine, TrendLineOptions, HorizontalLine, HorizontalLineOptions, RectangleDrawing, RectangleDrawingOptions, TextDrawing, TextDrawingOptionsBuilt-in drawings
DrawingEvent, DrawingFinishedEvent, DrawingFinishedOperation, DrawingSelectionEventDrawing events
IndicatorEvent, IndicatorVisibilityChangedEventIndicator events
PriceAxisAnnotation, PriceAxisAnnotationOffscreenBehaviorPrice-axis annotations

Plugins included at the root

ExportsReference
ExtensionThemeResolver, ExtensionThemeDefaults, ExtensionThemeDefinition, ExtensionThemeMapExtension themes
ChartSyncPlugin, ChartSyncPluginOptions, ChartSyncCrosshairSnapshot, ChartSyncIndicatorSnapshot, ChartSyncMessage, ChartSyncMessageSource, ChartSyncMessageHandler, ChartSyncPostMessageOptionsChartSyncPlugin
DrawingAxisBoundsPlugin, DrawingAxisBoundsPluginOptions, DrawingAxisBoundKind, DrawingAxisBoundsLabels, DrawingAxisBoundsLabelOptions, DrawingAxisBoundsLabelContext, DrawingAxisBoundsValueContext, DrawingAxisBoundsTextContext, DrawingAxisBoundsThemeDrawing axis bounds
DrawingSelectionPlugin, DrawingSelectionPluginOptions, DrawingSelectionCallbackDrawing selection

Built-in controllers

The root exports AreaController, BarController, CandlestickController, HLCAreaController, HollowCandleController, LineController, and SteplineController. Importing the root intentionally includes all of them.

For a controller-curated bundle, import FinancialChart from @ardinsys/financial-charts/core and concrete controllers from:

  • @ardinsys/financial-charts/controllers/area
  • @ardinsys/financial-charts/controllers/bar
  • @ardinsys/financial-charts/controllers/candle
  • @ardinsys/financial-charts/controllers/hlc-area
  • @ardinsys/financial-charts/controllers/hollow-candle
  • @ardinsys/financial-charts/controllers/line
  • @ardinsys/financial-charts/controllers/stepline

Authoring entry points

  • @ardinsys/financial-charts/extensions exports plugin, indicator, drawing, annotation, DOM-adapter, rendering, chart-state, view, formatting, locale, and scale authoring contracts. It includes the abstract Indicator, PaneledIndicator, and Drawing authoring bases, but not bundled plugins, drawings, managers, or DefaultDOMAdapter; those remain on the root entry. See Plugins, Indicators, Drawings, and the DOM adapter.
  • @ardinsys/financial-charts/engine adds controllers, scales, panes, render stages, ticks, palette selection, and low-level DOM/canvas helpers. See Engine and Scales.

Package source files, dist/* implementation paths, test fixtures, icon source strings, and the internal default-controller registry are not public subpaths.

Released under the Apache 2.0 License.