@synergy-design-system/angular/types/synergy-design-system-angular-components-chart.d.ts

Angular wrappers for the Synergy Design System

import * as i0 from '@angular/core';
import { ElementRef, NgZone } from '@angular/core';
import SynChart from '@synergy-design-system/components/components/chart/chart.component.js';

/**
 * @summary The `<syn-chart>` component is a container for displaying charts. It provides a structured layout and styling for chart elements, allowing for consistent presentation across different types of charts. The chart component is based on [Apache ECharts](https://echarts.apache.org)
 *
 * @documentation https://synergy-design-system.github.io/?path=/docs/charting-syn-chart--docs
 * @status experimental
 * @since 3.15.0
 *
 * @csspart base - The component's base wrapper.
 */
declare class SynChartComponent {
    nativeElement: SynChart;
    private _ngZone;
    constructor(e: ElementRef, ngZone: NgZone);
    /**
  * 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.
   */
    set palette(v: SynChart['palette']);
    get 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.
   */
    set config(v: SynChart['config']);
    get config(): SynChart['config'];
    static ɵfac: i0.ɵɵFactoryDeclaration<SynChartComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<SynChartComponent, "syn-chart", never, { "palette": { "alias": "palette"; "required": false; }; "config": { "alias": "config"; "required": false; }; }, {}, never, ["*"], true, never>;
}

export { SynChartComponent };