Skip to main content

Internal API

Internal API helps enable methods not found in supported APIs. The Internal API provides access to all DXcharts React internal codebase.

Note: The internal APIs are not part of the supported APIs. Use them at your own risk.

interface ReactAppState {
readonly multiChartViewModel: MultiChartViewModel;
readonly chartVMs: Record<string, CombinedViewModels>;
}
interface ChartReactDebug {
/**
* Prints current layout state to the console
*/
readonly exportLayout: () => void;
/**
* Applies specified migration script to the chart and reloads the page
*/
readonly applyMigrationScript: (scriptId: string) => void;
}
type ChartReactInternalAPI = ReactAppState & ChartReactDebug;
export interface ChartReactAPI extends ChartReactSupportedAPI {
readonly internal: ChartReactInternalAPI;
/**
* @deprecated
*/
readonly supported: unknown;
}