@carbon/charts-vue 1.16.2 → 1.16.4

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 1.16.4 (2024-06-12)
+
+### Bug Fixes
+
+- **wordcloud,choropleth:** provide corrected names, deprecate old names
+  ([#1832](https://github.com/carbon-design-system/carbon-charts/issues/1832))
+  ([230ce7c](https://github.com/carbon-design-system/carbon-charts/commit/230ce7c3bdce8e03e70b8188e06a1d65ee90b2be))
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.16.3 (2024-06-03)
+
+**Note:** Version bump only for package @carbon/charts-vue
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
 ## 1.16.2 (2024-06-03)
 
 **Note:** Version bump only for package @carbon/charts-vue

package/README.md

@@ -1,8 +1,11 @@
 # Carbon Charts Vue
 
-Carbon Charts Vue is a thin Vue.js wrapper around the vanilla JavaScript `@carbon/charts` component library. The charts are based on D3.js, a peer dependency. This version is for Vue.js ^3.3.0. For Vue.js 2.x support, please use `@carbon/charts-vue@latest`.
+Carbon Charts Vue is a thin Vue.js wrapper around the vanilla JavaScript `@carbon/charts` component
+library. The charts are based on D3.js, a peer dependency. This version is for Vue.js ^3.3.0. For
+Vue.js 2.x support, please use `@carbon/charts-vue@latest`.
 
-The required styles should be imported from `@carbon/charts-vue/styles.css`. Additional documentation is provided in the Storybook demos.
+The required styles should be imported from `@carbon/charts-vue/styles.css`. Additional
+documentation is provided in the Storybook demos.
 
 **[Storybook demos](https://charts.carbondesignsystem.com/vue)**
 
@@ -20,8 +23,7 @@ Run the following command using [npm](https://www.npmjs.com/):
 npm install -S @carbon/charts-vue d3 d3-cloud d3-sankey
 ```
 
-If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
-instead:
+If you prefer [Yarn](https://yarnpkg.com/en/), use the following command instead:
 
 ```bash
 yarn add @carbon/charts-vue d3 d3-cloud d3-sankey
@@ -29,17 +31,22 @@ yarn add @carbon/charts-vue d3 d3-cloud d3-sankey
 
 ## Step-by-step instructions
 
-Read [Getting Started](https://charts.carbondesignsystem.com/?path=/docs/docs-getting-started-vue--docs)
+Read
+[Getting Started](https://charts.carbondesignsystem.com/?path=/docs/docs-getting-started-vue--docs)
 
 ## Storybook and StackBlitz Examples
 
 [Sample use cases can be seen here](https://charts.carbondesignsystem.com/vue).
 
-**When opening the link above**, click on the **Edit on StackBlitz** button for each demo to see an isolated project showing you how to reproduce the demo.
+**When opening the link above**, click on the **Edit on StackBlitz** button for each demo to see an
+isolated project showing you how to reproduce the demo.
 
 ## Charting data & options
 
-Although new charts will be introduced in the future (such as a choropleth), data and options follow the same model for all charts with minor exceptions. For example, in the case of a donut chart, you're able to pass in an additional field called `center` in your options to configure the donut center.
+Although new charts will be introduced in the future (such as a choropleth), data and options follow
+the same model for all charts with minor exceptions. For example, in the case of a donut chart,
+you're able to pass in an additional field called `center` in your options to configure the donut
+center.
 
 For instructions on using the **tabular data format**, see
 [here](https://charts.carbondesignsystem.com/vue/?path=/docs/docs-tutorials-tabular-data-format--docs)
@@ -49,9 +56,8 @@ Customizable options (specific to chart type) can be found
 
 ## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
 
-This package uses IBM Telemetry to collect metrics data. By installing this
-package as a dependency you are agreeing to telemetry collection. To opt out,
-see
+This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency
+you are agreeing to telemetry collection. To opt out, see
 [Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
 For more information on the data being collected, please see the
-[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
+[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).

package/dist/components/CcvWordCloudChart.d.ts

@@ -1,4 +1,4 @@
-import { WorldCloudChartOptions } from '@carbon/charts';
+import { WordCloudChartOptions } from '@carbon/charts';
 
 declare const _default: import('../../vue/dist/vue.esm-bundler.js').DefineComponent<{
     data: {
@@ -6,7 +6,7 @@ declare const _default: import('../../vue/dist/vue.esm-bundler.js').DefineCompon
         required: true;
     };
     options: {
-        type: () => WorldCloudChartOptions;
+        type: () => WordCloudChartOptions;
         required: true;
     };
 }, {
@@ -89,7 +89,7 @@ declare const _default: import('../../vue/dist/vue.esm-bundler.js').DefineCompon
         required: true;
     };
     options: {
-        type: () => WorldCloudChartOptions;
+        type: () => WordCloudChartOptions;
         required: true;
     };
 }>>, {}, {}>;

package/dist/components/index.d.ts

@@ -3,7 +3,7 @@ export { default as CcvAreaChart } from './CcvAreaChart.ts';
 export { default as CcvBoxplotChart } from './CcvBoxplotChart.ts';
 export { default as CcvBubbleChart } from './CcvBubbleChart.ts';
 export { default as CcvBulletChart } from './CcvBulletChart.ts';
-export { default as ExperimentalCcvChoroplethChart } from './CcvChoroplethChart.ts';
+export { default as CcvChoroplethChart } from './CcvChoroplethChart.ts';
 export { default as CcvCirclePackChart } from './CcvCirclePackChart.ts';
 export { default as CcvComboChart } from './CcvComboChart.ts';
 export { default as CcvDonutChart } from './CcvDonutChart.ts';

package/dist/index.d.ts

@@ -1,9 +1,18 @@
-import { CcvAlluvialChart, CcvAreaChart, CcvBoxplotChart, CcvBubbleChart, CcvBulletChart, CcvCirclePackChart, CcvComboChart, ExperimentalCcvChoroplethChart, CcvDonutChart, CcvGaugeChart, CcvGroupedBarChart, CcvHeatmapChart, CcvHistogramChart, CcvLineChart, CcvLollipopChart, CcvMeterChart, CcvPieChart, CcvRadarChart, CcvScatterChart, CcvSimpleBarChart, CcvStackedAreaChart, CcvStackedBarChart, CcvTreeChart, CcvTreemapChart, CcvWordCloudChart } from './components';
+import { App } from '../vue/dist/vue.esm-bundler.js';
+import { CcvAlluvialChart, CcvAreaChart, CcvBoxplotChart, CcvBubbleChart, CcvBulletChart, CcvCirclePackChart, CcvComboChart, CcvChoroplethChart, CcvChoroplethChart as ExperimentalCcvChoroplethChart, CcvDonutChart, CcvGaugeChart, CcvGroupedBarChart, CcvHeatmapChart, CcvHistogramChart, CcvLineChart, CcvLollipopChart, CcvMeterChart, CcvPieChart, CcvRadarChart, CcvScatterChart, CcvSimpleBarChart, CcvStackedAreaChart, CcvStackedBarChart, CcvTreeChart, CcvTreemapChart, CcvWordCloudChart } from './components';
 
 declare const _default: {
-    install(app: any, options?: string[]): void;
+    install(app: App, options?: string[]): void;
 };
 export default _default;
-export { CcvAlluvialChart, CcvAreaChart, CcvBoxplotChart, CcvBubbleChart, CcvBulletChart, ExperimentalCcvChoroplethChart, CcvCirclePackChart, CcvComboChart, CcvDonutChart, CcvGaugeChart, CcvGroupedBarChart, CcvHeatmapChart, CcvHistogramChart, CcvLineChart, CcvLollipopChart, CcvMeterChart, CcvPieChart, CcvRadarChart, CcvScatterChart, CcvSimpleBarChart, CcvStackedAreaChart, CcvStackedBarChart, CcvTreeChart, CcvTreemapChart, CcvWordCloudChart };
-export type { ChartTabularData, ChartOptions, AlluvialChartOptions, AreaChartOptions, BarChartOptions, BoxplotChartOptions, BubbleChartOptions, BulletChartOptions, ChoroplethChartOptions, CirclePackChartOptions, ComboChartOptions, DonutChartOptions, GaugeChartOptions, HeatmapChartOptions, HistogramChartOptions, LineChartOptions, LollipopChartOptions, MeterChartOptions, PieChartOptions, RadarChartOptions, ScatterChartOptions, StackedAreaChartOptions, TreeChartOptions, TreemapChartOptions, WorldCloudChartOptions } from '@carbon/charts';
+export { CcvAlluvialChart, CcvAreaChart, CcvBoxplotChart, CcvBubbleChart, CcvBulletChart, CcvChoroplethChart, 
+/**
+ * @deprecated Use `CcvChoroplethChart` instead.
+ */
+ExperimentalCcvChoroplethChart, CcvCirclePackChart, CcvComboChart, CcvDonutChart, CcvGaugeChart, CcvGroupedBarChart, CcvHeatmapChart, CcvHistogramChart, CcvLineChart, CcvLollipopChart, CcvMeterChart, CcvPieChart, CcvRadarChart, CcvScatterChart, CcvSimpleBarChart, CcvStackedAreaChart, CcvStackedBarChart, CcvTreeChart, CcvTreemapChart, CcvWordCloudChart };
+export type { ChartTabularData, ChartOptions, AlluvialChartOptions, AreaChartOptions, BarChartOptions, BoxplotChartOptions, BubbleChartOptions, BulletChartOptions, ChoroplethChartOptions, CirclePackChartOptions, ComboChartOptions, DonutChartOptions, GaugeChartOptions, HeatmapChartOptions, HistogramChartOptions, LineChartOptions, LollipopChartOptions, MeterChartOptions, PieChartOptions, RadarChartOptions, ScatterChartOptions, StackedAreaChartOptions, TreeChartOptions, TreemapChartOptions, WordCloudChartOptions, 
+/**
+ * @deprecated Use `WordCloudChartOptions` instead.
+ */
+WordCloudChartOptions as WorldCloudChartOptions } from '@carbon/charts';
 export { Alignments, ChartTheme, ScaleTypes } from '@carbon/charts';