@univerjs-pro/engine-chart 1.0.0-alpha.3 → 1.0.0-alpha.4

package/lib/types/facade/f-chart-builder-base.d.ts

@@ -0,0 +1,331 @@
+import type { ChartAggregationTarget, ChartAppearanceTarget, ChartBuilder, ChartDescription, ChartLegendSpec, ChartPendingConfig, ChartSubtitleSpec, ChartTitleSpec, IChartAggregationSpec, IChartAppearanceSpec, InvalidValueType } from '@univerjs-pro/engine-chart';
+import type { IChartBuilderTypeMap } from './chart-builder-type-map';
+import { FChartBase } from './f-chart-base';
+export declare class FChartBuilderBase<TBuilder extends ChartBuilder = ChartBuilder, TDescription extends ChartDescription = ChartDescription> extends FChartBase<TDescription, TBuilder> {
+    protected _record(patch: ChartPendingConfig): this;
+    /**
+     * Sets the title configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param value The semantic value to record.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.setTitle({ text: 'Quarterly sales' });
+     * ```
+     */
+    setTitle(value: ChartTitleSpec): this;
+    /**
+     * Clears the title configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.clearTitle();
+     * ```
+     */
+    clearTitle(): this;
+    /**
+     * Sets the subtitle configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param value The semantic value to record.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.setSubtitle({ text: 'FY 2026' });
+     * ```
+     */
+    setSubtitle(value: ChartSubtitleSpec): this;
+    /**
+     * Clears the subtitle configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.clearSubtitle();
+     * ```
+     */
+    clearSubtitle(): this;
+    /**
+     * Sets the legend configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param value The semantic value to record.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.setLegend(true);
+     * ```
+     */
+    setLegend(value: ChartLegendSpec): this;
+    /**
+     * Clears the legend configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.clearLegend();
+     * ```
+     */
+    clearLegend(): this;
+    /**
+     * Sets the theme configuration and returns this builder for chaining.
+     *
+     * A non-empty chart palette takes precedence over the theme's series colors. This method does
+     * not clear that palette; call `clearPalette()` explicitly to use the selected theme colors.
+     *
+     * This method executes synchronously.
+     *
+     * @param name The stable registered name.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
+     * const builder = fWorksheet.charts.create();
+     * builder.setTheme('brand');
+     * ```
+     */
+    setTheme(name: string): this;
+    /**
+     * Clears the theme configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
+     * const builder = fWorksheet.charts.create();
+     * builder.clearTheme();
+     * ```
+     */
+    clearTheme(): this;
+    /**
+     * Sets absolute series palette colors and returns this builder for chaining.
+     *
+     * The values are copied, persisted with the chart, and used unchanged in light and dark mode.
+     * A non-empty palette takes precedence over the selected theme's series colors without clearing
+     * the selected theme. Call `clearPalette()` to return series-color control to the theme.
+     * An empty array has the same effect as `clearPalette()`.
+     *
+     * @param colors Ordered CSS colors that override the selected theme's series colors.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
+     * const builder = fWorksheet.charts.create();
+     * builder.setPalette(['#1677ff', '#52c41a']);
+     * ```
+     */
+    setPalette(colors: readonly string[]): this;
+    /**
+     * Clears the chart-owned palette and returns to the selected theme colors.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
+     * const builder = fWorksheet.charts.list()[0];
+     * builder.clearPalette().commit();
+     * ```
+     */
+    clearPalette(): this;
+    /**
+     * Sets the appearance configuration and returns this builder for chaining.
+     *
+     * Supported by Sheet, Document, Slide, and Board chart builders. An explicit
+     * `'transparent'` background remains transparent, and border width `0` hides
+     * the persisted host border without removing selection or transformer chrome.
+     *
+     * This method executes synchronously.
+     *
+     * @param value The semantic value to record.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * builder.setAppearance({
+     *     background: { color: 'transparent' },
+     *     border: { width: 0 },
+     * });
+     * ```
+     */
+    setAppearance(value: IChartAppearanceSpec): this;
+    /**
+     * Clears the appearance configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param target The configuration field to clear or reset.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.clearAppearance(univerAPI.Enum.ChartAppearanceTarget.Background);
+     * ```
+     */
+    clearAppearance(target?: ChartAppearanceTarget): this;
+    /**
+     * Sets the invalid value strategy configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param value The semantic value to record.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.setInvalidValueStrategy(univerAPI.Enum.InvalidValueType.Break);
+     * ```
+     */
+    setInvalidValueStrategy(value: InvalidValueType): this;
+    /**
+     * Restores the invalid value strategy to `Break` and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.resetInvalidValueStrategy();
+     * ```
+     */
+    resetInvalidValueStrategy(): this;
+    /**
+     * Sets the category field configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param index The zero-based field or series index.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.setCategoryField(0);
+     * ```
+     */
+    setCategoryField(index: number): this;
+    /**
+     * Clears the category field configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.clearCategoryField();
+     * ```
+     */
+    clearCategoryField(): this;
+    /**
+     * Sets the value fields configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param indexes The zero-based field indexes.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.setValueFields([1, 2]);
+     * ```
+     */
+    setValueFields(indexes: readonly number[]): this;
+    /**
+     * Clears the value fields configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.clearValueFields();
+     * ```
+     */
+    clearValueFields(): this;
+    /**
+     * Sets the aggregation configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param value The semantic value to record.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.setAggregation({ aggregate: true, topN: 10 });
+     * ```
+     */
+    setAggregation(value: IChartAggregationSpec): this;
+    /**
+     * Clears the aggregation configuration and returns this builder for chaining.
+     *
+     * This method executes synchronously.
+     *
+     * @param target The configuration field to clear or reset.
+     * @returns This builder for chaining.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * builder.clearAggregation(univerAPI.Enum.ChartAggregationTarget.TopN);
+     * ```
+     */
+    clearAggregation(target?: ChartAggregationTarget): this;
+    /**
+     * Sets the chart type and returns a builder specialized for that type.
+     *
+     * This method executes synchronously.
+     *
+     * @param type The canonical chart type.
+     * @returns A new specialized builder that shares this builder's pending configuration.
+     * @example
+     * ```ts
+     * const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
+     * const builder = worksheet.charts.create();
+     * const column = builder.setType(univerAPI.Enum.ChartTypeString.Column);
+     * ```
+     */
+    setType<T extends keyof IChartBuilderTypeMap>(type: T): IChartBuilderTypeMap[T];
+    protected _setType(type: keyof IChartBuilderTypeMap): void;
+}

