Documentation / @ripl/vue-charts / RiplChartDefinition

Interface: RiplChartDefinition

Defined in: vue-charts/src/core/define-chart.ts:82

Describes one chart to wrap as a component.

Properties

Property	Type	Description	Defined in
events	readonly string[]	The events the chart emits, read from the class's own $events declaration.	vue-charts/src/core/define-chart.ts:88
name	string	The component's name, e.g. RiplBarChart.	vue-charts/src/core/define-chart.ts:84
optionKeys	readonly string[]	The chart's own option names, on top of the options every chart accepts.	vue-charts/src/core/define-chart.ts:86

Methods

create()

create(target, options): RiplAnyChart

Defined in: vue-charts/src/core/define-chart.ts:90

Constructs the underlying chart from the target and the options bound on the component.

Parameters

Parameter	Type
target	HTMLElement | Context<Element, Record<string, unknown>>
options	RiplWritable

Returns

RiplAnyChart