Skip to content

charton API


charton API / @chart-on/core / index / chartSettingsSchema

Variable: chartSettingsSchema ​

const chartSettingsSchema: readonly ChartSettingSection[]

Defined in: packages/core/src/chart-settings.ts:174

The built-in settings, one section per thing the user adjusts (#863), ordered from the data to the chrome around it:

  • series: how the main series draws (bodies, wicks, borders) and the price adjustments it applies
  • readout: what shows values under the pointer, the legend and the crosshair with its axis labels
  • axes: the scales' own labels and lines, and the text colors they use
  • time: how and where times show: timezone, seconds, trading day dividers, session shading and time-axis marks
  • background: what sits behind the data: background, grid, watermark
  • markers: marks the data source puts on bars, and split and dividend markers; last, since only some data sources supply them

A group heading is left out where it would repeat its section's title. Each field round-trips through applyChartSettings and readChartSetting.