package/lib/types/facade/f-charts-base.d.ts

@@ -0,0 +1,74 @@
+import type { IEchartTheme } from '@univerjs-pro/engine-chart';
+export interface IChartBuilderHandle {
+    getId(): string;
+}
+export interface IChartBuilderHostTypes {
+    Initial: IChartBuilderHandle;
+    Any: IChartBuilderHandle;
+}
+export declare abstract class FChartsBase<TTypes extends IChartBuilderHostTypes> {
+    /**
+     * Creates a detached chart builder.
+     * @returns A detached builder that does not mutate the host until inserted.
+     * @example
+     * ```ts
+     * const charts = univerAPI.getActiveWorkbook().getActiveSheet().charts;
+     * const chart = charts.create();
+     * ```
+     */
+    abstract create(): TTypes['Initial'];
+    /**
+     * Inserts a detached chart builder into the current host.
+     * @param builder The detached builder returned by this collection.
+     * @returns The inserted builder, preserving its concrete chart and host APIs.
+     * @example
+     * ```ts
+     * const charts = univerAPI.getActiveWorkbook().getActiveSheet().charts;
+     * const chart = charts.create().setSource('A1:B6');
+     * await charts.insert(chart);
+     * ```
+     */
+    abstract insert<T extends TTypes['Any']>(builder: T): Promise<T>;
+    /**
+     * Returns a chart builder by chart ID.
+     * @param chartId The host-owned chart ID.
+     * @returns The chart builder, or `null` when the ID is not in this host.
+     * @example
+     * ```ts
+     * const chart = univerAPI.getActiveWorkbook().getActiveSheet().charts.get('chart-1');
+     * ```
+     */
+    abstract get(chartId: string): TTypes['Any'] | null;
+    /**
+     * Returns all chart builders in the current host.
+     * @returns The chart builders currently owned by this host.
+     * @example
+     * ```ts
+     * const charts = univerAPI.getActiveWorkbook().getActiveSheet().charts.list();
+     * ```
+     */
+    abstract list(): TTypes['Any'][];
+    /**
+     * Removes a chart by builder or chart ID.
+     * @param builderOrId A chart builder from this host or its chart ID.
+     * @returns Whether the host command removed the chart.
+     * @example
+     * ```ts
+     * const charts = univerAPI.getActiveWorkbook().getActiveSheet().charts;
+     * await charts.remove('chart-1');
+     * ```
+     */
+    abstract remove(builderOrId: TTypes['Any'] | string): Promise<boolean>;
+    /**
+     * Registers a chart theme in the shared Univer runtime registry.
+     * @param name The stable theme name used by `setTheme`.
+     * @param theme The ECharts theme definition.
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook().getActiveSheet().charts.registerTheme('brand', {
+     *     color: ['#274060', '#1b998b'],
+     * });
+     * ```
+     */
+    abstract registerTheme(name: string, theme: IEchartTheme): void;
+}

package/lib/types/facade/f-enum.d.ts

