@carbon/charts 1.7.6 → 1.8.0

package/build/demo/data/index.d.ts

@@ -23,6 +23,7 @@ export * from './zoom-bar';
 export * from './high-scale';
 export * from './alluvial';
 export * from './heatmap';
+export * from './choropleth';
 export * from './CHART_TYPES';
 export declare enum DemoGroupTypes {
     UTILITY = "utility",

package/build/demo/data/topojson-110.d.ts

@@ -0,0 +1,360 @@
+export declare const worldTopoJson: {
+    type: string;
+    arcs: number[][][];
+    transform: {
+        scale: number[];
+        translate: number[];
+    };
+    objects: {
+        countries: {
+            type: string;
+            geometries: ({
+                arcs: number[][][];
+                type: string;
+                properties: {
+                    featurecla: string;
+                    scalerank: number;
+                    LABELRANK: number;
+                    SOVEREIGNT: string;
+                    SOV_A3: string;
+                    ADM0_DIF: number;
+                    LEVEL: number;
+                    TYPE: string;
+                    TLC: string;
+                    ADMIN: string;
+                    ADM0_A3: string;
+                    GEOU_DIF: number;
+                    GEOUNIT: string;
+                    GU_A3: string;
+                    SU_DIF: number;
+                    SUBUNIT: string;
+                    SU_A3: string;
+                    BRK_DIFF: number;
+                    NAME: string;
+                    NAME_LONG: string;
+                    BRK_A3: string;
+                    BRK_NAME: string;
+                    BRK_GROUP: string;
+                    ABBREV: string;
+                    POSTAL: string;
+                    FORMAL_EN: string;
+                    FORMAL_FR: string;
+                    NAME_CIAWF: string;
+                    NOTE_ADM0: string;
+                    NOTE_BRK: string;
+                    NAME_SORT: string;
+                    NAME_ALT: string;
+                    MAPCOLOR7: number;
+                    MAPCOLOR8: number;
+                    MAPCOLOR9: number;
+                    MAPCOLOR13: number;
+                    POP_EST: number;
+                    POP_RANK: number;
+                    POP_YEAR: number;
+                    GDP_MD: number;
+                    GDP_YEAR: number;
+                    ECONOMY: string;
+                    INCOME_GRP: string;
+                    FIPS_10: string;
+                    ISO_A2: string;
+                    ISO_A2_EH: string;
+                    ISO_A3: string;
+                    ISO_A3_EH: string;
+                    ISO_N3: string;
+                    ISO_N3_EH: string;
+                    UN_A3: string;
+                    WB_A2: string;
+                    WB_A3: string;
+                    WOE_ID: number;
+                    WOE_ID_EH: number;
+                    WOE_NOTE: string;
+                    ADM0_ISO: string;
+                    ADM0_DIFF: string;
+                    ADM0_TLC: string;
+                    ADM0_A3_US: string;
+                    ADM0_A3_FR: string;
+                    ADM0_A3_RU: string;
+                    ADM0_A3_ES: string;
+                    ADM0_A3_CN: string;
+                    ADM0_A3_TW: string;
+                    ADM0_A3_IN: string;
+                    ADM0_A3_NP: string;
+                    ADM0_A3_PK: string;
+                    ADM0_A3_DE: string;
+                    ADM0_A3_GB: string;
+                    ADM0_A3_BR: string;
+                    ADM0_A3_IL: string;
+                    ADM0_A3_PS: string;
+                    ADM0_A3_SA: string;
+                    ADM0_A3_EG: string;
+                    ADM0_A3_MA: string;
+                    ADM0_A3_PT: string;
+                    ADM0_A3_AR: string;
+                    ADM0_A3_JP: string;
+                    ADM0_A3_KO: string;
+                    ADM0_A3_VN: string;
+                    ADM0_A3_TR: string;
+                    ADM0_A3_ID: string;
+                    ADM0_A3_PL: string;
+                    ADM0_A3_GR: string;
+                    ADM0_A3_IT: string;
+                    ADM0_A3_NL: string;
+                    ADM0_A3_SE: string;
+                    ADM0_A3_BD: string;
+                    ADM0_A3_UA: string;
+                    ADM0_A3_UN: number;
+                    ADM0_A3_WB: number;
+                    CONTINENT: string;
+                    REGION_UN: string;
+                    SUBREGION: string;
+                    REGION_WB: string;
+                    NAME_LEN: number;
+                    LONG_LEN: number;
+                    ABBREV_LEN: number;
+                    TINY: number;
+                    HOMEPART: number;
+                    MIN_ZOOM: number;
+                    MIN_LABEL: number;
+                    MAX_LABEL: number;
+                    LABEL_X: number;
+                    LABEL_Y: number;
+                    NE_ID: number;
+                    WIKIDATAID: string;
+                    NAME_AR: string;
+                    NAME_BN: string;
+                    NAME_DE: string;
+                    NAME_EN: string;
+                    NAME_ES: string;
+                    NAME_FA: string;
+                    NAME_FR: string;
+                    NAME_EL: string;
+                    NAME_HE: string;
+                    NAME_HI: string;
+                    NAME_HU: string;
+                    NAME_ID: string;
+                    NAME_IT: string;
+                    NAME_JA: string;
+                    NAME_KO: string;
+                    NAME_NL: string;
+                    NAME_PL: string;
+                    NAME_PT: string;
+                    NAME_RU: string;
+                    NAME_SV: string;
+                    NAME_TR: string;
+                    NAME_UK: string;
+                    NAME_UR: string;
+                    NAME_VI: string;
+                    NAME_ZH: string;
+                    NAME_ZHT: string;
+                    FCLASS_ISO: string;
+                    TLC_DIFF: string;
+                    FCLASS_TLC: string;
+                    FCLASS_US: string;
+                    FCLASS_FR: string;
+                    FCLASS_RU: string;
+                    FCLASS_ES: string;
+                    FCLASS_CN: string;
+                    FCLASS_TW: string;
+                    FCLASS_IN: string;
+                    FCLASS_NP: string;
+                    FCLASS_PK: string;
+                    FCLASS_DE: string;
+                    FCLASS_GB: string;
+                    FCLASS_BR: string;
+                    FCLASS_IL: string;
+                    FCLASS_PS: string;
+                    FCLASS_SA: string;
+                    FCLASS_EG: string;
+                    FCLASS_MA: string;
+                    FCLASS_PT: string;
+                    FCLASS_AR: string;
+                    FCLASS_JP: string;
+                    FCLASS_KO: string;
+                    FCLASS_VN: string;
+                    FCLASS_TR: string;
+                    FCLASS_ID: string;
+                    FCLASS_PL: string;
+                    FCLASS_GR: string;
+                    FCLASS_IT: string;
+                    FCLASS_NL: string;
+                    FCLASS_SE: string;
+                    FCLASS_BD: string;
+                    FCLASS_UA: string;
+                };
+            } | {
+                arcs: number[][];
+                type: string;
+                properties: {
+                    featurecla: string;
+                    scalerank: number;
+                    LABELRANK: number;
+                    SOVEREIGNT: string;
+                    SOV_A3: string;
+                    ADM0_DIF: number;
+                    LEVEL: number;
+                    TYPE: string;
+                    TLC: string;
+                    ADMIN: string;
+                    ADM0_A3: string;
+                    GEOU_DIF: number;
+                    GEOUNIT: string;
+                    GU_A3: string;
+                    SU_DIF: number;
+                    SUBUNIT: string;
+                    SU_A3: string;
+                    BRK_DIFF: number;
+                    NAME: string;
+                    NAME_LONG: string;
+                    BRK_A3: string;
+                    BRK_NAME: string;
+                    BRK_GROUP: string;
+                    ABBREV: string;
+                    POSTAL: string;
+                    FORMAL_EN: string;
+                    FORMAL_FR: string;
+                    NAME_CIAWF: string;
+                    NOTE_ADM0: string;
+                    NOTE_BRK: string;
+                    NAME_SORT: string;
+                    NAME_ALT: string;
+                    MAPCOLOR7: number;
+                    MAPCOLOR8: number;
+                    MAPCOLOR9: number;
+                    MAPCOLOR13: number;
+                    POP_EST: number;
+                    POP_RANK: number;
+                    POP_YEAR: number;
+                    GDP_MD: number;
+                    GDP_YEAR: number;
+                    ECONOMY: string;
+                    INCOME_GRP: string;
+                    FIPS_10: string;
+                    ISO_A2: string;
+                    ISO_A2_EH: string;
+                    ISO_A3: string;
+                    ISO_A3_EH: string;
+                    ISO_N3: string;
+                    ISO_N3_EH: string;
+                    UN_A3: string;
+                    WB_A2: string;
+                    WB_A3: string;
+                    WOE_ID: number;
+                    WOE_ID_EH: number;
+                    WOE_NOTE: string;
+                    ADM0_ISO: string;
+                    ADM0_DIFF: string;
+                    ADM0_TLC: string;
+                    ADM0_A3_US: string;
+                    ADM0_A3_FR: string;
+                    ADM0_A3_RU: string;
+                    ADM0_A3_ES: string;
+                    ADM0_A3_CN: string;
+                    ADM0_A3_TW: string;
+                    ADM0_A3_IN: string;
+                    ADM0_A3_NP: string;
+                    ADM0_A3_PK: string;
+                    ADM0_A3_DE: string;
+                    ADM0_A3_GB: string;
+                    ADM0_A3_BR: string;
+                    ADM0_A3_IL: string;
+                    ADM0_A3_PS: string;
+                    ADM0_A3_SA: string;
+                    ADM0_A3_EG: string;
+                    ADM0_A3_MA: string;
+                    ADM0_A3_PT: string;
+                    ADM0_A3_AR: string;
+                    ADM0_A3_JP: string;
+                    ADM0_A3_KO: string;
+                    ADM0_A3_VN: string;
+                    ADM0_A3_TR: string;
+                    ADM0_A3_ID: string;
+                    ADM0_A3_PL: string;
+                    ADM0_A3_GR: string;
+                    ADM0_A3_IT: string;
+                    ADM0_A3_NL: string;
+                    ADM0_A3_SE: string;
+                    ADM0_A3_BD: string;
+                    ADM0_A3_UA: string;
+                    ADM0_A3_UN: number;
+                    ADM0_A3_WB: number;
+                    CONTINENT: string;
+                    REGION_UN: string;
+                    SUBREGION: string;
+                    REGION_WB: string;
+                    NAME_LEN: number;
+                    LONG_LEN: number;
+                    ABBREV_LEN: number;
+                    TINY: number;
+                    HOMEPART: number;
+                    MIN_ZOOM: number;
+                    MIN_LABEL: number;
+                    MAX_LABEL: number;
+                    LABEL_X: number;
+                    LABEL_Y: number;
+                    NE_ID: number;
+                    WIKIDATAID: string;
+                    NAME_AR: string;
+                    NAME_BN: string;
+                    NAME_DE: string;
+                    NAME_EN: string;
+                    NAME_ES: string;
+                    NAME_FA: string;
+                    NAME_FR: string;
+                    NAME_EL: string;
+                    NAME_HE: string;
+                    NAME_HI: string;
+                    NAME_HU: string;
+                    NAME_ID: string;
+                    NAME_IT: string;
+                    NAME_JA: string;
+                    NAME_KO: string;
+                    NAME_NL: string;
+                    NAME_PL: string;
+                    NAME_PT: string;
+                    NAME_RU: string;
+                    NAME_SV: string;
+                    NAME_TR: string;
+                    NAME_UK: string;
+                    NAME_UR: string;
+                    NAME_VI: string;
+                    NAME_ZH: string;
+                    NAME_ZHT: string;
+                    FCLASS_ISO: string;
+                    TLC_DIFF: string;
+                    FCLASS_TLC: string;
+                    FCLASS_US: string;
+                    FCLASS_FR: string;
+                    FCLASS_RU: string;
+                    FCLASS_ES: string;
+                    FCLASS_CN: string;
+                    FCLASS_TW: string;
+                    FCLASS_IN: string;
+                    FCLASS_NP: string;
+                    FCLASS_PK: string;
+                    FCLASS_DE: string;
+                    FCLASS_GB: string;
+                    FCLASS_BR: string;
+                    FCLASS_IL: string;
+                    FCLASS_PS: string;
+                    FCLASS_SA: string;
+                    FCLASS_EG: string;
+                    FCLASS_MA: string;
+                    FCLASS_PT: string;
+                    FCLASS_AR: string;
+                    FCLASS_JP: string;
+                    FCLASS_KO: string;
+                    FCLASS_VN: string;
+                    FCLASS_TR: string;
+                    FCLASS_ID: string;
+                    FCLASS_PL: string;
+                    FCLASS_GR: string;
+                    FCLASS_IT: string;
+                    FCLASS_NL: string;
+                    FCLASS_SE: string;
+                    FCLASS_BD: string;
+                    FCLASS_UA: string;
+                };
+            })[];
+        };
+    };
+};

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

@@ -0,0 +1,10 @@
+import { Chart } from '../chart';
+import { ChoroplethModel } from '../model/choropleth';
+import { ChoroplethChartOptions, ChartConfig } from '../interfaces/index';
+import { Modal, LayoutComponent, Tooltip } from '../components';
+export declare class EXPERIMENTAL_ChoroplethChart extends Chart {
+    model: ChoroplethModel;
+    constructor(holder: Element, chartConfigs: ChartConfig<ChoroplethChartOptions>);
+    protected getChartComponents(graphFrameComponents: any[], configs?: any): (Tooltip | Modal | LayoutComponent)[];
+    getComponents(): any[];
+}

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

@@ -22,3 +22,4 @@ export * from './circle-pack';
 export * from './wordcloud';
 export * from './alluvial';
 export * from './heatmap';
+export * from './choropleth';

package/build/src/components/essentials/color-scale-legend.d.ts

@@ -1,9 +1,12 @@
 import { RenderTypes } from '../../interfaces';
 import { Legend } from './legend';
+import { ChartModel } from '../../model/model';
 export declare class ColorScaleLegend extends Legend {
     type: string;
     renderType: RenderTypes;
     private gradient_id;
+    private chartType;
+    constructor(model: ChartModel, services: any, configs?: any);
     init(): void;
     handleAxisCompleteEvent: (event: CustomEvent<any>) => void;
     render(animate?: boolean): void;

package/build/src/components/essentials/geo-projection.d.ts

@@ -0,0 +1,16 @@
+import { Component } from '../component';
+import { RenderTypes } from '../../interfaces';
+export declare class GeoProjection extends Component {
+    type: string;
+    renderType: RenderTypes;
+    render(): void;
+    /**
+     * @info
+     * Depending on projection, we may need to provide additional configuration
+     * e.g. sizing
+     *
+     * In such case, function can be refactored so that
+     * projection should return an object with the configuraiton & function
+     */
+    getProjection(): any;
+}

package/build/src/components/graphs/choropleth.d.ts

@@ -0,0 +1,6 @@
+import { GeoProjection } from '../essentials/geo-projection';
+export declare class Choropleth extends GeoProjection {
+    type: string;
+    render(animate?: boolean): void;
+    addCountryAreaEventListener(): void;
+}

package/build/src/components/index.d.ts

@@ -9,6 +9,7 @@ export * from './essentials/tooltip';
 export * from './essentials/tooltip-axis';
 export * from './essentials/canvas-chart-clip';
 export * from './essentials/highlights';
+export * from './essentials/geo-projection';
 export * from './graphs/area';
 export * from './graphs/area-stacked';
 export * from './graphs/bar-simple';
@@ -34,6 +35,7 @@ export * from './graphs/circle-pack';
 export * from './graphs/wordcloud';
 export * from './graphs/alluvial';
 export * from './graphs/heatmap';
+export * from './graphs/choropleth';
 export * from './layout/spacer';
 export * from './layout/layout';
 export * from './axes/two-dimensional-axes';

package/build/src/configuration.d.ts

@@ -1,4 +1,4 @@
-import { BaseChartOptions, AxisChartOptions, ScatterChartOptions, LollipopChartOptions, LineChartOptions, BarChartOptions, StackedBarChartOptions, BoxplotChartOptions, AreaChartOptions, PieChartOptions, GaugeChartOptions, DonutChartOptions, BubbleChartOptions, BulletChartOptions, HistogramChartOptions, RadarChartOptions, ComboChartOptions, TreeChartOptions, TreemapChartOptions, CirclePackChartOptions, WorldCloudChartOptions, AlluvialChartOptions, GridOptions, RulerOptions, TimeScaleOptions, TooltipOptions, MeterChartOptions, ProportionalMeterChartOptions, HeatmapChartOptions } from './interfaces';
+import { BaseChartOptions, AxisChartOptions, ScatterChartOptions, LollipopChartOptions, LineChartOptions, BarChartOptions, StackedBarChartOptions, BoxplotChartOptions, AreaChartOptions, PieChartOptions, GaugeChartOptions, DonutChartOptions, BubbleChartOptions, BulletChartOptions, HistogramChartOptions, RadarChartOptions, ComboChartOptions, TreeChartOptions, TreemapChartOptions, CirclePackChartOptions, WorldCloudChartOptions, AlluvialChartOptions, ThematicChartOptions, ChoroplethChartOptions, GridOptions, RulerOptions, TimeScaleOptions, TooltipOptions, MeterChartOptions, ProportionalMeterChartOptions, HeatmapChartOptions } from './interfaces';
 /**
  * Grid options
  */
@@ -15,6 +15,7 @@ export declare const timeScale: TimeScaleOptions;
 export declare const options: {
     chart: BaseChartOptions;
     axisChart: AxisChartOptions;
+    thematicChart: ThematicChartOptions;
     simpleBarChart: BarChartOptions;
     groupedBarChart: BarChartOptions;
     stackedBarChart: StackedBarChartOptions;
@@ -40,5 +41,6 @@ export declare const options: {
     wordCloudChart: WorldCloudChartOptions;
     alluvialChart: AlluvialChartOptions;
     heatmapChart: HeatmapChartOptions;
+    choroplethChart: ChoroplethChartOptions;
 };
 export * from './configuration-non-customizable';

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

@@ -1,4 +1,4 @@
-import { GaugeTypes, Statuses, ArrowDirections, Alignments, ChartTypes, TreeTypes, DividerStatus, ColorLegendType, ChartTheme } from './enums';
+import { GaugeTypes, Statuses, ArrowDirections, Alignments, ChartTypes, TreeTypes, DividerStatus, ColorLegendType, ChartTheme, Projection } from './enums';
 import { LegendOptions, TooltipOptions, GridOptions, AxesOptions, ZoomBarsOptions } from './index';
 import { BarOptions, StackedBarOptions, ToolbarOptions } from './components';
 import { AxisOptions, BinnedAxisOptions, ComboChartAxisOptions, TimeScaleOptions } from './axis-scales';
@@ -483,3 +483,30 @@ export interface HeatmapChartOptions extends BaseChartOptions {
         };
     };
 }
+/**
+ * Options common to any thematic chart
+ */
+export interface ThematicChartOptions extends BaseChartOptions {
+    thematic: {
+        projection: Projection;
+    };
+}
+/**
+ * Options common to any thematic chart
+ */
+export interface ChoroplethChartOptions extends ThematicChartOptions {
+    choropleth: {
+        /**
+         * customize color legend
+         * enabled by default on select charts
+         */
+        colorLegend?: {
+            /**
+             * Text to display beside or on top of the legend
+             * Position is determined by text length
+             */
+            title?: string;
+            type: ColorLegendType;
+        };
+    };
+}

package/build/src/interfaces/enums.d.ts

@@ -247,3 +247,15 @@ export declare enum AxisFlavor {
     DEFAULT = "default",
     HOVERABLE = "hoverable"
 }
+/**
+ * enum of supported projection types
+ */
+export declare enum Projection {
+    geoEqualEarth = "geoEqualEarth",
+    geoAlbers = "geoAlbers",
+    geoConicEqualArea = "geoConicEqualArea",
+    geoConicEquidistant = "geoConicEquidistant",
+    geoEquirectangular = "geoEquirectangular",
+    geoMercator = "geoMercator",
+    geoNaturalEarth1 = "geoNaturalEarth1"
+}

package/build/src/interfaces/events.d.ts

@@ -228,3 +228,12 @@ export declare enum Heatmap {
     HEATMAP_MOUSEOUT = "heatmap-mouseout",
     HEATMAP_MOUSEMOVE = "hetmap-mousemove"
 }
+/**
+ * enum of all choropleth related events
+ */
+export declare enum Choropleth {
+    CHOROPLETH_MOUSEOVER = "choropleth-mouseover",
+    CHOROPLETH_CLICK = "choropleth-click",
+    CHOROPLETH_MOUSEOUT = "choropleth-mouseout",
+    CHOROPLETH_MOUSEMOVE = "choropleth-mousemove"
+}

package/build/src/model/choropleth.d.ts

@@ -0,0 +1,29 @@
+import { ChartModel } from './model';
+/**
+ * Base thematic maps chart model layer
+ */
+export declare class ChoroplethModel extends ChartModel {
+    private _colorScale;
+    private _matrix;
+    constructor(services: any);
+    /**
+     * @override
+     * @param value
+     * @returns string
+     */
+    getFillColor(value: number): any;
+    /**
+     * Helper function that will generate a dictionary
+     */
+    getCombinedData(): {};
+    /**
+     * Generate tabular data from display data
+     * @returns Array<Object>
+     */
+    getTabularDataArray(): any[];
+    getColorClassName(configs: {
+        value?: number;
+        originalClassName?: string;
+    }): string;
+    protected setColorClassNames(): void;
+}

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

@@ -8,11 +8,6 @@ export declare class HeatmapModel extends ChartModelCartesian {
     private _ranges;
     private _matrix;
     constructor(services: any);
-    /**
-     * Get min and maximum value of the display data
-     * @returns Array consisting of smallest and largest values in  data
-     */
-    getValueDomain(): number[];
     /**
      * @override
      * @param value

package/build/src/services/color-scale-utils.d.ts

@@ -0,0 +1,10 @@
+export declare function getDomain(data: any): number[];
+export declare namespace getDomain {
+    var displayName: string;
+    var __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {};
+    };
+}
+export declare function getColorScale(displayData: any, colorOptions: any): import("d3-scale").ScaleQuantize<number, never>;

package/build/src/services/index.d.ts

@@ -7,3 +7,4 @@ export * from './scales-cartesian';
 export * from './curves';
 export * from './zoom';
 export * from './canvas-zoom';
+export * from './color-scale-utils';

package/build/src/services/scales-cartesian.d.ts

@@ -58,7 +58,7 @@ export declare class CartesianScales extends Service {
     getMainYScaleType(): any;
     getDomainIdentifier(datum?: any): any;
     getRangeIdentifier(datum?: any): any;
-    extendsDomain(axisPosition: AxisPositions, domain: any): Date[] | number[];
+    extendsDomain(axisPosition: AxisPositions, domain: any): number[] | Date[];
     protected findVerticalAxesPositions(): {
         primary: AxisPositions;
         secondary: AxisPositions;