@univerjs-pro/engine-chart 1.0.0-alpha.8 → 1.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -3
- package/lib/cjs/facade.js +1 -1
- package/lib/cjs/index.js +1 -1
- package/lib/cjs/locale/ar-SA.js +1 -0
- package/lib/cjs/locale/ca-ES.js +1 -0
- package/lib/cjs/locale/de-DE.js +1 -0
- package/lib/cjs/locale/en-US.js +1 -0
- package/lib/cjs/locale/es-ES.js +1 -0
- package/lib/cjs/locale/fa-IR.js +1 -0
- package/lib/cjs/locale/fr-FR.js +1 -0
- package/lib/cjs/locale/id-ID.js +1 -0
- package/lib/cjs/locale/it-IT.js +1 -0
- package/lib/cjs/locale/ja-JP.js +1 -0
- package/lib/cjs/locale/ko-KR.js +1 -0
- package/lib/cjs/locale/pl-PL.js +1 -0
- package/lib/cjs/locale/pt-BR.js +1 -0
- package/lib/cjs/locale/ru-RU.js +1 -0
- package/lib/cjs/locale/sk-SK.js +1 -0
- package/lib/cjs/locale/vi-VN.js +1 -0
- package/lib/cjs/locale/zh-CN.js +1 -0
- package/lib/cjs/locale/zh-HK.js +1 -0
- package/lib/cjs/locale/zh-TW.js +1 -0
- package/lib/es/facade.js +1 -1
- package/lib/es/index.js +1 -1
- package/lib/es/locale/ar-SA.js +1 -0
- package/lib/es/locale/ca-ES.js +1 -0
- package/lib/es/locale/de-DE.js +1 -0
- package/lib/es/locale/en-US.js +1 -0
- package/lib/es/locale/es-ES.js +1 -0
- package/lib/es/locale/fa-IR.js +1 -0
- package/lib/es/locale/fr-FR.js +1 -0
- package/lib/es/locale/id-ID.js +1 -0
- package/lib/es/locale/it-IT.js +1 -0
- package/lib/es/locale/ja-JP.js +1 -0
- package/lib/es/locale/ko-KR.js +1 -0
- package/lib/es/locale/pl-PL.js +1 -0
- package/lib/es/locale/pt-BR.js +1 -0
- package/lib/es/locale/ru-RU.js +1 -0
- package/lib/es/locale/sk-SK.js +1 -0
- package/lib/es/locale/vi-VN.js +1 -0
- package/lib/es/locale/zh-CN.js +1 -0
- package/lib/es/locale/zh-HK.js +1 -0
- package/lib/es/locale/zh-TW.js +1 -0
- package/lib/facade.js +1 -1
- package/lib/index.js +1 -1
- package/lib/locale/ar-SA.js +1 -0
- package/lib/locale/ca-ES.js +1 -0
- package/lib/locale/de-DE.js +1 -0
- package/lib/locale/en-US.js +1 -0
- package/lib/locale/es-ES.js +1 -0
- package/lib/locale/fa-IR.js +1 -0
- package/lib/locale/fr-FR.js +1 -0
- package/lib/locale/id-ID.js +1 -0
- package/lib/locale/it-IT.js +1 -0
- package/lib/locale/ja-JP.js +1 -0
- package/lib/locale/ko-KR.js +1 -0
- package/lib/locale/pl-PL.js +1 -0
- package/lib/locale/pt-BR.js +1 -0
- package/lib/locale/ru-RU.js +1 -0
- package/lib/locale/sk-SK.js +1 -0
- package/lib/locale/vi-VN.js +1 -0
- package/lib/locale/zh-CN.js +1 -0
- package/lib/locale/zh-HK.js +1 -0
- package/lib/locale/zh-TW.js +1 -0
- package/lib/types/chart-builder/chart-builder-adapter.d.ts +1 -3
- package/lib/types/chart-builder/chart-builder.d.ts +4 -6
- package/lib/types/chart-builder/chart-live-adapter.d.ts +15 -0
- package/lib/types/chart-builder/chart-starter-data.d.ts +3 -2
- package/lib/types/chart-builder/chart-types.d.ts +129 -13
- package/lib/types/chart-builder/configuration/assertions.d.ts +2 -0
- package/lib/types/chart-builder/configuration/cartesian-series.d.ts +3 -1
- package/lib/types/chart-builder/configuration/chart-config-group.d.ts +38 -0
- package/lib/types/chart-builder/configuration/chart-config-operation.d.ts +1 -33
- package/lib/types/chart-builder/configuration/chord.d.ts +12 -0
- package/lib/types/chart-builder/configuration/gauge.d.ts +31 -0
- package/lib/types/chart-builder/configuration/pie.d.ts +5 -6
- package/lib/types/chart-builder/configuration/sunburst.d.ts +7 -0
- package/lib/types/chart-builder/configuration/treemap.d.ts +2 -2
- package/lib/types/chart-builder/configuration/waterfall.d.ts +3 -1
- package/lib/types/chart-builder/conversion/chart-config-converter.d.ts +25 -10
- package/lib/types/chart-builder/conversion/chart-context-patch.d.ts +1 -1
- package/lib/types/chart-builder/conversion/chart-create-config.d.ts +6 -0
- package/lib/types/chart-builder/conversion/chart-model-fields.d.ts +25 -7
- package/lib/types/chart-builder/conversion/chart-type-converter.d.ts +3 -1
- package/lib/types/chart-builder/conversion/describe-chart-model.d.ts +1419 -7
- package/lib/types/chart-builder/conversion/resolve-chart-model-data.d.ts +2 -2
- package/lib/types/chart-builder/detached-chart-builder-adapter.d.ts +4 -4
- package/lib/types/chart-builder/internal/apply-pending-to-description.d.ts +2 -0
- package/lib/types/chart-builder/internal/chart-host-config-adapter.d.ts +3 -0
- package/lib/types/chart-builder/internal/chart-patch-replace-policy.d.ts +6 -0
- package/lib/types/chart-builder/internal/chart-pending-patch.d.ts +11 -0
- package/lib/types/chart-builder/internal/patch-interpreter.d.ts +17 -0
- package/lib/types/chart-data-aggregation.d.ts +10 -0
- package/lib/types/config/config.d.ts +7 -0
- package/lib/types/enum.d.ts +45 -2
- package/lib/types/facade/builders/f-area-chart-builder.d.ts +52 -7
- package/lib/types/facade/builders/f-boxplot-chart-builder.d.ts +88 -3
- package/lib/types/facade/builders/f-bubble-chart-builder.d.ts +59 -6
- package/lib/types/facade/builders/f-candlestick-chart-builder.d.ts +90 -31
- package/lib/types/facade/builders/f-chord-chart-builder.d.ts +202 -0
- package/lib/types/facade/builders/f-combination-chart-builder.d.ts +55 -10
- package/lib/types/facade/builders/f-funnel-chart-builder.d.ts +55 -9
- package/lib/types/facade/builders/f-gauge-chart-builder.d.ts +420 -0
- package/lib/types/facade/builders/f-heatmap-chart-builder.d.ts +83 -26
- package/lib/types/facade/builders/f-histogram-chart-builder.d.ts +142 -16
- package/lib/types/facade/builders/f-line-chart-builder.d.ts +51 -6
- package/lib/types/facade/builders/f-pareto-chart-builder.d.ts +83 -20
- package/lib/types/facade/builders/f-pie-chart-builder.d.ts +134 -107
- package/lib/types/facade/builders/f-radar-chart-builder.d.ts +64 -11
- package/lib/types/facade/builders/f-relation-chart-builder.d.ts +72 -38
- package/lib/types/facade/builders/f-scatter-chart-builder.d.ts +58 -6
- package/lib/types/facade/builders/f-sunburst-chart-builder.d.ts +138 -0
- package/lib/types/facade/builders/f-treemap-chart-builder.d.ts +116 -14
- package/lib/types/facade/builders/f-waterfall-chart-builder.d.ts +87 -53
- package/lib/types/facade/builders/f-word-cloud-chart-builder.d.ts +64 -15
- package/lib/types/facade/chart-builder-registry.d.ts +4 -4
- package/lib/types/facade/chart-builder-type-map.d.ts +55 -30
- package/lib/types/facade/chart-host-builder-types.d.ts +2 -21
- package/lib/types/facade/create-chart-builder.d.ts +46 -0
- package/lib/types/facade/f-axis-chart-builder.d.ts +21 -38
- package/lib/types/facade/f-cartesian-chart-builder.d.ts +34 -22
- package/lib/types/facade/f-chart-builder-base.d.ts +206 -74
- package/lib/types/facade/f-chart.d.ts +652 -0
- package/lib/types/facade/f-enum.d.ts +686 -31
- package/lib/types/facade/f-univer.d.ts +51 -0
- package/lib/types/facade/index.d.ts +27 -10
- package/lib/types/facade/internal/chart-builder-facade-context.d.ts +11 -10
- package/lib/types/index.d.ts +131 -39
- package/lib/types/locale/ar-SA.d.ts +3 -0
- package/lib/types/locale/ca-ES.d.ts +3 -0
- package/lib/types/locale/de-DE.d.ts +3 -0
- package/lib/types/locale/en-US.d.ts +46 -0
- package/lib/types/locale/es-ES.d.ts +3 -0
- package/lib/types/locale/fa-IR.d.ts +3 -0
- package/lib/types/locale/fr-FR.d.ts +3 -0
- package/lib/types/locale/id-ID.d.ts +3 -0
- package/lib/types/locale/it-IT.d.ts +3 -0
- package/lib/types/locale/ja-JP.d.ts +3 -0
- package/lib/types/locale/ko-KR.d.ts +3 -0
- package/lib/types/locale/pl-PL.d.ts +3 -0
- package/lib/types/locale/pt-BR.d.ts +3 -0
- package/lib/types/locale/ru-RU.d.ts +3 -0
- package/lib/types/locale/sk-SK.d.ts +3 -0
- package/lib/types/locale/types.d.ts +3 -0
- package/lib/types/locale/vi-VN.d.ts +3 -0
- package/lib/types/locale/zh-CN.d.ts +3 -0
- package/lib/types/locale/zh-HK.d.ts +3 -0
- package/lib/types/locale/zh-TW.d.ts +3 -0
- package/lib/types/models/{chart-semantic-axes.d.ts → chart-context/axes/chart-semantic-axes.d.ts} +2 -2
- package/lib/types/models/chart-context/chart-field-selection.d.ts +21 -0
- package/lib/types/models/chart-context/resolve-chart-context.d.ts +5 -0
- package/lib/types/models/chart-data/build-chart-data.d.ts +5 -0
- package/lib/types/models/chart-data/builders/boxplot-chart-data.d.ts +4 -0
- package/lib/types/models/chart-data/builders/candlestick-chart-data.d.ts +4 -0
- package/lib/types/models/chart-data/builders/cartesian-point-chart-data.d.ts +5 -0
- package/lib/types/models/chart-data/builders/category-series-chart-data.d.ts +5 -0
- package/lib/types/models/chart-data/builders/chord-chart-data.d.ts +4 -0
- package/lib/types/models/chart-data/builders/gauge-chart-data.d.ts +4 -0
- package/lib/types/models/chart-data/builders/heatmap-chart-data.d.ts +3 -0
- package/lib/types/models/chart-data/builders/hierarchy-chart-data.d.ts +5 -0
- package/lib/types/models/chart-data/builders/histogram-chart-data.d.ts +4 -0
- package/lib/types/models/chart-data/builders/relation-chart-data.d.ts +3 -0
- package/lib/types/models/chart-data/builders/sankey-chart-data.d.ts +3 -0
- package/lib/types/models/chart-data/chart-field-consumption-validator.d.ts +15 -0
- package/lib/types/models/chart-data/chart-field-consumption.d.ts +4 -0
- package/lib/types/models/chart-data/chart-field-requirements.d.ts +7 -0
- package/lib/types/models/chart-data/get-chart-data-builder.d.ts +7 -0
- package/lib/types/models/chart-data/internal/aggregate-number-format.d.ts +8 -0
- package/lib/types/models/{chart-data-operators → chart-data/internal}/cartesian-point-data.d.ts +3 -8
- package/lib/types/models/chart-data/internal/category-data.d.ts +3 -0
- package/lib/types/models/chart-data/internal/category-series-aggregation.d.ts +10 -0
- package/lib/types/models/chart-data/internal/chart-data-result.d.ts +5 -0
- package/lib/types/models/chart-data/internal/chart-hierarchy-data.d.ts +1 -0
- package/lib/types/models/chart-data/internal/chord-data.d.ts +7 -0
- package/lib/types/models/chart-data/internal/data-set-accessors.d.ts +7 -0
- package/lib/types/models/chart-data/internal/gauge-data.d.ts +5 -0
- package/lib/types/models/{chart-data-operators/histogram-data.d.ts → chart-data/internal/histogram-bins.d.ts} +1 -1
- package/lib/types/models/chart-data/internal/relation-data-shape.d.ts +2 -0
- package/lib/types/models/chart-data/internal/source-cell-label.d.ts +3 -0
- package/lib/types/models/chart-data/internal/sunburst-data.d.ts +4 -0
- package/lib/types/models/chart-data/internal/treemap-data.d.ts +4 -0
- package/lib/types/models/chart-data/pie-composite/pie-composite-projection.d.ts +36 -0
- package/lib/types/models/chart-data/pie-composite/pie-composite-render-metadata.d.ts +15 -0
- package/lib/types/models/chart-data/pie-composite/pie-composite-spec.d.ts +38 -0
- package/lib/types/models/{chart-host-style.d.ts → chart-host/chart-host-style.d.ts} +1 -1
- package/lib/types/models/chart-host/config/chart-config-interpreter.d.ts +13 -0
- package/lib/types/models/{image-chart-host.d.ts → chart-host/image-chart-host.d.ts} +14 -2
- package/lib/types/models/{offscreen-chart-host.d.ts → chart-host/offscreen-chart-host.d.ts} +1 -1
- package/lib/types/models/chart-host/resource/chart-data-source-resolver.d.ts +58 -0
- package/lib/types/models/chart-host/resource/chart-resource-repository.d.ts +111 -0
- package/lib/types/models/{chart-resource-serializer.d.ts → chart-host/resource/chart-resource-serializer.d.ts} +3 -2
- package/lib/types/models/chart-host/resource/inline-chart-table.d.ts +5 -0
- package/lib/types/models/chart-host/resource/persisted-chart-style.d.ts +3 -0
- package/lib/types/models/chart-host/resource/resource-ref-chart-data-source.adapter.d.ts +22 -0
- package/lib/types/models/chart-host/resource/resource-ref-chart-data-source.provider.d.ts +12 -0
- package/lib/types/models/chart-host/static/chart-model-store.d.ts +56 -0
- package/lib/types/models/chart-host/static/chart-runtime.d.ts +27 -0
- package/lib/types/models/{chart-model.d.ts → chart-model/chart-model.d.ts} +1415 -947
- package/lib/types/models/{echart-to-chart-model-init.d.ts → chart-model/echart-to-chart-model-init.d.ts} +2 -2
- package/lib/types/models/{data-context-transformers/bar-data-context-transformer.d.ts → chart-model/type-transition/bar-type-transition.d.ts} +1 -1
- package/lib/types/models/{data-context-transformers/line-like-context-transformer.d.ts → chart-model/type-transition/line-like-type-transition.d.ts} +1 -1
- package/lib/types/models/{data-context-transformers/percent-data-context-transformer.d.ts → chart-model/type-transition/percent-type-transition.d.ts} +1 -1
- package/lib/types/models/{chart-element-axis-id.d.ts → chart-render/axes/chart-element-axis-id.d.ts} +1 -1
- package/lib/types/models/{chart-runtime-axes.d.ts → chart-render/axes/chart-runtime-axes.d.ts} +4 -4
- package/lib/types/models/{chart-render-input-resolver.d.ts → chart-render/chart-render-input-resolver.d.ts} +3 -3
- package/lib/types/models/{chart-render-model-manager.service.d.ts → chart-render/chart-render-model-manager.service.d.ts} +2 -3
- package/lib/types/models/chart-render/converter/converters/boxplot-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/bubble-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/candlestick-chart-converter.d.ts +4 -0
- package/lib/types/models/chart-render/converter/converters/chord-chart-converter.d.ts +10 -0
- package/lib/types/models/chart-render/converter/converters/combination-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/funnel-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/gauge-chart-converter.d.ts +20 -0
- package/lib/types/models/chart-render/converter/converters/heatmap-chart-convert.d.ts +2 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/converters/histogram-chart-converter.d.ts +2 -3
- package/lib/types/models/chart-render/converter/converters/pareto-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/pie-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/radar-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/relation-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/sankey-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/scatter-chart-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/converters/sunburst-chart-converter.d.ts +3 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/converters/tools.d.ts +1 -1
- package/lib/types/models/chart-render/converter/converters/treemap-chart-converter.d.ts +3 -0
- package/lib/types/models/chart-render/converter/converters/waterfall-chart-converter.d.ts +2 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/converters/waterfall-layout.d.ts +2 -2
- package/lib/types/models/chart-render/converter/converters/word-cloud-converter.d.ts +2 -0
- package/lib/types/models/chart-render/converter/echart-text-overflow.d.ts +7 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/mode-converter.d.ts +3 -5
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/auto-gradient-presets.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/axis-title.operator.d.ts +1 -1
- package/lib/types/models/chart-render/converter/render-spec-operators/bar-layout.operator.d.ts +3 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/bubble-style.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter/render-spec-operators/trend-line/trend-line.operator.d.ts → chart-render/converter/render-spec-operators/chart-axes.operator.d.ts} +1 -1
- package/lib/types/models/{mode-converter/render-spec-operators/relation-chart-operator/relation-chart-operator.d.ts → chart-render/converter/render-spec-operators/chart-box-style.operator.d.ts} +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/chart-color.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/empty-style-operator.d.ts +1 -1
- package/lib/types/models/chart-render/converter/render-spec-operators/font-size.operator.d.ts +2 -0
- package/lib/types/models/chart-render/converter/render-spec-operators/grid-operator.d.ts +12 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/heatmap-chart-operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/hover-mark-style.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/implicit-category-axis.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter/render-spec-operators/series-style-operator/pareto-series-style.handler.d.ts → chart-render/converter/render-spec-operators/invalid-value-style.operator.d.ts} +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/legend-size.d.ts +1 -2
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/legend-style.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/line-like-style.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/mark-line.operator.d.ts +1 -1
- package/lib/types/models/chart-render/converter/render-spec-operators/pie-composite-layout.operator.d.ts +2 -0
- package/lib/types/models/chart-render/converter/render-spec-operators/pie-style.operator.d.ts +2 -0
- package/lib/types/models/chart-render/converter/render-spec-operators/plot-area.d.ts +10 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/radar-style.operator.d.ts +1 -1
- package/lib/types/models/chart-render/converter/render-spec-operators/relation-chart-operator/relation-chart-operator.d.ts +2 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/rich-text-inheritance.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/rtl-render-spec.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/sankey-chart-operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/scatter-style.operator.d.ts +1 -1
- package/lib/types/models/chart-render/converter/render-spec-operators/series-style-operator/pareto-series-style.handler.d.ts +2 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/series-style-operator/series-style-operator.d.ts +3 -3
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/series-style-operator/waterfall-series-style-operator.d.ts +1 -1
- package/lib/types/models/chart-render/converter/render-spec-operators/stack.operator.d.ts +2 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/theme.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/title-style.operator.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/tool-tip-operator.d.ts +6 -17
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/tool-tip-renderer.d.ts +1 -1
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/tools.d.ts +5 -7
- package/lib/types/models/chart-render/converter/render-spec-operators/trend-line/trend-line.operator.d.ts +2 -0
- package/lib/types/models/chart-render/converter/render-spec-operators/visual-map-operator.d.ts +6 -0
- package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/watermark.operator.d.ts +1 -1
- package/lib/types/models/{echart-render-model.d.ts → chart-render/echart-render-model.d.ts} +22 -12
- package/lib/types/models/{chart-element-edit-overlay → chart-render/edit-overlay}/chart-element-edit-overlay.d.ts +2 -2
- package/lib/types/models/{chart-element-edit-overlay → chart-render/edit-overlay}/resolve-chart-element-hit-layout.d.ts +2 -2
- package/lib/types/models/{chart-element-edit-overlay → chart-render/edit-overlay}/types.d.ts +1 -1
- package/lib/types/models/chart-render/format/chart-value-format.d.ts +16 -0
- package/lib/types/models/{chart-runtime-style.d.ts → chart-render/style/chart-runtime-style.d.ts} +3 -3
- package/lib/types/models/common/chart-field-diagnostic.d.ts +14 -0
- package/lib/types/models/common/chart-field-role.d.ts +53 -0
- package/lib/types/models/common/chart-locale-texts.d.ts +44 -0
- package/lib/types/models/common/constants/chord.d.ts +5 -0
- package/lib/types/models/common/constants/default-chart-style.d.ts +920 -0
- package/lib/types/models/{constants → common/constants}/default.d.ts +3 -2
- package/lib/types/models/common/constants/hierarchy.d.ts +5 -0
- package/lib/types/models/common/constants/histogram-defaults.d.ts +8 -0
- package/lib/types/models/common/constants/treemap.d.ts +1 -0
- package/lib/types/models/common/theme/build-in-theme/theme-util.d.ts +4 -0
- package/lib/types/models/{chart-theme.service.d.ts → common/theme/chart-theme.service.d.ts} +1 -3
- package/lib/types/plugin.d.ts +15 -0
- package/lib/types/types.d.ts +307 -39
- package/lib/types/util.d.ts +1 -1
- package/lib/types/utils/compact.d.ts +6 -0
- package/lib/types/utils/echarts.d.ts +0 -1
- package/lib/types/word-cloud-resource/word-cloud-resource-config.d.ts +5 -0
- package/lib/types/wordcloud-chart/adapters/echarts/chart-view.d.ts +0 -2
- package/lib/types/wordcloud-chart/adapters/echarts/echarts-options.d.ts +1 -1
- package/lib/types/wordcloud-chart/adapters/echarts/layout-register.d.ts +0 -2
- package/lib/types/wordcloud-chart/adapters/echarts/series-model.d.ts +0 -2
- package/lib/types/wordcloud-chart/adapters/echarts/text-measurer.d.ts +1 -1
- package/lib/types/wordcloud-chart/core/collision/box-shape-engine.d.ts +1 -1
- package/lib/types/wordcloud-chart/word-cloud-render-config.d.ts +1 -0
- package/lib/umd/facade.js +1 -1
- package/lib/umd/index.js +1 -1
- package/lib/umd/locale/ar-SA.js +1 -0
- package/lib/umd/locale/ca-ES.js +1 -0
- package/lib/umd/locale/de-DE.js +1 -0
- package/lib/umd/locale/en-US.js +1 -0
- package/lib/umd/locale/es-ES.js +1 -0
- package/lib/umd/locale/fa-IR.js +1 -0
- package/lib/umd/locale/fr-FR.js +1 -0
- package/lib/umd/locale/id-ID.js +1 -0
- package/lib/umd/locale/it-IT.js +1 -0
- package/lib/umd/locale/ja-JP.js +1 -0
- package/lib/umd/locale/ko-KR.js +1 -0
- package/lib/umd/locale/pl-PL.js +1 -0
- package/lib/umd/locale/pt-BR.js +1 -0
- package/lib/umd/locale/ru-RU.js +1 -0
- package/lib/umd/locale/sk-SK.js +1 -0
- package/lib/umd/locale/vi-VN.js +1 -0
- package/lib/umd/locale/zh-CN.js +1 -0
- package/lib/umd/locale/zh-HK.js +1 -0
- package/lib/umd/locale/zh-TW.js +1 -0
- package/package.json +11 -4
- package/lib/types/chart-builder/candlestick-inline-table.d.ts +0 -4
- package/lib/types/chart-builder/configuration/index.d.ts +0 -34
- package/lib/types/chart-builder/index.d.ts +0 -17
- package/lib/types/chart-builder/internal/host-builder-runtime.d.ts +0 -3
- package/lib/types/chart-builder/internal/merge-description.d.ts +0 -2
- package/lib/types/facade/builders/index.d.ts +0 -17
- package/lib/types/facade/f-chart-base.d.ts +0 -82
- package/lib/types/facade/f-charts-base.d.ts +0 -74
- package/lib/types/facade/internal/host-builder-composer.d.ts +0 -16
- package/lib/types/models/chart-data-operators/build-chart-data.d.ts +0 -9
- package/lib/types/models/chart-data-operators/index.d.ts +0 -3
- package/lib/types/models/chart-data-operators/operators.d.ts +0 -26
- package/lib/types/models/chart-data-operators/treemap-data.d.ts +0 -3
- package/lib/types/models/chart-element-edit-overlay/index.d.ts +0 -4
- package/lib/types/models/chart-locale-texts.d.ts +0 -36
- package/lib/types/models/constants/build-in-theme/index.d.ts +0 -15
- package/lib/types/models/constants/build-in-theme/theme-util.d.ts +0 -5
- package/lib/types/models/constants/default-chart-style.d.ts +0 -181
- package/lib/types/models/constants/histogram-defaults.d.ts +0 -4
- package/lib/types/models/constants/treemap.d.ts +0 -1
- package/lib/types/models/data-context-transformers/box-plot-data-context-transformer.d.ts +0 -3
- package/lib/types/models/data-context-transformers/candlestick-data-context-transformer.d.ts +0 -4
- package/lib/types/models/data-context-transformers/histogram-data-context-transformer.d.ts +0 -7
- package/lib/types/models/data-context-transformers/pareto-data-context-transformer.d.ts +0 -3
- package/lib/types/models/data-context-transformers/pie-data-context-transformer.d.ts +0 -3
- package/lib/types/models/data-context-transformers/treemap-data-context-transformer.d.ts +0 -11
- package/lib/types/models/data-context-transformers/word-cloud-data-context-transform.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/boxplot-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/bubble-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/candlestick-chart-converter.d.ts +0 -5
- package/lib/types/models/mode-converter/converters/combination-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/funnel-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/heatmap-chart-convert.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/pareto-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/pie-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/radar-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/relation-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/sankey-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/scatter-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/treemap-chart-converter.d.ts +0 -4
- package/lib/types/models/mode-converter/converters/waterfall-chart-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/converters/word-cloud-converter.d.ts +0 -3
- package/lib/types/models/mode-converter/render-spec-operators/chart-axes.operator.d.ts +0 -2
- package/lib/types/models/mode-converter/render-spec-operators/chart-box-style.operator.d.ts +0 -2
- package/lib/types/models/mode-converter/render-spec-operators/font-size.operator.d.ts +0 -2
- package/lib/types/models/mode-converter/render-spec-operators/grid-operator.d.ts +0 -2
- package/lib/types/models/mode-converter/render-spec-operators/index.d.ts +0 -15
- package/lib/types/models/mode-converter/render-spec-operators/invalid-value-style.operator.d.ts +0 -2
- package/lib/types/models/mode-converter/render-spec-operators/pie-style.operator.d.ts +0 -2
- package/lib/types/models/mode-converter/render-spec-operators/stack.operator.d.ts +0 -2
- package/lib/types/models/mode-converter/render-spec-operators/visual-map-operator.d.ts +0 -2
- package/lib/types/models/spec-converter/spec-converter.d.ts +0 -1
- package/lib/types/models/word-cloud-musk-image.service.d.ts +0 -17
- package/lib/types/wordcloud-chart/index.d.ts +0 -12
- /package/lib/types/models/{mode-converter → chart-render/converter}/converters/constants.d.ts +0 -0
- /package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/operator-types.d.ts +0 -0
- /package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/relation-chart-operator/relation-force-directed-layout.d.ts +0 -0
- /package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/series-style-operator/series-chart-style.handler.d.ts +0 -0
- /package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/series-style-operator/series-data-label.handler.d.ts +0 -0
- /package/lib/types/models/{mode-converter → chart-render/converter}/render-spec-operators/trend-line/trendline-util.d.ts +0 -0
- /package/lib/types/models/{chart-element-edit-overlay → chart-render/edit-overlay}/palette.d.ts +0 -0
- /package/lib/types/models/{series-style → chart-render/style/series-style}/series-style-resolver.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/default.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/types.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer-gradient1.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer-gradient2.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer-gradient3.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer-gradient4.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer-gradient5.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer-gradient6.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer1.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer2.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer3.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer4.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer5.d.ts +0 -0
- /package/lib/types/models/{constants → common/theme}/build-in-theme/univer6.d.ts +0 -0
|
@@ -1,19 +1,79 @@
|
|
|
1
|
-
import type { ChartPublicSeriesSelector, IChartSeriesPatch, IChartWaterfallConnectorStyleSpec, IChartWaterfallPointRoleSpec, WaterfallStackTypeEnum } from '@univerjs-pro/engine-chart';
|
|
2
|
-
import type { DeepReadonly } from '@univerjs/core';
|
|
1
|
+
import type { ChartPublicSeriesSelector, IChartInfo, IChartSeriesPatch, IChartSeriesStyleSpec, IChartWaterfallConnectorStyleSpec, IChartWaterfallPointRoleSpec, WaterfallStackTypeEnum } from '@univerjs-pro/engine-chart';
|
|
3
2
|
import { FCartesianChartBuilder } from '../f-cartesian-chart-builder';
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
3
|
+
/**
|
|
4
|
+
* Fluent, type-specific Builder for Waterfall Charts.
|
|
5
|
+
*
|
|
6
|
+
* @example Sheet
|
|
7
|
+
* ```ts
|
|
8
|
+
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
9
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
10
|
+
* const chartInfo = fWorksheet
|
|
11
|
+
* .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
|
|
12
|
+
* .setSource('A1:B8')
|
|
13
|
+
* .setPointRoles([{ series: 0, dataPointIndex: 3, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
|
|
14
|
+
* .setConnector(true)
|
|
15
|
+
* .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
|
|
16
|
+
* .setUseSubtotal(true)
|
|
17
|
+
* .setPositiveStyle(0, { color: '#16a34a' })
|
|
18
|
+
* .setNegativeStyle(0, { color: '#dc2626' })
|
|
19
|
+
* .setSubtotalStyle(0, { color: '#2563eb' })
|
|
20
|
+
* .build();
|
|
21
|
+
* await fWorksheet.insertChart(chartInfo);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @example Doc
|
|
25
|
+
* ```ts
|
|
26
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
27
|
+
* const chartInfo = fDocument
|
|
28
|
+
* .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
|
|
29
|
+
* .setSource([['Stage', 'Change'], ['Revenue', 300], ['Costs', -180], ['Profit', 120]])
|
|
30
|
+
* .setPointRoles([{ series: 0, dataPointIndex: 2, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
|
|
31
|
+
* .setConnector(true)
|
|
32
|
+
* .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
|
|
33
|
+
* .setUseSubtotal(true)
|
|
34
|
+
* .setPositiveStyle(0, { color: '#16a34a' })
|
|
35
|
+
* .setNegativeStyle(0, { color: '#dc2626' })
|
|
36
|
+
* .setSubtotalStyle(0, { color: '#2563eb' })
|
|
37
|
+
* .build();
|
|
38
|
+
* await fDocument.insertChart(chartInfo);
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @example Slide
|
|
42
|
+
* ```ts
|
|
43
|
+
* const fPresentation = univerAPI.getActivePresentation();
|
|
44
|
+
* const fSlide = fPresentation.getSlideByIndex(0);
|
|
45
|
+
* const chartInfo = fSlide
|
|
46
|
+
* .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
|
|
47
|
+
* .setSource([['Stage', 'Change'], ['Revenue', 300], ['Costs', -180], ['Profit', 120]])
|
|
48
|
+
* .setPointRoles([{ series: 0, dataPointIndex: 2, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
|
|
49
|
+
* .setConnector(true)
|
|
50
|
+
* .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
|
|
51
|
+
* .setUseSubtotal(true)
|
|
52
|
+
* .setPositiveStyle(0, { color: '#16a34a' })
|
|
53
|
+
* .setNegativeStyle(0, { color: '#dc2626' })
|
|
54
|
+
* .setSubtotalStyle(0, { color: '#2563eb' })
|
|
55
|
+
* .build();
|
|
56
|
+
* await fSlide.insertChart(chartInfo);
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @example Board
|
|
60
|
+
* ```ts
|
|
61
|
+
* const fBoard = univerAPI.getActiveBoard();
|
|
62
|
+
* const chartInfo = fBoard
|
|
63
|
+
* .newChart(univerAPI.Enum.ChartTypeString.Waterfall)
|
|
64
|
+
* .setSource([['Stage', 'Change'], ['Revenue', 300], ['Costs', -180], ['Profit', 120]])
|
|
65
|
+
* .setPointRoles([{ series: 0, dataPointIndex: 2, role: univerAPI.Enum.ChartWaterfallPointRole.Total }])
|
|
66
|
+
* .setConnector(true)
|
|
67
|
+
* .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)
|
|
68
|
+
* .setUseSubtotal(true)
|
|
69
|
+
* .setPositiveStyle(0, { color: '#16a34a' })
|
|
70
|
+
* .setNegativeStyle(0, { color: '#dc2626' })
|
|
71
|
+
* .setSubtotalStyle(0, { color: '#2563eb' })
|
|
72
|
+
* .build();
|
|
73
|
+
* await fBoard.insertChart(chartInfo);
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
export declare class FWaterfallChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo> {
|
|
17
77
|
/**
|
|
18
78
|
* Replaces all Waterfall point roles.
|
|
19
79
|
*
|
|
@@ -23,10 +83,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
23
83
|
* @returns This builder for chaining.
|
|
24
84
|
* @example
|
|
25
85
|
* ```ts
|
|
26
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
27
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
28
86
|
* builder.setPointRoles([{ series: 0, dataPointIndex: 0, role: univerAPI.Enum.ChartWaterfallPointRole.Total }]);
|
|
29
|
-
* const roles = builder.
|
|
87
|
+
* const roles = builder.build().config.waterfall?.pointRoles;
|
|
30
88
|
* ```
|
|
31
89
|
*/
|
|
32
90
|
setPointRoles(roles: readonly IChartWaterfallPointRoleSpec[]): this;
|
|
@@ -37,16 +95,14 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
37
95
|
* and a neutral `#8C8C8C` base color that is adapted by the active light or dark theme. An object
|
|
38
96
|
* starts from those defaults and overrides only the supplied fields. Pass `false` to hide it.
|
|
39
97
|
*
|
|
40
|
-
* Read the current value from `builder.
|
|
98
|
+
* Read the current value from `builder.build().config.waterfall?.connector`.
|
|
41
99
|
*
|
|
42
100
|
* @param value `false` disables, `true` enables the default dashed style, and an object enables style overrides.
|
|
43
101
|
* @returns This builder for chaining.
|
|
44
102
|
* @example
|
|
45
103
|
* ```ts
|
|
46
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
47
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
48
104
|
* builder.setConnector(true);
|
|
49
|
-
* const connector = builder.
|
|
105
|
+
* const connector = builder.build().config.waterfall?.connector;
|
|
50
106
|
* ```
|
|
51
107
|
*/
|
|
52
108
|
setConnector(value: boolean | IChartWaterfallConnectorStyleSpec): this;
|
|
@@ -54,15 +110,13 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
54
110
|
* Clears connector configuration. With no persisted connector setting, the renderer does not
|
|
55
111
|
* draw connectors; call `setConnector(true)` to restore the default dashed connector.
|
|
56
112
|
*
|
|
57
|
-
* Read the cleared value from `builder.
|
|
113
|
+
* Read the cleared value from `builder.build().config.waterfall?.connector`.
|
|
58
114
|
*
|
|
59
115
|
* @returns This builder for chaining.
|
|
60
116
|
* @example
|
|
61
117
|
* ```ts
|
|
62
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
63
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
64
118
|
* builder.clearConnector();
|
|
65
|
-
* const connector = builder.
|
|
119
|
+
* const connector = builder.build().config.waterfall?.connector;
|
|
66
120
|
* ```
|
|
67
121
|
*/
|
|
68
122
|
clearConnector(): this;
|
|
@@ -75,9 +129,7 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
75
129
|
* @returns This builder for chaining.
|
|
76
130
|
* @example
|
|
77
131
|
* ```ts
|
|
78
|
-
*
|
|
79
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
80
|
-
* builder.setStackType(univerAPI.Enum.WaterfallStackTypeEnum.Arrangement);
|
|
132
|
+
* builder.setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement);
|
|
81
133
|
* ```
|
|
82
134
|
*/
|
|
83
135
|
setStackType(value: WaterfallStackTypeEnum): this;
|
|
@@ -89,8 +141,6 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
89
141
|
* @returns This builder for chaining.
|
|
90
142
|
* @example
|
|
91
143
|
* ```ts
|
|
92
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
93
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
94
144
|
* builder.resetStackType();
|
|
95
145
|
* ```
|
|
96
146
|
*/
|
|
@@ -104,8 +154,6 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
104
154
|
* @returns This builder for chaining.
|
|
105
155
|
* @example
|
|
106
156
|
* ```ts
|
|
107
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
108
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
109
157
|
* builder.setUseSubtotal(true);
|
|
110
158
|
* ```
|
|
111
159
|
*/
|
|
@@ -118,8 +166,6 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
118
166
|
* @returns This builder for chaining.
|
|
119
167
|
* @example
|
|
120
168
|
* ```ts
|
|
121
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
122
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
123
169
|
* builder.resetUseSubtotal();
|
|
124
170
|
* ```
|
|
125
171
|
*/
|
|
@@ -134,10 +180,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
134
180
|
* @returns This builder for chaining.
|
|
135
181
|
* @example
|
|
136
182
|
* ```ts
|
|
137
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
138
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
139
183
|
* builder.setPositiveStyle(0, { color: '#52c41a' });
|
|
140
|
-
* const positive = builder.
|
|
184
|
+
* const positive = builder.build().config.series[0]?.waterfallStyles?.positive;
|
|
141
185
|
* ```
|
|
142
186
|
*/
|
|
143
187
|
setPositiveStyle(selector: ChartPublicSeriesSelector, value: Omit<IChartSeriesPatch, 'selector'>): this;
|
|
@@ -150,10 +194,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
150
194
|
* @returns This builder for chaining.
|
|
151
195
|
* @example
|
|
152
196
|
* ```ts
|
|
153
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
154
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
155
197
|
* builder.clearPositiveStyle(0);
|
|
156
|
-
* const positive = builder.
|
|
198
|
+
* const positive = builder.build().config.series[0]?.waterfallStyles?.positive;
|
|
157
199
|
* ```
|
|
158
200
|
*/
|
|
159
201
|
clearPositiveStyle(selector: ChartPublicSeriesSelector): this;
|
|
@@ -167,10 +209,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
167
209
|
* @returns This builder for chaining.
|
|
168
210
|
* @example
|
|
169
211
|
* ```ts
|
|
170
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
171
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
172
212
|
* builder.setNegativeStyle(0, { color: '#f5222d' });
|
|
173
|
-
* const negative = builder.
|
|
213
|
+
* const negative = builder.build().config.series[0]?.waterfallStyles?.negative;
|
|
174
214
|
* ```
|
|
175
215
|
*/
|
|
176
216
|
setNegativeStyle(selector: ChartPublicSeriesSelector, value: Omit<IChartSeriesPatch, 'selector'>): this;
|
|
@@ -183,10 +223,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
183
223
|
* @returns This builder for chaining.
|
|
184
224
|
* @example
|
|
185
225
|
* ```ts
|
|
186
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
187
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
188
226
|
* builder.clearNegativeStyle(0);
|
|
189
|
-
* const negative = builder.
|
|
227
|
+
* const negative = builder.build().config.series[0]?.waterfallStyles?.negative;
|
|
190
228
|
* ```
|
|
191
229
|
*/
|
|
192
230
|
clearNegativeStyle(selector: ChartPublicSeriesSelector): this;
|
|
@@ -200,10 +238,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
200
238
|
* @returns This builder for chaining.
|
|
201
239
|
* @example
|
|
202
240
|
* ```ts
|
|
203
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
204
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
205
241
|
* builder.setSubtotalStyle(0, { color: '#1677ff' });
|
|
206
|
-
* const subtotal = builder.
|
|
242
|
+
* const subtotal = builder.build().config.series[0]?.waterfallStyles?.subtotal;
|
|
207
243
|
* ```
|
|
208
244
|
*/
|
|
209
245
|
setSubtotalStyle(selector: ChartPublicSeriesSelector, value: Omit<IChartSeriesPatch, 'selector'>): this;
|
|
@@ -216,10 +252,8 @@ export declare class FWaterfallChartBuilder extends FCartesianChartBuilder {
|
|
|
216
252
|
* @returns This builder for chaining.
|
|
217
253
|
* @example
|
|
218
254
|
* ```ts
|
|
219
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
220
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.Waterfall);
|
|
221
255
|
* builder.clearSubtotalStyle(0);
|
|
222
|
-
* const subtotal = builder.
|
|
256
|
+
* const subtotal = builder.build().config.series[0]?.waterfallStyles?.subtotal;
|
|
223
257
|
* ```
|
|
224
258
|
*/
|
|
225
259
|
clearSubtotalStyle(selector: ChartPublicSeriesSelector): this;
|
|
@@ -1,6 +1,67 @@
|
|
|
1
|
-
import type { WordCloudShapeEnum } from '@univerjs-pro/engine-chart';
|
|
1
|
+
import type { IChartInfo, WordCloudShapeEnum } from '@univerjs-pro/engine-chart';
|
|
2
2
|
import { FChartBuilderBase } from '../f-chart-builder-base';
|
|
3
|
-
|
|
3
|
+
/**
|
|
4
|
+
* Fluent, type-specific Builder for Word Cloud Charts.
|
|
5
|
+
*
|
|
6
|
+
* @example Sheet
|
|
7
|
+
* ```ts
|
|
8
|
+
* const fWorkbook = univerAPI.getActiveWorkbook();
|
|
9
|
+
* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
|
|
10
|
+
* const chartInfo = fWorksheet
|
|
11
|
+
* .newChart(univerAPI.Enum.ChartTypeString.WordCloud)
|
|
12
|
+
* .setSource('A1:B8')
|
|
13
|
+
* .setCategoryField(0)
|
|
14
|
+
* .setValueFields([1])
|
|
15
|
+
* .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)
|
|
16
|
+
* .setRepeat(true)
|
|
17
|
+
* .build();
|
|
18
|
+
* await fWorksheet.insertChart(chartInfo);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @example Doc
|
|
22
|
+
* ```ts
|
|
23
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
24
|
+
* const chartInfo = fDocument
|
|
25
|
+
* .newChart(univerAPI.Enum.ChartTypeString.WordCloud)
|
|
26
|
+
* .setSource([['Word', 'Frequency'], ['Univer', 42], ['Chart', 28], ['Data', 18]])
|
|
27
|
+
* .setCategoryField(0)
|
|
28
|
+
* .setValueFields([1])
|
|
29
|
+
* .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)
|
|
30
|
+
* .setRepeat(true)
|
|
31
|
+
* .build();
|
|
32
|
+
* await fDocument.insertChart(chartInfo);
|
|
33
|
+
* ```
|
|
34
|
+
*
|
|
35
|
+
* @example Slide
|
|
36
|
+
* ```ts
|
|
37
|
+
* const fPresentation = univerAPI.getActivePresentation();
|
|
38
|
+
* const fSlide = fPresentation.getSlideByIndex(0);
|
|
39
|
+
* const chartInfo = fSlide
|
|
40
|
+
* .newChart(univerAPI.Enum.ChartTypeString.WordCloud)
|
|
41
|
+
* .setSource([['Word', 'Frequency'], ['Univer', 42], ['Chart', 28], ['Data', 18]])
|
|
42
|
+
* .setCategoryField(0)
|
|
43
|
+
* .setValueFields([1])
|
|
44
|
+
* .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)
|
|
45
|
+
* .setRepeat(true)
|
|
46
|
+
* .build();
|
|
47
|
+
* await fSlide.insertChart(chartInfo);
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @example Board
|
|
51
|
+
* ```ts
|
|
52
|
+
* const fBoard = univerAPI.getActiveBoard();
|
|
53
|
+
* const chartInfo = fBoard
|
|
54
|
+
* .newChart(univerAPI.Enum.ChartTypeString.WordCloud)
|
|
55
|
+
* .setSource([['Word', 'Frequency'], ['Univer', 42], ['Chart', 28], ['Data', 18]])
|
|
56
|
+
* .setCategoryField(0)
|
|
57
|
+
* .setValueFields([1])
|
|
58
|
+
* .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Circle)
|
|
59
|
+
* .setRepeat(true)
|
|
60
|
+
* .build();
|
|
61
|
+
* await fBoard.insertChart(chartInfo);
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
export declare class FWordCloudChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> extends FChartBuilderBase<TSource, TDataSource, TInfo> {
|
|
4
65
|
/**
|
|
5
66
|
* Sets the shape configuration and returns this builder for chaining.
|
|
6
67
|
*
|
|
@@ -10,9 +71,7 @@ export declare class FWordCloudChartBuilder extends FChartBuilderBase {
|
|
|
10
71
|
* @returns This builder for chaining.
|
|
11
72
|
* @example
|
|
12
73
|
* ```ts
|
|
13
|
-
*
|
|
14
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.WordCloud);
|
|
15
|
-
* builder.setShape(univerAPI.Enum.WordCloudShapeEnum.Cloud);
|
|
74
|
+
* builder.setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Cloud);
|
|
16
75
|
* ```
|
|
17
76
|
*/
|
|
18
77
|
setShape(value: WordCloudShapeEnum): this;
|
|
@@ -24,8 +83,6 @@ export declare class FWordCloudChartBuilder extends FChartBuilderBase {
|
|
|
24
83
|
* @returns This builder for chaining.
|
|
25
84
|
* @example
|
|
26
85
|
* ```ts
|
|
27
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
28
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.WordCloud);
|
|
29
86
|
* builder.resetShape();
|
|
30
87
|
* ```
|
|
31
88
|
*/
|
|
@@ -39,8 +96,6 @@ export declare class FWordCloudChartBuilder extends FChartBuilderBase {
|
|
|
39
96
|
* @returns This builder for chaining.
|
|
40
97
|
* @example
|
|
41
98
|
* ```ts
|
|
42
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
43
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.WordCloud);
|
|
44
99
|
* builder.setMaskImage('resource-id');
|
|
45
100
|
* ```
|
|
46
101
|
*/
|
|
@@ -53,8 +108,6 @@ export declare class FWordCloudChartBuilder extends FChartBuilderBase {
|
|
|
53
108
|
* @returns This builder for chaining.
|
|
54
109
|
* @example
|
|
55
110
|
* ```ts
|
|
56
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
57
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.WordCloud);
|
|
58
111
|
* builder.clearMaskImage();
|
|
59
112
|
* ```
|
|
60
113
|
*/
|
|
@@ -68,8 +121,6 @@ export declare class FWordCloudChartBuilder extends FChartBuilderBase {
|
|
|
68
121
|
* @returns This builder for chaining.
|
|
69
122
|
* @example
|
|
70
123
|
* ```ts
|
|
71
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
72
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.WordCloud);
|
|
73
124
|
* builder.setRepeat(true);
|
|
74
125
|
* ```
|
|
75
126
|
*/
|
|
@@ -82,8 +133,6 @@ export declare class FWordCloudChartBuilder extends FChartBuilderBase {
|
|
|
82
133
|
* @returns This builder for chaining.
|
|
83
134
|
* @example
|
|
84
135
|
* ```ts
|
|
85
|
-
* const worksheet = univerAPI.getActiveWorkbook().getActiveSheet();
|
|
86
|
-
* const builder = worksheet.charts.create().setType(univerAPI.Enum.ChartTypeString.WordCloud);
|
|
87
136
|
* builder.resetRepeat();
|
|
88
137
|
* ```
|
|
89
138
|
*/
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import type { ChartBuilder } from '@univerjs-pro/engine-chart';
|
|
1
|
+
import type { ChartBuilder, ChartTypeString, IChartInfo } from '@univerjs-pro/engine-chart';
|
|
2
2
|
import type { IChartBuilderTypeMap } from './chart-builder-type-map';
|
|
3
3
|
import type { FChartBuilderBase } from './f-chart-builder-base';
|
|
4
4
|
import type { IChartBuilderFacadeContext } from './internal/chart-builder-facade-context';
|
|
5
5
|
export type ChartBuilderConstructor<T extends FChartBuilderBase = FChartBuilderBase> = new (context: IChartBuilderFacadeContext<ChartBuilder>) => T;
|
|
6
|
-
export declare function registerChartBuilder<T extends
|
|
7
|
-
export declare function getChartBuilderConstructor<T extends
|
|
8
|
-
export declare function getChartBuilderRegistryKeys():
|
|
6
|
+
export declare function registerChartBuilder<T extends ChartTypeString>(type: T, Constructor: ChartBuilderConstructor<IChartBuilderTypeMap[T]>): void;
|
|
7
|
+
export declare function getChartBuilderConstructor<T extends ChartTypeString, TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>>(type: T): new (context: IChartBuilderFacadeContext<ChartBuilder, TSource, TDataSource, TInfo>) => IChartBuilderTypeMap<TSource, TDataSource, TInfo>[T];
|
|
8
|
+
export declare function getChartBuilderRegistryKeys(): ChartTypeString[];
|
|
@@ -1,33 +1,58 @@
|
|
|
1
|
-
import type { ChartTypeString } from '@univerjs-pro/engine-chart';
|
|
2
|
-
import type { FAreaChartBuilder
|
|
1
|
+
import type { ChartTypeString, IChartInfo, IChartSeriesPatch, IChartSeriesStyleSpec } from '@univerjs-pro/engine-chart';
|
|
2
|
+
import type { FAreaChartBuilder } from './builders/f-area-chart-builder';
|
|
3
|
+
import type { FBoxplotChartBuilder } from './builders/f-boxplot-chart-builder';
|
|
4
|
+
import type { FBubbleChartBuilder } from './builders/f-bubble-chart-builder';
|
|
5
|
+
import type { FCandlestickChartBuilder } from './builders/f-candlestick-chart-builder';
|
|
6
|
+
import type { FChordChartBuilder } from './builders/f-chord-chart-builder';
|
|
7
|
+
import type { FCombinationChartBuilder } from './builders/f-combination-chart-builder';
|
|
8
|
+
import type { FFunnelChartBuilder } from './builders/f-funnel-chart-builder';
|
|
9
|
+
import type { FGaugeChartBuilder } from './builders/f-gauge-chart-builder';
|
|
10
|
+
import type { FHeatmapChartBuilder } from './builders/f-heatmap-chart-builder';
|
|
11
|
+
import type { FHistogramChartBuilder } from './builders/f-histogram-chart-builder';
|
|
12
|
+
import type { FLineChartBuilder } from './builders/f-line-chart-builder';
|
|
13
|
+
import type { FParetoChartBuilder } from './builders/f-pareto-chart-builder';
|
|
14
|
+
import type { FPieChartBuilder } from './builders/f-pie-chart-builder';
|
|
15
|
+
import type { FRadarChartBuilder } from './builders/f-radar-chart-builder';
|
|
16
|
+
import type { FRelationChartBuilder } from './builders/f-relation-chart-builder';
|
|
17
|
+
import type { FScatterChartBuilder } from './builders/f-scatter-chart-builder';
|
|
18
|
+
import type { FSunburstChartBuilder } from './builders/f-sunburst-chart-builder';
|
|
19
|
+
import type { FTreemapChartBuilder } from './builders/f-treemap-chart-builder';
|
|
20
|
+
import type { FWaterfallChartBuilder } from './builders/f-waterfall-chart-builder';
|
|
21
|
+
import type { FWordCloudChartBuilder } from './builders/f-word-cloud-chart-builder';
|
|
3
22
|
import type { FCartesianChartBuilder } from './f-cartesian-chart-builder';
|
|
4
23
|
import type { FChartBuilderBase } from './f-chart-builder-base';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
[ChartTypeString.
|
|
8
|
-
[ChartTypeString.
|
|
9
|
-
[ChartTypeString.
|
|
10
|
-
[ChartTypeString.
|
|
11
|
-
[ChartTypeString.
|
|
12
|
-
[ChartTypeString.
|
|
13
|
-
[ChartTypeString.
|
|
14
|
-
[ChartTypeString.
|
|
15
|
-
[ChartTypeString.
|
|
16
|
-
[ChartTypeString.
|
|
17
|
-
[ChartTypeString.
|
|
18
|
-
[ChartTypeString.
|
|
19
|
-
[ChartTypeString.
|
|
20
|
-
[ChartTypeString.
|
|
21
|
-
[ChartTypeString.
|
|
22
|
-
[ChartTypeString.
|
|
23
|
-
[ChartTypeString.
|
|
24
|
-
[ChartTypeString.
|
|
25
|
-
[ChartTypeString.
|
|
26
|
-
[ChartTypeString.
|
|
27
|
-
[ChartTypeString.
|
|
28
|
-
[ChartTypeString.
|
|
29
|
-
[ChartTypeString.
|
|
30
|
-
[ChartTypeString.
|
|
31
|
-
[ChartTypeString.
|
|
32
|
-
[ChartTypeString.
|
|
24
|
+
/** Maps each canonical Chart type to its type-specific Facade Builder. */
|
|
25
|
+
export interface IChartBuilderTypeMap<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> {
|
|
26
|
+
[ChartTypeString.Line]: FLineChartBuilder<TSource, TDataSource, TInfo>;
|
|
27
|
+
[ChartTypeString.Column]: FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo>;
|
|
28
|
+
[ChartTypeString.ColumnStacked]: FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo>;
|
|
29
|
+
[ChartTypeString.ColumnPercentStacked]: FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo>;
|
|
30
|
+
[ChartTypeString.Bar]: FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo>;
|
|
31
|
+
[ChartTypeString.BarStacked]: FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo>;
|
|
32
|
+
[ChartTypeString.BarPercentStacked]: FCartesianChartBuilder<Omit<IChartSeriesPatch, 'selector'>, IChartSeriesStyleSpec, TSource, TDataSource, TInfo>;
|
|
33
|
+
[ChartTypeString.Pie]: FPieChartBuilder<TSource, TDataSource, TInfo>;
|
|
34
|
+
[ChartTypeString.Donut]: FPieChartBuilder<TSource, TDataSource, TInfo>;
|
|
35
|
+
[ChartTypeString.Area]: FAreaChartBuilder<TSource, TDataSource, TInfo>;
|
|
36
|
+
[ChartTypeString.AreaStacked]: FAreaChartBuilder<TSource, TDataSource, TInfo>;
|
|
37
|
+
[ChartTypeString.AreaPercentStacked]: FAreaChartBuilder<TSource, TDataSource, TInfo>;
|
|
38
|
+
[ChartTypeString.Radar]: FRadarChartBuilder<TSource, TDataSource, TInfo>;
|
|
39
|
+
[ChartTypeString.Scatter]: FScatterChartBuilder<TSource, TDataSource, TInfo>;
|
|
40
|
+
[ChartTypeString.Combination]: FCombinationChartBuilder<TSource, TDataSource, TInfo>;
|
|
41
|
+
[ChartTypeString.WordCloud]: FWordCloudChartBuilder<TSource, TDataSource, TInfo>;
|
|
42
|
+
[ChartTypeString.Funnel]: FFunnelChartBuilder<TSource, TDataSource, TInfo>;
|
|
43
|
+
[ChartTypeString.Bubble]: FBubbleChartBuilder<TSource, TDataSource, TInfo>;
|
|
44
|
+
[ChartTypeString.Relation]: FRelationChartBuilder<TSource, TDataSource, TInfo>;
|
|
45
|
+
[ChartTypeString.Waterfall]: FWaterfallChartBuilder<TSource, TDataSource, TInfo>;
|
|
46
|
+
[ChartTypeString.Pareto]: FParetoChartBuilder<TSource, TDataSource, TInfo>;
|
|
47
|
+
[ChartTypeString.Sankey]: FChartBuilderBase<TSource, TDataSource, TInfo>;
|
|
48
|
+
[ChartTypeString.Heatmap]: FHeatmapChartBuilder<TSource, TDataSource, TInfo>;
|
|
49
|
+
[ChartTypeString.Boxplot]: FBoxplotChartBuilder<TSource, TDataSource, TInfo>;
|
|
50
|
+
[ChartTypeString.Candlestick]: FCandlestickChartBuilder<TSource, TDataSource, TInfo>;
|
|
51
|
+
[ChartTypeString.Histogram]: FHistogramChartBuilder<TSource, TDataSource, TInfo>;
|
|
52
|
+
[ChartTypeString.Treemap]: FTreemapChartBuilder<TSource, TDataSource, TInfo>;
|
|
53
|
+
[ChartTypeString.Sunburst]: FSunburstChartBuilder<TSource, TDataSource, TInfo>;
|
|
54
|
+
[ChartTypeString.Gauge]: FGaugeChartBuilder<TSource, TDataSource, TInfo>;
|
|
55
|
+
[ChartTypeString.Chord]: FChordChartBuilder<TSource, TDataSource, TInfo>;
|
|
33
56
|
}
|
|
57
|
+
/** Any concrete engine-only Chart configuration builder. */
|
|
58
|
+
export type FAnyChartBuilder<TSource = never[], TDataSource = TSource, TInfo extends IChartInfo<TDataSource> = IChartInfo<TDataSource>> = IChartBuilderTypeMap<TSource, TDataSource, TInfo>[ChartTypeString];
|
|
@@ -1,21 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
import type { IChartBuilderHostTypes } from './f-charts-base';
|
|
4
|
-
type RebindHostMethods<TBuilder extends FChartBuilderBase, THostMethods extends object> = {
|
|
5
|
-
[K in keyof THostMethods]: THostMethods[K] extends (...args: infer TArgs) => infer TResult ? TResult extends THostMethods ? (...args: TArgs) => HostComposedChartBuilder<TBuilder, THostMethods> : THostMethods[K] : THostMethods[K];
|
|
6
|
-
};
|
|
7
|
-
type RebindBuilderMethods<TBuilder extends FChartBuilderBase, THostMethods extends object> = {
|
|
8
|
-
[K in keyof Omit<TBuilder, keyof THostMethods | 'setType'>]: Omit<TBuilder, keyof THostMethods | 'setType'>[K] extends (...args: infer TArgs) => infer TResult ? TResult extends FChartBuilderBase ? (...args: TArgs) => HostComposedChartBuilder<TResult, THostMethods> : Omit<TBuilder, keyof THostMethods | 'setType'>[K] : Omit<TBuilder, keyof THostMethods | 'setType'>[K];
|
|
9
|
-
};
|
|
10
|
-
export type HostComposedChartBuilder<TBuilder extends FChartBuilderBase, THostMethods extends object> = RebindBuilderMethods<TBuilder, THostMethods> & Pick<TBuilder, 'getId' | 'describe' | 'commit' | 'exportImage'> & RebindHostMethods<TBuilder, THostMethods> & {
|
|
11
|
-
setType<T extends keyof IChartBuilderTypeMap>(type: T): HostComposedChartBuilder<IChartBuilderTypeMap[T], THostMethods>;
|
|
12
|
-
};
|
|
13
|
-
export type HostChartBuilderOf<T extends keyof IChartBuilderTypeMap, THostMethods extends object> = HostComposedChartBuilder<IChartBuilderTypeMap[T], THostMethods>;
|
|
14
|
-
export type HostAnyChartBuilder<THostMethods extends object> = {
|
|
15
|
-
[T in keyof IChartBuilderTypeMap]: HostChartBuilderOf<T, THostMethods>;
|
|
16
|
-
}[keyof IChartBuilderTypeMap];
|
|
17
|
-
export interface IHostChartBuilderTypes<THostMethods extends object> extends IChartBuilderHostTypes {
|
|
18
|
-
Initial: HostComposedChartBuilder<FChartBuilderBase, THostMethods>;
|
|
19
|
-
Any: HostAnyChartBuilder<THostMethods>;
|
|
20
|
-
}
|
|
21
|
-
export {};
|
|
1
|
+
/** Combines one concrete engine Chart Builder with host-owned creation methods. */
|
|
2
|
+
export type HostComposedChartBuilder<TBuilder extends object, THostMethods extends object> = TBuilder & THostMethods;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { ChartTypeString, IChartDescription, IChartInfo } from '@univerjs-pro/engine-chart';
|
|
2
|
+
import type { Injector } from '@univerjs/core';
|
|
3
|
+
import type { IChartBuilderTypeMap } from './chart-builder-type-map';
|
|
4
|
+
import type { HostComposedChartBuilder } from './chart-host-builder-types';
|
|
5
|
+
/** Host extension hooks used to add placement and ownership methods to a Chart Builder. */
|
|
6
|
+
export interface IChartBuilderExtensionContext<TInfo extends IChartInfo<TDataSource>, TDataSource> {
|
|
7
|
+
/** Returns a cloned host-specific information field from the detached draft. */
|
|
8
|
+
getInfo<K extends keyof TInfo>(key: K): TInfo[K] | undefined;
|
|
9
|
+
/** Replaces a host-specific information field in the detached draft. */
|
|
10
|
+
setInfo<K extends keyof TInfo>(key: K, value: TInfo[K]): void;
|
|
11
|
+
/** Sets the common absolute position in the detached draft. */
|
|
12
|
+
setAbsolutePosition(x: number, y: number): void;
|
|
13
|
+
/** Sets the common size in the detached draft. */
|
|
14
|
+
setSize(width: number, height: number): void;
|
|
15
|
+
}
|
|
16
|
+
/** A type-specific engine Builder composed with host-owned creation methods. */
|
|
17
|
+
export type FChartInfoBuilder<T extends ChartTypeString, TSource, TDataSource, TInfo extends IChartInfo<TDataSource>, TExtension extends object = object> = HostComposedChartBuilder<IChartBuilderTypeMap<TSource, TDataSource, TInfo>[T], TExtension>;
|
|
18
|
+
interface IChartBuilderExtensionOptions<T extends ChartTypeString, TSource, TDataSource, TInfo extends IChartInfo<TDataSource>, TExtension extends object> {
|
|
19
|
+
extension: (context: IChartBuilderExtensionContext<TInfo, TDataSource>) => TExtension & ThisType<FChartInfoBuilder<T, TSource, TDataSource, TInfo, TExtension>>;
|
|
20
|
+
}
|
|
21
|
+
interface INewChartBuilderOptions<T extends ChartTypeString, TSource, TDataSource, TInfo extends IChartInfo<TDataSource>, TExtension extends object> extends IChartBuilderExtensionOptions<T, TSource, TDataSource, TInfo, TExtension> {
|
|
22
|
+
type: T;
|
|
23
|
+
injector: Injector;
|
|
24
|
+
commitError: string;
|
|
25
|
+
normalizeSource: (source: TSource) => TDataSource;
|
|
26
|
+
createInfo: () => Omit<TInfo, 'config' | 'dataSource'>;
|
|
27
|
+
}
|
|
28
|
+
interface IExistingChartBuilderOptions<T extends ChartTypeString, TSource, TDataSource, TInfo extends IChartInfo<TDataSource>, TExtension extends object> extends IChartBuilderExtensionOptions<T, TSource, TDataSource, TInfo, TExtension> {
|
|
29
|
+
type: T;
|
|
30
|
+
info: TInfo;
|
|
31
|
+
description: IChartDescription;
|
|
32
|
+
normalizeSource: (source: TSource) => TDataSource;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Creates a new detached Chart information Builder.
|
|
36
|
+
* @param options The Chart type, source normalizer, host information factory, and host extension.
|
|
37
|
+
* @returns A type-specific Builder that produces an insertable Chart information object.
|
|
38
|
+
*/
|
|
39
|
+
export declare function createChartBuilder<T extends ChartTypeString, TSource, TDataSource, TInfo extends IChartInfo<TDataSource>, TExtension extends object = object>(options: INewChartBuilderOptions<T, TSource, TDataSource, TInfo, TExtension>): FChartInfoBuilder<T, TSource, TDataSource, TInfo, TExtension>;
|
|
40
|
+
/**
|
|
41
|
+
* Creates a detached Chart information Builder prefilled from an existing Chart snapshot.
|
|
42
|
+
* @param options The existing information, semantic description, target type, source normalizer, and host extension.
|
|
43
|
+
* @returns A type-specific Builder for creating a modified copy without updating the live Chart.
|
|
44
|
+
*/
|
|
45
|
+
export declare function createChartBuilder<T extends ChartTypeString, TSource, TDataSource, TInfo extends IChartInfo<TDataSource>, TExtension extends object = object>(options: IExistingChartBuilderOptions<T, TSource, TDataSource, TInfo, TExtension>): FChartInfoBuilder<T, TSource, TDataSource, TInfo, TExtension>;
|
|
46
|
+
export {};
|