@@ -0,0 +1,75 @@
+import { AreaLineStyle, ChartAggregationTarget, ChartAllSeriesStyleTarget, ChartAppearanceTarget, ChartAxisDimension, ChartAxisName, ChartAxisPointerTarget, ChartAxisTarget, ChartAxisTickPosition, ChartMarkLineLabelPosition, ChartSemanticAxis, ChartSeriesAxis, ChartSeriesClearTarget, ChartSeriesTypeString, ChartTrendlineType, ChartTypeString, ChartVisualMapType, ChartWaterfallPointRole, ChartWaterfallStyleTarget, ChartWordCloudShapeSource, InvalidValueType, LabelAlignEnum, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, RelationChartLayoutEnum, SelectModeEnum, SeriesLabelPosition, TitlePositionEnum, WaterfallStackTypeEnum, WordCloudShapeEnum } from '@univerjs-pro/engine-chart';
+import { FEnum } from '@univerjs/core/facade';
+/** @ignore */
+export interface IFChartEnumMixin {
+    ChartAggregationTarget: typeof ChartAggregationTarget;
+    ChartAxisDimension: typeof ChartAxisDimension;
+    ChartTrendlineType: typeof ChartTrendlineType;
+    ChartAppearanceTarget: typeof ChartAppearanceTarget;
+    ChartAxisName: typeof ChartAxisName;
+    ChartAxisPointerTarget: typeof ChartAxisPointerTarget;
+    ChartAxisTarget: typeof ChartAxisTarget;
+    ChartAxisTickPosition: typeof ChartAxisTickPosition;
+    ChartMarkLineLabelPosition: typeof ChartMarkLineLabelPosition;
+    ChartSemanticAxis: typeof ChartSemanticAxis;
+    ChartSeriesAxis: typeof ChartSeriesAxis;
+    ChartSeriesClearTarget: typeof ChartSeriesClearTarget;
+    ChartAllSeriesStyleTarget: typeof ChartAllSeriesStyleTarget;
+    ChartSeriesTypeString: typeof ChartSeriesTypeString;
+    ChartTypeString: typeof ChartTypeString;
+    ChartVisualMapType: typeof ChartVisualMapType;
+    ChartWaterfallStyleTarget: typeof ChartWaterfallStyleTarget;
+    ChartWaterfallPointRole: typeof ChartWaterfallPointRole;
+    ChartWordCloudShapeSource: typeof ChartWordCloudShapeSource;
+    AreaLineStyle: typeof AreaLineStyle;
+    InvalidValueType: typeof InvalidValueType;
+    LabelAlignEnum: typeof LabelAlignEnum;
+    LegendPositionEnum: typeof LegendPositionEnum;
+    LinePointShape: typeof LinePointShape;
+    PieLabelPosition: typeof PieLabelPosition;
+    RadarShape: typeof RadarShape;
+    RelationChartLayoutEnum: typeof RelationChartLayoutEnum;
+    SelectModeEnum: typeof SelectModeEnum;
+    SeriesLabelPosition: typeof SeriesLabelPosition;
+    TitlePositionEnum: typeof TitlePositionEnum;
+    WaterfallStackTypeEnum: typeof WaterfallStackTypeEnum;
+    WordCloudShapeEnum: typeof WordCloudShapeEnum;
+}
+export declare class FChartEnumMixin extends FEnum implements IFChartEnumMixin {
+    get ChartAggregationTarget(): typeof ChartAggregationTarget;
+    get ChartAxisDimension(): typeof ChartAxisDimension;
+    get ChartTrendlineType(): typeof ChartTrendlineType;
+    get ChartAppearanceTarget(): typeof ChartAppearanceTarget;
+    get ChartAxisName(): typeof ChartAxisName;
+    get ChartAxisPointerTarget(): typeof ChartAxisPointerTarget;
+    get ChartAxisTarget(): typeof ChartAxisTarget;
+    get ChartAxisTickPosition(): typeof ChartAxisTickPosition;
+    get ChartMarkLineLabelPosition(): typeof ChartMarkLineLabelPosition;
+    get ChartSemanticAxis(): typeof ChartSemanticAxis;
+    get ChartSeriesAxis(): typeof ChartSeriesAxis;
+    get ChartSeriesClearTarget(): typeof ChartSeriesClearTarget;
+    get ChartAllSeriesStyleTarget(): typeof ChartAllSeriesStyleTarget;
+    get ChartSeriesTypeString(): typeof ChartSeriesTypeString;
+    get ChartTypeString(): typeof ChartTypeString;
+    get ChartVisualMapType(): typeof ChartVisualMapType;
+    get ChartWaterfallStyleTarget(): typeof ChartWaterfallStyleTarget;
+    get ChartWaterfallPointRole(): typeof ChartWaterfallPointRole;
+    get ChartWordCloudShapeSource(): typeof ChartWordCloudShapeSource;
+    get AreaLineStyle(): typeof AreaLineStyle;
+    get InvalidValueType(): typeof InvalidValueType;
+    get LabelAlignEnum(): typeof LabelAlignEnum;
+    get LegendPositionEnum(): typeof LegendPositionEnum;
+    get LinePointShape(): typeof LinePointShape;
+    get PieLabelPosition(): typeof PieLabelPosition;
+    get RadarShape(): typeof RadarShape;
+    get RelationChartLayoutEnum(): typeof RelationChartLayoutEnum;
+    get SelectModeEnum(): typeof SelectModeEnum;
+    get SeriesLabelPosition(): typeof SeriesLabelPosition;
+    get TitlePositionEnum(): typeof TitlePositionEnum;
+    get WaterfallStackTypeEnum(): typeof WaterfallStackTypeEnum;
+    get WordCloudShapeEnum(): typeof WordCloudShapeEnum;
+}
+declare module '@univerjs/core/facade' {
+    interface FEnum extends IFChartEnumMixin {
+    }
+}

