@carbon/charts 0.59.0-beta.0 → 1.0.3

package/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 IBM
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,4 +1,8 @@
-# `@carbon/charts`
+# Notice
+
+### This version is in beta & relies on **Carbon v11**. If you're using Carbon v10, [see the legacy demo site](https://carbon-charts-0x.netlify.app)
+
+## `@carbon/charts`
 
 > Carbon Charting components
 

package/build/demo/create-codesandbox.d.ts

@@ -0,0 +1,123 @@
+export declare const createChartSandbox: {
+    (chartTemplate: any): string;
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};
+export declare const createVanillaChartApp: {
+    (demo: any): {
+        'index.html': string;
+        'src/index.js': string;
+        'src/carbon-styles.scss': string;
+        'package.json': {
+            scripts: {
+                start: string;
+                build: string;
+            };
+            dependencies: {
+                '@carbon/charts': any;
+                '@carbon/colors': any;
+                '@carbon/styles': any;
+                d3: string;
+            };
+            devDependencies: {
+                'parcel-bundler': string;
+            };
+        };
+    };
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};
+export declare const createReactChartApp: {
+    (demo: any): {
+        'src/index.html': string;
+        'src/index.js': string;
+        'src/plex-and-carbon-styles.scss': string;
+        'package.json': {
+            dependencies: {
+                '@carbon/charts': any;
+                '@carbon/charts-react': any;
+                '@carbon/colors': any;
+                '@carbon/styles': any;
+                d3: string;
+                react: string;
+                'react-dom': string;
+                'react-scripts': string;
+            };
+        };
+    };
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};
+export declare const createAngularChartApp: {
+    (demo: any): {
+        'src/app/app.component.html': string;
+        'src/app/app.component.ts': string;
+        'src/app/plex-and-carbon-styles.scss': string;
+        'src/app/app.module.ts': string;
+        'package.json': string;
+    };
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};
+export declare const createVueChartApp: {
+    (demo: any): {
+        'src/components/chart.vue': string;
+        'src/plex-and-carbon-styles.scss': string;
+        'src/App.vue': string;
+        'src/main.js': string;
+        'package.json': string;
+    };
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};
+export declare const createSvelteChartApp: {
+    (demo: any): {
+        'App.svelte': string;
+        'index.html': string;
+        'plex-and-carbon-styles.scss': string;
+        'package.json': {
+            scripts: {
+                dev: string;
+                build: string;
+            };
+            devDependencies: {
+                '@carbon/charts-svelte': any;
+                '@carbon/colors': any;
+                '@carbon/styles': any;
+                '@sveltejs/vite-plugin-svelte': string;
+                d3: string;
+                sass: string;
+                svelte: string;
+                'svelte-hmr': string;
+                vite: string;
+            };
+        };
+        'vite.config.js': string;
+    };
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};

package/build/demo/utils.d.ts

@@ -0,0 +1,40 @@
+export declare const addControls: (container: any, demoGroup: any, chart: any, configs?: {
+    colorPairingOptions: any;
+}) => void;
+export declare const addRadioButtonEventListeners: (container: any, chart: any, configs: any) => void;
+export declare const addOtherVersions: (container: any, demoGroup: any, demo: any, configs?: {
+    currentVersion: string;
+}) => void;
+/**
+ * Generates random data going backwards from now once a minute
+ * @param {number} quantity number of data points to create
+ * @param {number} min min range of integer value
+ * @param {number} max max range of integer value
+ * @returns {array} randomly generated array of objects with a date and value field
+ */
+export declare const generateRandomData: {
+    (quantity: any, min: any, max: any): {
+        group: string;
+        value: number;
+        date: Date;
+    }[];
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};
+/**
+ * Adds a generate demo data form to the story
+ */
+export declare const generateHighScaleDemoDataForm: {
+    (): string;
+    displayName: string;
+    __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+};
+export declare const addDemoDataFormListeners: (container: any, demo: any, chart: any) => void;

package/build/src/axis-chart.d.ts

@@ -0,0 +1,10 @@
+import { Chart } from './chart';
+import { ChartModelCartesian } from './model/cartesian-charts';
+import { ChartConfig, AxisChartOptions } from './interfaces';
+import { Modal, LayoutComponent, AxisChartsTooltip } from './components';
+export declare class AxisChart extends Chart {
+    services: any;
+    model: ChartModelCartesian;
+    constructor(holder: Element, chartConfigs: ChartConfig<AxisChartOptions>);
+    protected getAxisChartComponents(graphFrameComponents: any[], configs?: any): (AxisChartsTooltip | Modal | LayoutComponent)[];
+}

package/build/src/chart.d.ts

@@ -0,0 +1,14 @@
+import { ChartConfig, BaseChartOptions } from './interfaces';
+import { ChartModel } from './model/model';
+import { Component, Modal, LayoutComponent, Tooltip } from './components';
+export declare class Chart {
+    components: Component[];
+    services: any;
+    model: ChartModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<BaseChartOptions>);
+    init(holder: Element, chartConfigs: ChartConfig<BaseChartOptions>): void;
+    getComponents(): any[];
+    update(animate?: boolean): void;
+    destroy(): void;
+    protected getChartComponents(graphFrameComponents: any[], configs?: object): (Tooltip | Modal | LayoutComponent)[];
+}

