@synergy-design-system/vue
Version:
Vue3 wrappers for the Synergy Design System
44 lines (37 loc) • 2.19 kB
TypeScript
import { default as SynChart } from '@synergy-design-system/components/components/chart/chart.component.js';
type __VLS_Props = {
/**
* The color palette to apply to chart series.
- `categorical` (default) — 12 distinct colors for comparing unrelated data series
- `sequential-01` … `sequential-07` — 10-step single-hue ramps:
`01`=primary, `02`=accent, `03`=muted, `04`=purple, `05`=teal, `06`=magenta, `07`=neutral
- `sequential-status-critical`, `sequential-status-error`, `sequential-status-info`,
`sequential-status-success`, `sequential-status-warning` — 10-step status ramps
The palette sets the ECharts `color` array.
* If `config.color` is explicitly provided,
it takes precedence over the palette.
*/
palette?: SynChart['palette'];
/**
* The ECharts configuration input.
This property accepts either:
- a plain `ECConfig` object, or
- a callback that receives a typed preset handle and applies chart presets.
The resolved result maps 1:1 to the ECharts `option` parameter passed to
`setOption()`.
Consult the [ECharts option documentation](https://echarts.apache.org/en/option.html)
and assign either the object directly or build it through the handle.
> **Note:** Currently only **line charts** (`series[].type: 'line'`) are supported.
> Support for additional chart types (bar, pie, etc.) will be added in future releases or can be requested.
Assigning a new config input completely replaces the previous chart
configuration (`notMerge: true`).
To update only parts of the chart, access the underlying ECharts instance directly and
call `setOption()` with custom merge options.
*/
config?: SynChart['config'];
};
declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {
nativeElement: import('vue').Ref<SynChart | undefined, SynChart | undefined>;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
declare const _default: typeof __VLS_export;
export default _default;