package/lib/types/facade/index.d.ts

@@ -0,0 +1,16 @@
+import './register-builders';
+import './f-enum';
+export * from './builders';
+export { getChartBuilderConstructor } from './chart-builder-registry';
+export type { IChartBuilderTypeMap } from './chart-builder-type-map';
+export type { HostAnyChartBuilder, HostChartBuilderOf, HostComposedChartBuilder, IHostChartBuilderTypes } from './chart-host-builder-types';
+export { FAxisChartBuilder } from './f-axis-chart-builder';
+export { FCartesianChartBuilder } from './f-cartesian-chart-builder';
+export { FChartBase } from './f-chart-base';
+export { FChartBuilderBase } from './f-chart-builder-base';
+export { FChartsBase } from './f-charts-base';
+export type { IChartBuilderHostTypes } from './f-charts-base';
+export { getChartBuilderPendingConfig } from './internal/chart-builder-facade-context';
+export { CHART_FACADE_RANDOM_ID_LENGTH } from './internal/constants';
+export { HostBuilderComposer } from './internal/host-builder-composer';
+export type { EngineChartBuilderConstructor } from './internal/host-builder-composer';

package/lib/types/facade/internal/chart-builder-facade-context.d.ts

@@ -0,0 +1,12 @@
+import type { ChartBuilder } from '@univerjs-pro/engine-chart';
+export type ChartFacadeBuilderConstructor<TFacade = unknown> = new (context: IChartBuilderFacadeContext) => TFacade;
+/** Facade-owned wrapping context for one shared chart builder instance. */
+export interface IChartBuilderFacadeContext<TBuilder extends ChartBuilder = ChartBuilder> {
+    readonly builder: TBuilder;
+    wrap<TFacade>(Constructor: ChartFacadeBuilderConstructor<TFacade>): TFacade;
+}
+export declare const ChartBuilderFacadeContextAccess: unique symbol;
+export interface IChartBuilderFacadeContextAccess {
+    readonly [ChartBuilderFacadeContextAccess]: IChartBuilderFacadeContext;
+}
+export declare function wrapChartBuilder<TFacade>(builder: ChartBuilder, Constructor: ChartFacadeBuilderConstructor<TFacade>): TFacade;

package/lib/types/facade/internal/constants.d.ts

@@ -0,0 +1,2 @@
+/** Length used for facade-generated chart, data-source, and host element IDs. */
+export declare const CHART_FACADE_RANDOM_ID_LENGTH = 6;

package/lib/types/facade/internal/host-builder-composer.d.ts

@@ -0,0 +1,16 @@
+import type { ChartBuilder } from '@univerjs-pro/engine-chart';
+import type { HostComposedChartBuilder } from '../chart-host-builder-types';
+import type { FChartBuilderBase } from '../f-chart-builder-base';
+import type { IChartBuilderFacadeContext } from './chart-builder-facade-context';
+export type EngineChartBuilderConstructor<TBuilder extends FChartBuilderBase = FChartBuilderBase> = new (context: IChartBuilderFacadeContext) => TBuilder;
+export declare class HostBuilderComposer<THostMethods extends object> {
+    private readonly _compose;
+    private readonly _cache;
+    constructor(_compose: (Constructor: EngineChartBuilderConstructor) => EngineChartBuilderConstructor<FChartBuilderBase & THostMethods>);
+    compose<TBuilder extends FChartBuilderBase>(Constructor: EngineChartBuilderConstructor<TBuilder>): EngineChartBuilderConstructor<TBuilder & THostMethods>;
+    /**
+     * Creates a host-composed builder whose Facade context preserves host methods
+     * when `setType()` selects another concrete builder class.
+     */
+    create<TBuilder extends FChartBuilderBase>(builder: ChartBuilder, Constructor: EngineChartBuilderConstructor<TBuilder>): HostComposedChartBuilder<TBuilder, THostMethods>;
+}

