mmflow Charts
API reference
A concise reference for the confirmed chart SDK exports used in these docs. This is not generated TypeDoc and does not add new APIs.
import {
createChart,
createDataFeed,
composeFeeds,
defineIndicator,
getControls,
defineTheme,
resolveTheme,
smaStudy,
emaStudy,
vwapStudy,
rsiStudy,
macdStudy,
builtinStudies,
type ChartDrawing,
type ChartDrawingApi,
type ChartDrawingsDocument,
compileChartScript,
validateChartScript,
type ChartScriptCompileResult,
createReplaySession,
createSyntheticReplayEvents,
candlesToReplayEvents,
serializeReplaySessionConfig,
parseReplaySessionConfig,
normalizeReplaySessionConfig,
replaySessionConfigToQuery,
replaySessionConfigFromQuery,
historyEventsToReplayEvents,
historyTradesToReplayEvents,
historyFootprintToChartBars,
historyOrderbookSnapshotsToHeatmapInput,
historyOrderbookSnapshotsToReplayEvents,
filterReplayEventsAtCursor,
groupReplayEventsByType,
replayEventsToMarkers,
type ReplaySession,
type ReplaySessionConfig,
type ReplayEvent,
type ReplayTradeEvent,
type ReplayOrderbookSnapshotEvent,
} from "@mmflow/charts";
import { Chart, useIndicator } from "@mmflow/react";
import { MmChart } from "@mmflow/vue";
import {
createMmflowFeed,
fetchHistoryCandles,
fetchHistoryEvents,
fetchHistoryTrades,
fetchHistoryFootprint,
fetchHistoryOrderbookSnapshots,
fetchHistoryStatus,
MmflowSocket,
} from "@mmflow/sdk";Chart engine
The framework-agnostic package exports createChart plus the main types, feed helpers, studies, layers, and theme helpers.
createChart(options)
Creates the imperative IChartApi with candle, volume, indicator, pane, layer, drawing, theme, screenshot, event, resize, and dispose methods.
createDataFeed and composeFeeds
Validate a DataFeed and compose optional candle, orderbook, footprint, volume profile, or marker sources.
defineIndicator and getControls
Create typed indicator factories and derive UI control descriptors from an IndicatorInstance.
Drawing tools
ChartDrawing, ChartDrawingApi, and ChartDrawingsDocument cover add/update/remove/list, active tools, and versioned import/export.
ChartScript
compileChartScript and validateChartScript parse safe formulas into one IndicatorInstance with multi-line plot metadata.
Replay helpers
createReplaySession, createSyntheticReplayEvents, candlesToReplayEvents, replay session config helpers, historyEventsToReplayEvents, historyTradesToReplayEvents, historyFootprintToChartBars, historyOrderbookSnapshotsToReplayEvents, historyOrderbookSnapshotsToHeatmapInput, filterReplayEventsAtCursor, groupReplayEventsByType, replayEventsToMarkers, ReplaySessionConfig, ReplaySession, ReplayTradeEvent, ReplayOrderbookSnapshotEvent, and ReplayEvent cover candle, overlay, bounded trade, footprint, sparse orderbook snapshot, and config-manifest replay foundations.
Theme helpers
ThemeTokens, defineTheme, resolveTheme, and presets support host-owned chart palettes.
Framework bindings and data SDK
These exports are confirmed in the React, Vue, and SDK package entry points.
@mmflow/react
Exports Chart, ChartProps, ChartHandle, useIndicator, and selected chart authoring APIs.
@mmflow/vue
Exports MmChart and selected chart authoring APIs.
@mmflow/sdk
Exports createMmflowFeed, fetchHistoryCandles, fetchHistoryEvents, fetchHistoryTrades, fetchHistoryFootprint, fetchHistoryOrderbookSnapshots, fetchHistoryStatus, response helpers, MmflowFeedOptions, MmflowSocket, socket options, channel, metadata, and data handler types.
Continue building
Move through the chart SDK docs without leaving the developer flow.