package/build/src/charts/alluvial.d.ts

@@ -0,0 +1,8 @@
+import { Chart } from '../chart';
+import { AlluvialChartModel } from '../model/alluvial';
+import { ChartConfig, AlluvialChartOptions } from '../interfaces/index';
+export declare class AlluvialChart extends Chart {
+    model: AlluvialChartModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<AlluvialChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/area-stacked.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, AreaChartOptions } from '../interfaces/index';
+export declare class StackedAreaChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<AreaChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/area.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, AreaChartOptions } from '../interfaces/index';
+export declare class AreaChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<AreaChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/bar-grouped.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { BarChartOptions, ChartConfig } from '../interfaces/index';
+export declare class GroupedBarChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<BarChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/bar-simple.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { BarChartOptions, ChartConfig } from '../interfaces/index';
+export declare class SimpleBarChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<BarChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/bar-stacked.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, BarChartOptions } from '../interfaces/index';
+export declare class StackedBarChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<BarChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/boxplot.d.ts

@@ -0,0 +1,8 @@
+import { BoxplotChartModel } from '../model/boxplot';
+import { AxisChart } from '../axis-chart';
+import { BoxplotChartOptions, ChartConfig } from '../interfaces/index';
+export declare class BoxplotChart extends AxisChart {
+    model: BoxplotChartModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<BoxplotChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/bubble.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, BubbleChartOptions } from '../interfaces/index';
+export declare class BubbleChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<BubbleChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/bullet.d.ts

@@ -0,0 +1,8 @@
+import { AxisChart } from '../axis-chart';
+import { BulletChartModel } from '../model/bullet';
+import { ChartConfig, BulletChartOptions } from '../interfaces/index';
+export declare class BulletChart extends AxisChart {
+    model: BulletChartModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<BulletChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/circle-pack.d.ts

@@ -0,0 +1,8 @@
+import { Chart } from '../chart';
+import { CirclePackChartModel } from '../model/circle-pack';
+import { ChartConfig, CirclePackChartOptions } from '../interfaces/index';
+export declare class CirclePackChart extends Chart {
+    model: CirclePackChartModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<CirclePackChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/combo.d.ts

@@ -0,0 +1,7 @@
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, ComboChartOptions } from '../interfaces/index';
+export declare class ComboChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<ComboChartOptions>);
+    getGraphComponents(): any;
+    getComponents(): any[];
+}

package/build/src/charts/donut.d.ts

@@ -0,0 +1,6 @@
+import { PieChart } from './pie';
+import { ChartConfig, PieChartOptions } from '../interfaces/index';
+export declare class DonutChart extends PieChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<PieChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/gauge.d.ts

@@ -0,0 +1,8 @@
+import { Chart } from '../chart';
+import { ChartConfig, GaugeChartOptions } from '../interfaces/index';
+import { GaugeChartModel } from '../model/gauge';
+export declare class GaugeChart extends Chart {
+    model: GaugeChartModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<GaugeChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/heatmap.d.ts

@@ -0,0 +1,10 @@
+import { HeatmapModel } from '../model/heatmap';
+import { AxisChart } from '../axis-chart';
+import { HeatmapChartOptions, ChartConfig } from '../interfaces/index';
+import { Modal, LayoutComponent, AxisChartsTooltip } from '../components';
+export declare class HeatmapChart extends AxisChart {
+    model: HeatmapModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<HeatmapChartOptions>);
+    protected getAxisChartComponents(graphFrameComponents: any[], configs?: any): (AxisChartsTooltip | Modal | LayoutComponent)[];
+    getComponents(): any[];
+}

package/build/src/charts/histogram.d.ts

@@ -0,0 +1,8 @@
+import { ChartModelBinned } from '../model/binned-charts';
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, HistogramChartOptions } from '../interfaces/index';
+export declare class HistogramChart extends AxisChart {
+    model: ChartModelBinned;
+    constructor(holder: Element, chartConfigs: ChartConfig<HistogramChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/line.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, LineChartOptions } from '../interfaces/index';
+export declare class LineChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<LineChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/lollipop.d.ts

@@ -0,0 +1,6 @@
+import { AxisChart } from '../axis-chart';
+import { ChartConfig, LollipopChartOptions } from '../interfaces/index';
+export declare class LollipopChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<LollipopChartOptions>);
+    getComponents(): any[];
+}

package/build/src/charts/meter.d.ts

@@ -0,0 +1,8 @@
+import { MeterChartModel } from '../model/meter';
+import { Chart } from '../chart';
+import { ChartConfig, MeterChartOptions } from '../interfaces/index';
+export declare class MeterChart extends Chart {
+    model: MeterChartModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<MeterChartOptions>);
+    getComponents(): any[];
+}