package/lib/types/facade/register-builders.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/index.d.ts

@@ -1,58 +1,12 @@
-export { chartModelApi } from './chart-model-api/chart-model-api';
-export { buildDonutStyle } from './chart-model-api/chart-type';
-export { chartTypeBitsToName } from './chart-model-api/chart-type';
-export { chartTypeNameToBits } from './chart-model-api/chart-type';
-export { UNSUPPORTED_CHART_TYPE_NAME } from './chart-model-api/chart-type-registry';
-export { CHART_MODEL_API_CAPABILITIES_VERSION } from './chart-model-api/constants';
-export { CHART_MODEL_DEFAULT_DONUT_HOLE } from './chart-model-api/constants';
-export { CHART_MODEL_PATCH_SEMANTICS } from './chart-model-api/constants';
-export { CHART_MODEL_UNSUPPORTED_TYPE_SUGGESTION } from './chart-model-api/constants';
-export { ChartModelChangedGroup } from './chart-model-api/constants';
-export { ChartModelDiagnosticCode } from './chart-model-api/constants';
-export { ChartModelPatchGroup } from './chart-model-api/constants';
-export { ChartModelPatchSemantic } from './chart-model-api/constants';
-export { buildChartModelConfigPatch, buildCreateChartModelConfigPatch } from './chart-model-api/patch-builder';
-export type { ChartAdvancedStylePatch } from './chart-model-api/types';
-export type { ChartAggregationSpec } from './chart-model-api/types';
-export type { ChartAppearanceSpec } from './chart-model-api/types';
-export type { ChartAxesSpec } from './chart-model-api/types';
-export type { ChartAxisSpec } from './chart-model-api/types';
-export type { ChartKnownTypeName } from './chart-model-api/types';
-export type { ChartLegendSpec } from './chart-model-api/types';
-export type { ChartMappingSpec } from './chart-model-api/types';
-export type { ChartModelApi } from './chart-model-api/types';
-export type { ChartModelCapabilities } from './chart-model-api/types';
-export type { ChartModelConfigPatch } from './chart-model-api/types';
-export type { ChartModelCreateSpec } from './chart-model-api/types';
-export type { ChartModelDescription } from './chart-model-api/types';
-export type { ChartModelDiagnostic } from './chart-model-api/types';
-export type { ChartModelInstanceCapabilities } from './chart-model-api/types';
-export type { ChartModelPatch } from './chart-model-api/types';
-export type { ChartModelPatchSemantics } from './chart-model-api/types';
-export type { ChartModelUpdateResult } from './chart-model-api/types';
-export type { ChartParetoSpec } from './chart-model-api/types';
-export type { ChartPieSpec } from './chart-model-api/types';
-export type { ChartRadarSpec } from './chart-model-api/types';
-export type { ChartSeriesDescription } from './chart-model-api/types';
-export type { ChartSeriesPatch } from './chart-model-api/types';
-export type { ChartSeriesSelector } from './chart-model-api/types';
-export type { ChartTitleSpec } from './chart-model-api/types';
-export type { ChartTypeName } from './chart-model-api/types';
-export type { ChartValidationResult } from './chart-model-api/types';
-export type { ChartWordCloudDescription } from './chart-model-api/types';
-export type { ChartWordCloudSpec } from './chart-model-api/types';
-export type { DeepReadonly } from './chart-model-api/types';
-export { createChartModelDiagnostic } from './chart-model-api/utils';
-export { hasChartModelDiagnosticError } from './chart-model-api/utils';
-export { validateChartModelCreateSpec } from './chart-model-api/validate';
-export { validateChartModelPatch } from './chart-model-api/validate';
-export { AreaLineStyle, AxisAlignEnum, AxisValueType, CategoryType, ChartAttributeBits, ChartBorderDashType, ChartSourceDataTypeEnum, ChartTrendlineType, ChartTypeBits, DataOrientation, InvalidValueType, IRuntimeAxisPosition, IRuntimeAxisPriority, LabelAlignEnum, LabelContentType, LegendPositionEnum, LinePointShape, ParetoSeriesIndex, ParetoSeriesPart, PieLabelPosition, RadarShape, RelationChartLayoutEnum, SelectModeEnum, SeriesLabelPosition, StackType, TextAlign, TextVerticalAlign, TitlePositionEnum, WaterfallSeriesTypeEnum, WaterfallStackTypeEnum, WordCloudShapeEnum, } from './enum';
-export type { FAnyChartDescription, FChartDescription, FChartUpdateResult, } from './f-base-chart';
-export { FBaseChart, FBaseCharts, } from './f-base-chart';
+export type { ChartDescription, ChartLegendSpec, ChartPublicSeriesSelector, ChartSeriesSelector, ChartSeriesTrendlineSelector, ChartSubtitleSpec, ChartTitleSpec, IChartAggregationSpec, IChartAppearanceSpec, IChartAreaSpec, IChartAxesSpec, IChartAxisBindingDescription, IChartAxisLabelSpec, IChartAxisPointerSpec, IChartAxisSpec, IChartBarSpec, IChartBubbleMappingSpec, IChartDescription, IChartFontSpec, IChartFunnelSpec, IChartHeatmapLabelSpec, IChartHeatmapSpec, IChartLegendOptions, IChartMappingSpec, IChartMarkLineLabelSpec, IChartMarkLineSpec, IChartParetoBarLabelStyleSpec, IChartParetoBarStyleSpec, IChartParetoBorderStyleSpec, IChartParetoLineLabelStyleSpec, IChartParetoLineStyleSpec, IChartParetoPointStyleSpec, IChartParetoSpec, IChartPieLabelSpec, IChartPieSpec, IChartRadarSpec, IChartRelationForceSpec, IChartRelationSpec, IChartScatterMappingSpec, IChartSeriesBorderSpec, IChartSeriesDescription, IChartSeriesLabelSpec, IChartSeriesPatch, IChartSeriesPointSpec, IChartSeriesStyleSpec, IChartSubtitleOptions, IChartTitleOptions, IChartTrendlineSpec, IChartWaterfallConnectorStyleSpec, IChartWaterfallPointRoleSpec, IChartWaterfallSpec, IChartWordCloudDescription, IChartWordCloudSpec, IInlineChartBuilderAdapter, IInlineChartHostPatch, IResolvedChartData, } from './chart-builder';
+export { AREA_CHART_TYPES, AXIS_CHART_TYPES, CARTESIAN_CHART_TYPES, ChartAggregationTarget, ChartAllSeriesStyleTarget, ChartAppearanceTarget, ChartAxisName, ChartAxisPointerTarget, ChartAxisTarget, ChartAxisTickPosition, ChartSeriesAxis, ChartSeriesClearTarget, ChartSeriesTypeString, ChartTypeString, ChartVisualMapType, ChartWaterfallStyleTarget, ChartWordCloudShapeSource, DEFAULT_CHART_TYPE, } from './chart-builder';
+export { ChartBuilder, chartTypeToBits, clearAggregation, clearAllSeriesStyle, clearAppearance, clearAreaLineStyle, clearAxisPointer, clearAxisTitle, clearBar, clearBubbleMapping, clearCategoryField, clearCellLabel, clearCumulativeLineStyle, clearDoughnutHole, clearLegend, clearLineStyle, clearMarkLines, clearPalette, clearMaskImage, clearParetoBarStyle, clearPieLabel, clearRelationForce, clearRightYAxis, clearScatterMapping, clearSeries, clearSliceBorderColor, clearSubtitle, clearTheme, clearTitle, clearTrendlines, clearValueFields, clearValueRange, clearValueSuffix, clearValueUnit, clearWaterfallConnector, clearWaterfallStyle, clearXAxis, clearYAxis, describeChartModel, DetachedChartBuilderAdapter, InlineChartBuilder, removeTrendline, resetCircularLabelRotation, resetCombinationSeriesAxis, resetCombinationSeriesType, resetDecimalPlaces, resetEmphasisEnabled, resetExplosion, resetFunnelGap, resetHalfPie, resetIncludeZeroValues, resetInvalidValueStrategy, resetLabelLineVisible, resetPaddingAngleEnabled, resetRadarFill, resetRadarShape, resetRelationLayout, resetRelationNodeShape, resetRosePie, resetUseAbsoluteValue, resetUseDateAxis, resetUseSubtotal, resetUseValueAsSymbolSize, resetValueScale, resetVisualMapType, resetWaterfallStackType, resetWordCloudRepeat, resetWordCloudShape, resolveChartDescriptionMetadata, resolveChartModelData, resolveInlineChartDataSet, setAggregation, setAllSeriesStyle, setAppearance, setAreaLineStyle, setAxisPointer, setAxisTitle, setBar, setBubbleMapping, setCategoryField, setCellLabel, setCircularLabelRotation, setCombinationSeriesAxis, setCombinationSeriesType, setCumulativeLineStyle, setDecimalPlaces, setDoughnutHole, setEmphasisEnabled, setExplosion, setFunnelGap, setHalfPie, setIncludeZeroValues, setInvalidValueStrategy, setLabelLineVisible, setLegend, setLineStyle, setMarkLines, setMaskImage, setPaddingAngleEnabled, setPalette, setParetoBarStyle, setPieLabel, setRadarFill, setRadarShape, setRelationForce, setRelationLayout, setRelationNodeShape, setRightYAxis, setRosePie, setScatterMapping, setSeries, setSliceBorderColor, setSubtitle, setTheme, setTitle, setTrendline, setUseAbsoluteValue, setUseDateAxis, setUseSubtotal, setUseValueAsSymbolSize, setValueFields, setValueRange, setValueScale, setValueSuffix, setValueUnit, setVisualMapType, setWaterfallConnector, setWaterfallPointRoles, setWaterfallStackType, setWaterfallStyle, setWordCloudRepeat, setWordCloudShape, setXAxis, setYAxis, toChartModelConfig, toCompleteChartModelConfig, } from './chart-builder';
+export type { ChartPendingConfig, ChartTrendlineSelector, ChartTrendlineValue, IChartBuilderAdapter, IChartCreateConfig, } from './chart-builder';
+export { AreaLineStyle, BarShape, AxisAlignEnum, AxisValueType, CategoryType, ChartAttributeBits, ChartAxisDimension, ChartBorderDashType, ChartMarkLineLabelPosition, ChartSemanticAxis, ChartSourceDataTypeEnum, ChartTrendlineType, ChartTypeBits, ChartWaterfallPointRole, DataOrientation, InvalidValueType, IRuntimeAxisPosition, IRuntimeAxisPriority, LabelAlignEnum, LabelContentType, LegendPositionEnum, LinePointShape, ParetoSeriesIndex, ParetoSeriesPart, PieLabelPosition, RadarShape, RelationChartLayoutEnum, SelectModeEnum, SeriesLabelPosition, StackType, TextAlign, TextVerticalAlign, TitlePositionEnum, WaterfallSeriesTypeEnum, WaterfallStackTypeEnum, WordCloudShapeEnum, } from './enum';
 export { buildChartData, RelationColumnIndex } from './models/chart-data-operators/build-chart-data';
 export { CartesianPointRoleIndex, CartesianPointValueIndex } from './models/chart-data-operators/cartesian-point-data';
 export { defaultChartContextOperators, findCategoryIndexes, findCategoryOperator, findHeaderOperator, findSeriesOperator, generateChartModelContextByOperators, pieSeriesFilterOperator, } from './models/chart-data-operators/operators';
