Skip to content

Components

All 25 charts, each wrapping the factory of the same name from @ripl/charts. Options and payloads are documented per chart in the API reference.

ComponentWrapsEvents
<ripl-arc-diagram-chart>createArcDiagramChartlinkclick, linkenter, linkleave, nodeclick, nodeenter, nodeleave
<ripl-area-chart>createAreaChartmarkerclick, markerenter, markerleave
<ripl-bar-chart>createBarChartbarclick, barenter, barleave
<ripl-box-plot-chart>createBoxPlotChartboxclick, boxenter, boxleave
<ripl-chord-chart>createChordChartlinkclick, linkenter, linkleave, segmentclick, segmententer, segmentleave
<ripl-force-directed-chart>createForceDirectedChartlinkclick, linkenter, linkleave, nodeclick, nodeenter, nodeleave
<ripl-funnel-chart>createFunnelChartsegmentclick, segmententer, segmentleave
<ripl-gantt-chart>createGanttCharttaskclick, taskenter, taskleave
<ripl-gauge-chart>createGaugeChartvalueclick, valueenter, valueleave
<ripl-heatmap-chart>createHeatmapChartcellclick, cellenter, cellleave
<ripl-histogram-chart>createHistogramChartbinclick, binenter, binleave
<ripl-line-chart>createLineChartmarkerclick, markerenter, markerleave
<ripl-packed-circle-chart>createPackedCircleChartnodeclick, nodeenter, nodeleave
<ripl-pie-chart>createPieChartsegmentclick, segmententer, segmentleave
<ripl-polar-area-chart>createPolarAreaChartsegmentclick, segmententer, segmentleave
<ripl-polar-scatter-chart>createPolarScatterChartmarkerclick, markerenter, markerleave
<ripl-radar-chart>createRadarChartmarkerclick, markerenter, markerleave
<ripl-radial-bar-chart>createRadialBarChartbarclick, barenter, barleave
<ripl-realtime-chart>createRealtimeChart
<ripl-sankey-chart>createSankeyChartlinkclick, linkenter, linkleave, nodeclick, nodeenter, nodeleave
<ripl-scatter-chart>createScatterChartmarkerclick, markerenter, markerleave
<ripl-stock-chart>createStockChartcandleclick, candleenter, candleleave
<ripl-sunburst-chart>createSunburstChartnodeclick, nodeenter, nodeleave
<ripl-treemap-chart>createTreemapChartnodeclick, nodeenter, nodeleave
<ripl-trend-chart>createTrendChartbarclick, barenter, barleave, markerclick, markerenter, markerleave

Both casings work: <ripl-bar-chart> and <RiplBarChart> resolve to the same component, exported as RiplBarChart.

Adding your own

defineRiplChart is exported, so a chart built on @ripl/charts's own Chart base gets the same treatment:

ts
import {
    chartFactory,
    defineRiplChart,
} from '@ripl/vue-charts';

export const RiplSparkline = defineRiplChart({
    name: 'RiplSparkline',
    optionKeys: ['data', 'value'],
    events: Sparkline.prototype.$events as string[],
    create: chartFactory<SparklineOptions>(createSparkline),
});

optionKeys names the options on top of the shared set, and events comes from the chart class's own $events declaration so the two cannot drift.