ChartOptions.id
property · packages/mixins-ui/src/chart.ts:82
readonly id: stringPrefixes the ids the chart draws, unique on the page.
Mixins / foldkit-mixins-ui
interface · packages/mixins-ui/src/chart.ts:80
interface ChartOptions<ParentMessage> {
readonly id: string
readonly label: string
readonly description?: string | undefined
readonly model: Model
readonly onMessage: (message: Message) => NoInfer<ParentMessage>
readonly format?: ((value: number) => string) | undefined
readonly legend?: boolean | undefined
readonly table?: 'hidden' | 'shown' | undefined
readonly style?: NamedStyle<typeof ChartSlots> | undefined
readonly mixins?: MixinList<ParentMessage> | undefined
}What every kind of chart is given: its name, state, words and look.
ChartOptions.idproperty · packages/mixins-ui/src/chart.ts:82
readonly id: stringPrefixes the ids the chart draws, unique on the page.
ChartOptions.labelproperty · packages/mixins-ui/src/chart.ts:84
readonly label: stringWhat the chart shows: its caption, the plot's name and the table's caption.
ChartOptions.descriptionproperty · packages/mixins-ui/src/chart.ts:86
readonly description?: string | undefinedA sentence under the title, such as the period shown.
ChartOptions.modelproperty · packages/mixins-ui/src/chart.ts:87
readonly model: ModelChartOptions.onMessageproperty · packages/mixins-ui/src/chart.ts:88
readonly onMessage: (message: Message) => NoInfer<ParentMessage>ChartOptions.formatproperty · packages/mixins-ui/src/chart.ts:90
readonly format?: ((value: number) => string) | undefinedHow a value reads, on the axis and in the tooltip; default grouped digits, two decimals at most.
ChartOptions.legendproperty · packages/mixins-ui/src/chart.ts:92
readonly legend?: boolean | undefinedDraws the legend; default with two series or more, and for a donut.
ChartOptions.tableproperty · packages/mixins-ui/src/chart.ts:94
readonly table?: 'hidden' | 'shown' | undefinedThe data table: read by assistive technology only (default), or shown.
ChartOptions.styleproperty · packages/mixins-ui/src/chart.ts:96
readonly style?: NamedStyle<typeof ChartSlots> | undefinedA style of ChartSlots, for the look.
ChartOptions.mixinsproperty · packages/mixins-ui/src/chart.ts:98
readonly mixins?: MixinList<ParentMessage> | undefinedMixins beside the style.