-export { CHART_HOST_DEFAULT_BORDER_COLOR, CHART_HOST_DEFAULT_BORDER_RADIUS, CHART_HOST_DEFAULT_BORDER_WIDTH, composeChartHostFrameImage, getChartHostFrameContentRect, resolveDefaultChartHostFrameStyle, resolveChartHostFrameStyle, shouldComposeChartHostFrame, } from './models/chart-host-style';
+export { CHART_HOST_DEFAULT_BORDER_COLOR, CHART_HOST_DEFAULT_BORDER_RADIUS, CHART_HOST_DEFAULT_BORDER_WIDTH, composeChartHostFrameImage, getChartHostFrameContentRect, resolveChartHostFrameBorder, resolveChartHostFrameStyle, resolveDefaultChartHostFrameStyle, shouldComposeChartHostFrame, } from './models/chart-host-style';
 export type { IResolveChartHostFrameStyleInput, IResolveDefaultChartHostFrameStyleInput, } from './models/chart-host-style';
 export type { IChartLocaleTexts } from './models/chart-locale-texts';
 export { getDefaultChartLocaleTexts, replaceLocaleParams } from './models/chart-locale-texts';
@@ -60,6 +14,7 @@ export { CHART_DEBOUNCE_TIME, ChartModel, } from './models/chart-model';
 export { resolveChartRenderModelImageExportInput } from './models/chart-render-input-resolver';
 export type { IChartRenderInputRuntime, IResolveChartRenderModelImageExportInputParams, } from './models/chart-render-input-resolver';
 export { ChartRenderModelManagerService, IChartRenderModelManagerService, registerChartRenderModelManagerService, } from './models/chart-render-model-manager.service';
