@kumo-charts/core/all
The API reference is generated from the source comments.
import { … } from '@kumo-charts/core/all';
Functions
allModulesfunctionSource
function allModules(options: AllModulesOptions = {}): readonly [IndicatorsModule, DrawingsModule, ChartTypesModule, AlertsModule, OrdersModule, MarkersModule, ReplayModule, VolumeProfilesModule, WatermarkModule]
Every module of the library with everything in it: createChart(container, { modules: allModules() }) gives a chart with all its indicators, drawings (the fixed range volume profile
among them), chart types, alerts, orders, markers, replay, volume profiles and the watermark.
Interfaces
AllModulesOptionsinterfaceSource
interface AllModulesOptions
What allModules() takes: what its modules take beside their types.
readonly indicators?: IndicatorsModuleOptionsAs indicators() takes them, such as { texts: [indicatorTexts] }.
Types
AllEventMaptypeSource
type AllEventMap = ChartEventMap & ModulesEvents<AllModules>
The events of a chart with every module: the core's and those of the modules.
AllModulestypeSource
type AllModules = ReturnType<typeof allModules>
The modules of allModules, for Chart<AllModules>.
Variables
ALL_EVENTSvariableSource
const ALL_EVENTS: readonly (keyof ChartEventMap | keyof DrawingsEventMap | keyof AlertsEventMap | keyof OrdersEventMap | "replay")[]
The name of every event of the core and of the modules of the library, e.g. to forward them all as the components of the library for frameworks do. A chart emits those of the modules it has.