+export { serializeChartResource } from './models/chart-resource-serializer';
 export { resolveChartRuntimeStyle, resolveChartStyleBackgroundColor, } from './models/chart-runtime-style';
 export { ChartThemeService, registerChartThemeService, } from './models/chart-theme.service';
 export { getThemeAxesByType } from './models/constants/build-in-theme';
@@ -76,11 +31,12 @@ export type { IChartModelInitParams } from './models/mode-converter/mode-convert
 export { convertModelFromInitData, convertModelToSpec, } from './models/mode-converter/mode-converter';
 export { OffscreenChartHost } from './models/offscreen-chart-host';
 export { registerWordCloudChartMakImageService, WordCloudMuskImageService, } from './models/word-cloud-musk-image.service';
+export { toChartDataItem } from './source/chart-data-item';
 export { ChartDataSource } from './source/chart-source';
 export { StaticChartSource } from './source/static-chart-source';
 export { ChartHostRenderMode, ChartImageSourceType } from './types';
-export type { ChartDataSourceValue, ChartDataSourceValues, ChartDirection, ChartElementEventHandler, ChartElementEventType, ChartElementKind, ChartImageSource, ChartStyle, DeepPartial, DimensionDefinitionLoose, IAllSeriesStyle, IAxisOptions, IChartConfig, IChartContext, IChartData, IChartDataAggregation, IChartDataCategory, IChartDataSeries, IChartDataSource, IChartElementBounds, IChartElementEvent, IChartElementHit, IChartElementOverlay, IChartHost, IChartHostBorderStyle, IChartHostLease, IChartHostRect, IChartHostStyle, IChartInstance, IChartRenderAsImageOptions, IChartRenderInput, IChartRenderInstance, IChartRenderInstanceCreateContext, IChartRenderInstanceSpecInput, IChartRenderInstanceStyleInput, IChartRenderModel, IChartRenderModelImageExportInput, IChartRenderModelImageExportOptions, IChartRenderModelImageExportResult, IChartSnapshot, IChartStyle, IDimensionDefinition, IDomChartHost, IGridLineStyle, IImageChartHost, ILabelStyle, ILegendStyle, IPieLabelStyle, IPointStyle, IRelationForceOptions, IRuntimeAxis, ISeriesLabelStyle, ISeriesStyle, ITrendLine, IUniverDataSet, OptionDataValue, RightYAxisOptions, } from './types';
-export { chartBitsUtils, chartTypeCanUseTrendLine, } from './util';
+export type { ChartDataSourceValue, ChartDataSourceValues, ChartDirection, ChartElementEventHandler, ChartElementEventType, ChartElementKind, ChartImageSource, ChartStyle, DeepPartial, DimensionDefinitionLoose, IAllSeriesStyle, IAxisOptions, IBarStyle, IChartConfig, IChartContext, IChartData, IChartDataAggregation, IChartDataCategory, IChartDataSeries, IChartDataSource, IChartElementBounds, IChartElementEvent, IChartElementHit, IChartElementOverlay, IChartHost, IChartHostBorderStyle, IChartHostLease, IChartHostRect, IChartHostStyle, IChartInstance, IChartRenderAsImageOptions, IChartRenderInput, IChartRenderInstance, IChartRenderInstanceCreateContext, IChartRenderInstanceSpecInput, IChartRenderInstanceStyleInput, IChartRenderModel, IChartRenderModelImageExportInput, IChartRenderModelImageExportOptions, IChartRenderModelImageExportResult, IChartSnapshot, IChartStyle, IDimensionDefinition, IDomChartHost, IGridLineStyle, IImageChartHost, ILabelStyle, ILegendStyle, IPieLabelStyle, IPointStyle, IRelationForceOptions, IRuntimeAxis, ISeriesLabelStyle, ISeriesStyle, ITrendLine, IUniverDataSet, OptionDataValue, RightYAxisOptions, } from './types';
+export { chartBitsUtils, chartTypeCanUseTrendLine, mergeChartConfig, } from './util';
 export * from './utils/echarts';
 export { WordCloudResourceConfig } from './word-cloud-resource/word-cloud-resource-config';
 export { WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './wordcloud-chart/adapters/echarts/echarts-options';

package/lib/types/models/chart-host-style.d.ts

@@ -1,4 +1,4 @@
-import type { ChartImageSource, ChartStyle, IChartHostRect, IChartHostStyle } from '../types';
+import type { ChartImageSource, ChartStyle, IChartHostBorderStyle, IChartHostRect, IChartHostStyle } from '../types';
 export interface IResolveChartHostFrameStyleInput {
     style?: ChartStyle | null;
     getRenderColor?: (color: string) => string;
@@ -32,4 +32,9 @@ export declare function resolveDefaultChartHostFrameStyle(input: IResolveDefault
 export declare function getChartHostFrameContentRect(outer: IChartHostRect, hostStyle: IChartHostStyle): IChartHostContentRect;
 export declare function shouldComposeChartHostFrame(hostStyle: IChartHostStyle): boolean;
 export declare function composeChartHostFrameImage(image: ChartImageSource, outer: IChartHostRect, hostStyle: IChartHostStyle): ChartImageSource;
+/**
+ * Resolves the canonical border consumed by every chart host frame renderer.
+ * Missing or empty colors and non-positive or non-finite widths disable the border.
+ */
+export declare function resolveChartHostFrameBorder(hostStyle: IChartHostStyle): Required<IChartHostBorderStyle> | undefined;
 export {};