@carbon/charts 0.53.2 → 0.54.0

package/model/heatmap.d.ts

@@ -0,0 +1,57 @@
+import { AxisFlavor } from '../interfaces';
+import { ChartModelCartesian } from './cartesian-charts';
+/** The gauge chart model layer */
+export declare class HeatmapModel extends ChartModelCartesian {
+    protected axisFlavor: AxisFlavor;
+    private _colorScale;
+    private _domains;
+    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(): any[];
+    /**
+     * @override
+     * @param value
+     * @returns
+     */
+    getFillColor(value: number): any;
+    /**
+     * Generate a list of all unique domains
+     * @returns String[]
+     */
+    getUniqueDomain(): string[];
+    /**
+     * Generates a list of all unique ranges
+     * @returns String[]
+     */
+    getUniqueRanges(): string[];
+    /**
+     * Generates a matrix (If doesn't exist) and returns it
+     * @returns Object
+     */
+    getMatrix(): {};
+    /**
+     *
+     * @param newData The new raw data to be set
+     */
+    setData(newData: any): any;
+    /**
+     * Converts Object matrix into a single array
+     * @returns Object[]
+     */
+    getMatrixAsArray(): Object[];
+    /**
+     * Generate tabular data from display data
+     * @returns Array<Object>
+     */
+    getTabularDataArray(): any[];
+    getColorClassName(configs: {
+        value?: number;
+        originalClassName?: string;
+    }): string;
+    protected setColorClassNames(): void;
+}

package/model/heatmap.js

@@ -0,0 +1,289 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __spreadArrays = (this && this.__spreadArrays) || function () {
+    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
+    for (var r = Array(s), k = 0, i = 0; i < il; i++)
+        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
+            r[k] = a[j];
+    return r;
+};
+// Internal Imports
+import { AxisFlavor, ScaleTypes } from '../interfaces';
+import { ChartModelCartesian } from './cartesian-charts';
+import { Tools } from '../tools';
+// d3 imports
+import { extent } from 'd3-array';
+import { scaleQuantize } from 'd3-scale';
+/** The gauge chart model layer */
+var HeatmapModel = /** @class */ (function (_super) {
+    __extends(HeatmapModel, _super);
+    function HeatmapModel(services) {
+        var _this = _super.call(this, services) || this;
+        _this.axisFlavor = AxisFlavor.HOVERABLE;
+        _this._colorScale = undefined;
+        // List of unique ranges and domains
+        _this._domains = [];
+        _this._ranges = [];
+        _this._matrix = {};
+        // Check which scale types are being used
+        var axis = Tools.getProperty(_this.getOptions(), 'axes');
+        // Need to check options since scale service hasn't been instantiated
+        if ((!!Tools.getProperty(axis, 'left', 'scaleType') &&
+            Tools.getProperty(axis, 'left', 'scaleType') !==
+                ScaleTypes.LABELS) ||
+            (!!Tools.getProperty(axis, 'right', 'scaleType') &&
+                Tools.getProperty(axis, 'right', 'scaleType') !==
+                    ScaleTypes.LABELS) ||
+            (!!Tools.getProperty(axis, 'top', 'scaleType') &&
+                Tools.getProperty(axis, 'top', 'scaleType') !==
+                    ScaleTypes.LABELS) ||
+            (!!Tools.getProperty(axis, 'bottom', 'scaleType') &&
+                Tools.getProperty(axis, 'bottom', 'scaleType') !==
+                    ScaleTypes.LABELS)) {
+            throw Error('Heatmap only supports label scaletypes.');
+        }
+        return _this;
+    }
+    /**
+     * Get min and maximum value of the display data
+     * @returns Array consisting of smallest and largest values in  data
+     */
+    HeatmapModel.prototype.getValueDomain = function () {
+        var data = this.getDisplayData().map(function (element) { return element.value; });
+        var limits = extent(data);
+        var domain = [];
+        // Round extent values to the nearest multiple of 10
+        // Axis rounds values to multiples of 2, 5, and 10s.
+        limits.forEach(function (number, index) {
+            var value = Number(number);
+            if (index === 0 && value >= 0) {
+                value = 0;
+            }
+            else if (value % 10 === 0 || value === 0) {
+                value;
+            }
+            else if (value < 0) {
+                value = Math.floor(value / 10) * 10;
+            }
+            else {
+                value = Math.ceil(value / 10) * 10;
+            }
+            domain.push(value);
+        });
+        // Ensure the median of the range is 0
+        if (domain[0] < 0 && domain[1] > 0) {
+            if (Math.abs(domain[0]) > domain[1]) {
+                domain[1] = Math.abs(domain[0]);
+            }
+            else {
+                domain[0] = -domain[1];
+            }
+        }
+        return domain;
+    };
+    /**
+     * @override
+     * @param value
+     * @returns
+     */
+    HeatmapModel.prototype.getFillColor = function (value) {
+        return this._colorScale(value);
+    };
+    /**
+     * Generate a list of all unique domains
+     * @returns String[]
+     */
+    HeatmapModel.prototype.getUniqueDomain = function () {
+        if (Tools.isEmpty(this._domains)) {
+            var displayData = this.getDisplayData();
+            var cartesianScales = this.services.cartesianScales;
+            var domainIdentifier_1 = cartesianScales.getDomainIdentifier();
+            var mainXAxisPosition = cartesianScales.getMainXAxisPosition();
+            var customDomain = cartesianScales.getCustomDomainValuesByposition(mainXAxisPosition);
+            // Use user defined domain if specified
+            if (!!customDomain) {
+                return customDomain;
+            }
+            // Get unique axis values & create a matrix
+            this._domains = Array.from(new Set(displayData.map(function (d) {
+                return d[domainIdentifier_1];
+            })));
+        }
+        return this._domains;
+    };
+    /**
+     * Generates a list of all unique ranges
+     * @returns String[]
+     */
+    HeatmapModel.prototype.getUniqueRanges = function () {
+        if (Tools.isEmpty(this._ranges)) {
+            var displayData = this.getDisplayData();
+            var cartesianScales = this.services.cartesianScales;
+            var rangeIdentifier_1 = cartesianScales.getRangeIdentifier();
+            var mainYAxisPosition = cartesianScales.getMainYAxisPosition();
+            var customDomain = cartesianScales.getCustomDomainValuesByposition(mainYAxisPosition);
+            // Use user defined domain if specified
+            if (!!customDomain) {
+                return customDomain;
+            }
+            // Get unique axis values & create a matrix
+            this._ranges = Array.from(new Set(displayData.map(function (d) {
+                return d[rangeIdentifier_1];
+            })));
+        }
+        return this._ranges;
+    };
+    /**
+     * Generates a matrix (If doesn't exist) and returns it
+     * @returns Object
+     */
+    HeatmapModel.prototype.getMatrix = function () {
+        var _this = this;
+        if (Tools.isEmpty(this._matrix)) {
+            var uniqueDomain = this.getUniqueDomain();
+            var uniqueRange = this.getUniqueRanges();
+            var domainIdentifier_2 = this.services.cartesianScales.getDomainIdentifier();
+            var rangeIdentifier_2 = this.services.cartesianScales.getRangeIdentifier();
+            // Create a column
+            var range_1 = {};
+            uniqueRange.forEach(function (ran) {
+                // Initialize matrix to empty state
+                range_1[ran] = {
+                    value: null,
+                    index: -1,
+                };
+            });
+            // Complete the matrix by cloning the column to all domains
+            uniqueDomain.forEach(function (dom) {
+                _this._matrix[dom] = Tools.clone(range_1);
+            });
+            // Fill in user passed data
+            this.getDisplayData().forEach(function (d, i) {
+                _this._matrix[d[domainIdentifier_2]][d[rangeIdentifier_2]] = {
+                    value: d['value'],
+                    index: i,
+                };
+            });
+        }
+        return this._matrix;
+    };
+    /**
+     *
+     * @param newData The new raw data to be set
+     */
+    HeatmapModel.prototype.setData = function (newData) {
+        var sanitizedData = this.sanitize(Tools.clone(newData));
+        var dataGroups = this.generateDataGroups(sanitizedData);
+        this.set({
+            data: sanitizedData,
+            dataGroups: dataGroups,
+        });
+        // Set attributes to empty
+        this._domains = [];
+        this._ranges = [];
+        this._matrix = {};
+        return sanitizedData;
+    };
+    /**
+     * Converts Object matrix into a single array
+     * @returns Object[]
+     */
+    HeatmapModel.prototype.getMatrixAsArray = function () {
+        var _this = this;
+        if (Tools.isEmpty(this._matrix)) {
+            this.getMatrix();
+        }
+        var uniqueDomain = this.getUniqueDomain();
+        var uniqueRange = this.getUniqueRanges();
+        var domainIdentifier = this.services.cartesianScales.getDomainIdentifier();
+        var rangeIdentifier = this.services.cartesianScales.getRangeIdentifier();
+        var arr = [];
+        uniqueDomain.forEach(function (domain) {
+            uniqueRange.forEach(function (range) {
+                var element = {
+                    value: _this._matrix[domain][range].value,
+                    index: _this._matrix[domain][range].index,
+                };
+                element[domainIdentifier] = domain;
+                element[rangeIdentifier] = range;
+                arr.push(element);
+            });
+        });
+        return arr;
+    };
+    /**
+     * Generate tabular data from display data
+     * @returns Array<Object>
+     */
+    HeatmapModel.prototype.getTabularDataArray = function () {
+        var displayData = this.getDisplayData();
+        var _a = this.assignRangeAndDomains(), primaryDomain = _a.primaryDomain, primaryRange = _a.primaryRange, secondaryDomain = _a.secondaryDomain, secondaryRange = _a.secondaryRange;
+        var domainValueFormatter;
+        var result = __spreadArrays([
+            [primaryDomain.label, primaryRange.label, 'Value']
+        ], displayData.map(function (datum) { return [
+            datum[primaryDomain.identifier] === null
+                ? '&ndash;'
+                : domainValueFormatter
+                    ? domainValueFormatter(datum[primaryDomain.identifier])
+                    : datum[primaryDomain.identifier],
+            datum[primaryRange.identifier] === null
+                ? '&ndash;'
+                : datum[primaryRange.identifier].toLocaleString(),
+            datum['value'],
+        ]; }));
+        return result;
+    };
+    // Uses quantize scale to return class names
+    HeatmapModel.prototype.getColorClassName = function (configs) {
+        return configs.originalClassName + " " + this._colorScale(configs.value);
+    };
+    HeatmapModel.prototype.setColorClassNames = function () {
+        var options = this.getOptions();
+        var customColors = Tools.getProperty(options, 'color', 'gradient', 'colors');
+        var customColorsEnabled = !Tools.isEmpty(customColors);
+        var colorPairingOption = Tools.getProperty(options, 'color', 'pairing', 'option');
+        // If domain consists of negative and positive values, use diverging palettes
+        var domain = this.getValueDomain();
+        var colorScheme = domain[0] < 0 && domain[1] > 0 ? 'diverge' : 'mono';
+        // Use default color pairing options if not in defined range
+        if (colorPairingOption < 1 &&
+            colorPairingOption > 4 &&
+            colorScheme === 'mono') {
+            colorPairingOption = 1;
+        }
+        else if (colorPairingOption < 1 &&
+            colorPairingOption > 2 &&
+            colorScheme === 'diverge') {
+            colorPairingOption = 1;
+        }
+        // Uses css classes for fill
+        var colorPairing = customColorsEnabled ? customColors : [];
+        if (!customColorsEnabled) {
+            // Add class names to list and the amount based on the color scheme
+            // Carbon charts has 11 colors for a single monochromatic palette & 17 for a divergent palette
+            var colorGroupingLength = colorScheme === 'diverge' ? 17 : 11;
+            for (var i = 1; i < colorGroupingLength + 1; i++) {
+                colorPairing.push("fill-" + colorScheme + "-" + colorPairingOption + "-" + i);
+            }
+        }
+        // Save scale type
+        this._colorScale = scaleQuantize()
+            .domain(this.getValueDomain())
+            .range(colorPairing);
+    };
+    return HeatmapModel;
+}(ChartModelCartesian));
+export { HeatmapModel };
+//# sourceMappingURL=../../src/model/heatmap.js.map

package/model/heatmap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heatmap.js","sourceRoot":"","sources":["heatmap.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,mBAAmB;AACnB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,aAAa;AACb,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,kCAAkC;AAClC;IAAkC,gCAAmB;IAUpD,sBAAY,QAAa;QAAzB,YACC,kBAAM,QAAQ,CAAC,SAsBf;QAhCS,gBAAU,GAAG,UAAU,CAAC,SAAS,CAAC;QACpC,iBAAW,GAAQ,SAAS,CAAC;QAErC,oCAAoC;QAC5B,cAAQ,GAAG,EAAE,CAAC;QACd,aAAO,GAAG,EAAE,CAAC;QAEb,aAAO,GAAG,EAAE,CAAC;QAKpB,yCAAyC;QACzC,IAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,KAAI,CAAC,UAAU,EAAE,EAAE,MAAM,CAAC,CAAC;QAE1D,qEAAqE;QACrE,IACC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC;YAC9C,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC;gBAC3C,UAAU,CAAC,MAAM,CAAC;YACpB,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC;gBAC/C,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC;oBAC5C,UAAU,CAAC,MAAM,CAAC;YACpB,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC;gBAC7C,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC;oBAC1C,UAAU,CAAC,MAAM,CAAC;YACpB,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC;gBAChD,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC;oBAC7C,UAAU,CAAC,MAAM,CAAC,EACnB;YACD,MAAM,KAAK,CAAC,yCAAyC,CAAC,CAAC;SACvD;;IACF,CAAC;IAED;;;OAGG;IACH,qCAAc,GAAd;QACC,IAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,KAAK,EAAb,CAAa,CAAC,CAAC;QACnE,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAM,MAAM,GAAG,EAAE,CAAC;QAElB,oDAAoD;QACpD,oDAAoD;QACpD,MAAM,CAAC,OAAO,CAAC,UAAC,MAAM,EAAE,KAAK;YAC5B,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YAE3B,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;gBAC9B,KAAK,GAAG,CAAC,CAAC;aACV;iBAAM,IAAI,KAAK,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE;gBAC3C,KAAK,CAAC;aACN;iBAAM,IAAI,KAAK,GAAG,CAAC,EAAE;gBACrB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;aACpC;iBAAM;gBACN,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;aACnC;YAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QAEH,sCAAsC;QACtC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;YACnC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE;gBACpC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aAChC;iBAAM;gBACN,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aACvB;SACD;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,mCAAY,GAAZ,UAAa,KAAa;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,sCAAe,GAAf;QACC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACjC,IAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YAClC,IAAA,+CAAe,CAAmB;YAE1C,IAAM,kBAAgB,GAAG,eAAe,CAAC,mBAAmB,EAAE,CAAC;YAC/D,IAAM,iBAAiB,GAAG,eAAe,CAAC,oBAAoB,EAAE,CAAC;YACjE,IAAM,YAAY,GAAG,eAAe,CAAC,+BAA+B,CACnE,iBAAiB,CACjB,CAAC;YAEF,uCAAuC;YACvC,IAAI,CAAC,CAAC,YAAY,EAAE;gBACnB,OAAO,YAAY,CAAC;aACpB;YAED,2CAA2C;YAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CACzB,IAAI,GAAG,CACN,WAAW,CAAC,GAAG,CAAC,UAAC,CAAC;gBACjB,OAAO,CAAC,CAAC,kBAAgB,CAAC,CAAC;YAC5B,CAAC,CAAC,CACF,CACD,CAAC;SACF;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,sCAAe,GAAf;QACC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAChC,IAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YAClC,IAAA,+CAAe,CAAmB;YAE1C,IAAM,iBAAe,GAAG,eAAe,CAAC,kBAAkB,EAAE,CAAC;YAC7D,IAAM,iBAAiB,GAAG,eAAe,CAAC,oBAAoB,EAAE,CAAC;YACjE,IAAM,YAAY,GAAG,eAAe,CAAC,+BAA+B,CACnE,iBAAiB,CACjB,CAAC;YAEF,uCAAuC;YACvC,IAAI,CAAC,CAAC,YAAY,EAAE;gBACnB,OAAO,YAAY,CAAC;aACpB;YAED,2CAA2C;YAC3C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CACxB,IAAI,GAAG,CACN,WAAW,CAAC,GAAG,CAAC,UAAC,CAAC;gBACjB,OAAO,CAAC,CAAC,iBAAe,CAAC,CAAC;YAC3B,CAAC,CAAC,CACF,CACD,CAAC;SACF;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,gCAAS,GAAT;QAAA,iBAiCC;QAhCA,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAChC,IAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YAC5C,IAAM,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YAE3C,IAAM,kBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;YAC7E,IAAM,iBAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,kBAAkB,EAAE,CAAC;YAE3E,kBAAkB;YAClB,IAAM,OAAK,GAAG,EAAE,CAAC;YACjB,WAAW,CAAC,OAAO,CAAC,UAAC,GAAQ;gBAC5B,mCAAmC;gBACnC,OAAK,CAAC,GAAG,CAAC,GAAG;oBACZ,KAAK,EAAE,IAAI;oBACX,KAAK,EAAE,CAAC,CAAC;iBACT,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,2DAA2D;YAC3D,YAAY,CAAC,OAAO,CAAC,UAAC,GAAQ;gBAC7B,KAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,2BAA2B;YAC3B,IAAI,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,UAAC,CAAC,EAAE,CAAC;gBAClC,KAAI,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAe,CAAC,CAAC,GAAG;oBACvD,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC;oBACjB,KAAK,EAAE,CAAC;iBACR,CAAC;YACH,CAAC,CAAC,CAAC;SACH;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,8BAAO,GAAP,UAAQ,OAAO;QACd,IAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1D,IAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAE1D,IAAI,CAAC,GAAG,CAAC;YACR,IAAI,EAAE,aAAa;YACnB,UAAU,YAAA;SACV,CAAC,CAAC;QAEH,0BAA0B;QAC1B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,uCAAgB,GAAhB;QAAA,iBAyBC;QAxBA,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAChC,IAAI,CAAC,SAAS,EAAE,CAAC;SACjB;QAED,IAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,IAAM,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAE3C,IAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;QAC7E,IAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,kBAAkB,EAAE,CAAC;QAE3E,IAAM,GAAG,GAAG,EAAE,CAAC;QACf,YAAY,CAAC,OAAO,CAAC,UAAC,MAAM;YAC3B,WAAW,CAAC,OAAO,CAAC,UAAC,KAAK;gBACzB,IAAM,OAAO,GAAG;oBACf,KAAK,EAAE,KAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK;oBACxC,KAAK,EAAE,KAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK;iBACxC,CAAC;gBACF,OAAO,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAC;gBACnC,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;gBACjC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QACC,IAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEpC,IAAA,iCAK0B,EAJ/B,gCAAa,EACb,8BAAY,EACZ,oCAAe,EACf,kCAC+B,CAAC;QAEjC,IAAI,oBAAoB,CAAC;QAEzB,IAAM,MAAM;YACX,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC;WAC/C,WAAW,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA;YAC7B,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,IAAI;gBACvC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,oBAAoB;oBACtB,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;oBACvD,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC;YAClC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,IAAI;gBACtC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,cAAc,EAAE;YAClD,KAAK,CAAC,OAAO,CAAC;SACd,EAV6B,CAU7B,CAAC,CACF,CAAC;QAEF,OAAO,MAAM,CAAC;IACf,CAAC;IAED,4CAA4C;IAC5C,wCAAiB,GAAjB,UAAkB,OAAuD;QACxE,OAAU,OAAO,CAAC,iBAAiB,SAAI,IAAI,CAAC,WAAW,CACtD,OAAO,CAAC,KAAe,CACrB,CAAC;IACL,CAAC;IAES,yCAAkB,GAA5B;QACC,IAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAElC,IAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CACrC,OAAO,EACP,OAAO,EACP,UAAU,EACV,QAAQ,CACR,CAAC;QACF,IAAM,mBAAmB,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAEzD,IAAI,kBAAkB,GAAG,KAAK,CAAC,WAAW,CACzC,OAAO,EACP,OAAO,EACP,SAAS,EACT,QAAQ,CACR,CAAC;QAEF,6EAA6E;QAC7E,IAAM,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACrC,IAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;QAExE,4DAA4D;QAC5D,IACC,kBAAkB,GAAG,CAAC;YACtB,kBAAkB,GAAG,CAAC;YACtB,WAAW,KAAK,MAAM,EACrB;YACD,kBAAkB,GAAG,CAAC,CAAC;SACvB;aAAM,IACN,kBAAkB,GAAG,CAAC;YACtB,kBAAkB,GAAG,CAAC;YACtB,WAAW,KAAK,SAAS,EACxB;YACD,kBAAkB,GAAG,CAAC,CAAC;SACvB;QAED,4BAA4B;QAC5B,IAAM,YAAY,GAAG,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;QAE7D,IAAI,CAAC,mBAAmB,EAAE;YACzB,mEAAmE;YACnE,8FAA8F;YAC9F,IAAM,mBAAmB,GAAG,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAChE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;gBACjD,YAAY,CAAC,IAAI,CAChB,UAAQ,WAAW,SAAI,kBAAkB,SAAI,CAAG,CAChD,CAAC;aACF;SACD;QAED,kBAAkB;QAClB,IAAI,CAAC,WAAW,GAAG,aAAa,EAAE;aAChC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAsB,CAAC;aACjD,KAAK,CAAC,YAAY,CAAC,CAAC;IACvB,CAAC;IACF,mBAAC;AAAD,CAAC,AAjVD,CAAkC,mBAAmB,GAiVpD","sourcesContent":["// Internal Imports\nimport { AxisFlavor, ScaleTypes } from '../interfaces';\nimport { ChartModelCartesian } from './cartesian-charts';\nimport { Tools } from '../tools';\n\n// d3 imports\nimport { extent } from 'd3-array';\nimport { scaleQuantize } from 'd3-scale';\n\n/** The gauge chart model layer */\nexport class HeatmapModel extends ChartModelCartesian {\n\tprotected axisFlavor = AxisFlavor.HOVERABLE;\n\tprivate _colorScale: any = undefined;\n\n\t// List of unique ranges and domains\n\tprivate _domains = [];\n\tprivate _ranges = [];\n\n\tprivate _matrix = {};\n\n\tconstructor(services: any) {\n\t\tsuper(services);\n\n\t\t// Check which scale types are being used\n\t\tconst axis = Tools.getProperty(this.getOptions(), 'axes');\n\n\t\t// Need to check options since scale service hasn't been instantiated\n\t\tif (\n\t\t\t(!!Tools.getProperty(axis, 'left', 'scaleType') &&\n\t\t\t\tTools.getProperty(axis, 'left', 'scaleType') !==\n\t\t\t\t\tScaleTypes.LABELS) ||\n\t\t\t(!!Tools.getProperty(axis, 'right', 'scaleType') &&\n\t\t\t\tTools.getProperty(axis, 'right', 'scaleType') !==\n\t\t\t\t\tScaleTypes.LABELS) ||\n\t\t\t(!!Tools.getProperty(axis, 'top', 'scaleType') &&\n\t\t\t\tTools.getProperty(axis, 'top', 'scaleType') !==\n\t\t\t\t\tScaleTypes.LABELS) ||\n\t\t\t(!!Tools.getProperty(axis, 'bottom', 'scaleType') &&\n\t\t\t\tTools.getProperty(axis, 'bottom', 'scaleType') !==\n\t\t\t\t\tScaleTypes.LABELS)\n\t\t) {\n\t\t\tthrow Error('Heatmap only supports label scaletypes.');\n\t\t}\n\t}\n\n\t/**\n\t * Get min and maximum value of the display data\n\t * @returns Array consisting of smallest and largest values in  data\n\t */\n\tgetValueDomain() {\n\t\tconst data = this.getDisplayData().map((element) => element.value);\n\t\tconst limits = extent(data);\n\t\tconst domain = [];\n\n\t\t// Round extent values to the nearest multiple of 10\n\t\t// Axis rounds values to multiples of 2, 5, and 10s.\n\t\tlimits.forEach((number, index) => {\n\t\t\tlet value = Number(number);\n\n\t\t\tif (index === 0 && value >= 0) {\n\t\t\t\tvalue = 0;\n\t\t\t} else if (value % 10 === 0 || value === 0) {\n\t\t\t\tvalue;\n\t\t\t} else if (value < 0) {\n\t\t\t\tvalue = Math.floor(value / 10) * 10;\n\t\t\t} else {\n\t\t\t\tvalue = Math.ceil(value / 10) * 10;\n\t\t\t}\n\n\t\t\tdomain.push(value);\n\t\t});\n\n\t\t// Ensure the median of the range is 0\n\t\tif (domain[0] < 0 && domain[1] > 0) {\n\t\t\tif (Math.abs(domain[0]) > domain[1]) {\n\t\t\t\tdomain[1] = Math.abs(domain[0]);\n\t\t\t} else {\n\t\t\t\tdomain[0] = -domain[1];\n\t\t\t}\n\t\t}\n\n\t\treturn domain;\n\t}\n\n\t/**\n\t * @override\n\t * @param value\n\t * @returns\n\t */\n\tgetFillColor(value: number) {\n\t\treturn this._colorScale(value);\n\t}\n\n\t/**\n\t * Generate a list of all unique domains\n\t * @returns String[]\n\t */\n\tgetUniqueDomain(): string[] {\n\t\tif (Tools.isEmpty(this._domains)) {\n\t\t\tconst displayData = this.getDisplayData();\n\t\t\tconst { cartesianScales } = this.services;\n\n\t\t\tconst domainIdentifier = cartesianScales.getDomainIdentifier();\n\t\t\tconst mainXAxisPosition = cartesianScales.getMainXAxisPosition();\n\t\t\tconst customDomain = cartesianScales.getCustomDomainValuesByposition(\n\t\t\t\tmainXAxisPosition\n\t\t\t);\n\n\t\t\t// Use user defined domain if specified\n\t\t\tif (!!customDomain) {\n\t\t\t\treturn customDomain;\n\t\t\t}\n\n\t\t\t// Get unique axis values & create a matrix\n\t\t\tthis._domains = Array.from(\n\t\t\t\tnew Set(\n\t\t\t\t\tdisplayData.map((d) => {\n\t\t\t\t\t\treturn d[domainIdentifier];\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t\t);\n\t\t}\n\n\t\treturn this._domains;\n\t}\n\n\t/**\n\t * Generates a list of all unique ranges\n\t * @returns String[]\n\t */\n\tgetUniqueRanges(): string[] {\n\t\tif (Tools.isEmpty(this._ranges)) {\n\t\t\tconst displayData = this.getDisplayData();\n\t\t\tconst { cartesianScales } = this.services;\n\n\t\t\tconst rangeIdentifier = cartesianScales.getRangeIdentifier();\n\t\t\tconst mainYAxisPosition = cartesianScales.getMainYAxisPosition();\n\t\t\tconst customDomain = cartesianScales.getCustomDomainValuesByposition(\n\t\t\t\tmainYAxisPosition\n\t\t\t);\n\n\t\t\t// Use user defined domain if specified\n\t\t\tif (!!customDomain) {\n\t\t\t\treturn customDomain;\n\t\t\t}\n\n\t\t\t// Get unique axis values & create a matrix\n\t\t\tthis._ranges = Array.from(\n\t\t\t\tnew Set(\n\t\t\t\t\tdisplayData.map((d) => {\n\t\t\t\t\t\treturn d[rangeIdentifier];\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t\t);\n\t\t}\n\n\t\treturn this._ranges;\n\t}\n\n\t/**\n\t * Generates a matrix (If doesn't exist) and returns it\n\t * @returns Object\n\t */\n\tgetMatrix() {\n\t\tif (Tools.isEmpty(this._matrix)) {\n\t\t\tconst uniqueDomain = this.getUniqueDomain();\n\t\t\tconst uniqueRange = this.getUniqueRanges();\n\n\t\t\tconst domainIdentifier = this.services.cartesianScales.getDomainIdentifier();\n\t\t\tconst rangeIdentifier = this.services.cartesianScales.getRangeIdentifier();\n\n\t\t\t// Create a column\n\t\t\tconst range = {};\n\t\t\tuniqueRange.forEach((ran: any) => {\n\t\t\t\t// Initialize matrix to empty state\n\t\t\t\trange[ran] = {\n\t\t\t\t\tvalue: null,\n\t\t\t\t\tindex: -1,\n\t\t\t\t};\n\t\t\t});\n\n\t\t\t// Complete the matrix by cloning the column to all domains\n\t\t\tuniqueDomain.forEach((dom: any) => {\n\t\t\t\tthis._matrix[dom] = Tools.clone(range);\n\t\t\t});\n\n\t\t\t// Fill in user passed data\n\t\t\tthis.getDisplayData().forEach((d, i) => {\n\t\t\t\tthis._matrix[d[domainIdentifier]][d[rangeIdentifier]] = {\n\t\t\t\t\tvalue: d['value'],\n\t\t\t\t\tindex: i,\n\t\t\t\t};\n\t\t\t});\n\t\t}\n\n\t\treturn this._matrix;\n\t}\n\n\t/**\n\t *\n\t * @param newData The new raw data to be set\n\t */\n\tsetData(newData) {\n\t\tconst sanitizedData = this.sanitize(Tools.clone(newData));\n\t\tconst dataGroups = this.generateDataGroups(sanitizedData);\n\n\t\tthis.set({\n\t\t\tdata: sanitizedData,\n\t\t\tdataGroups,\n\t\t});\n\n\t\t// Set attributes to empty\n\t\tthis._domains = [];\n\t\tthis._ranges = [];\n\t\tthis._matrix = {};\n\n\t\treturn sanitizedData;\n\t}\n\n\t/**\n\t * Converts Object matrix into a single array\n\t * @returns Object[]\n\t */\n\tgetMatrixAsArray(): Object[] {\n\t\tif (Tools.isEmpty(this._matrix)) {\n\t\t\tthis.getMatrix();\n\t\t}\n\n\t\tconst uniqueDomain = this.getUniqueDomain();\n\t\tconst uniqueRange = this.getUniqueRanges();\n\n\t\tconst domainIdentifier = this.services.cartesianScales.getDomainIdentifier();\n\t\tconst rangeIdentifier = this.services.cartesianScales.getRangeIdentifier();\n\n\t\tconst arr = [];\n\t\tuniqueDomain.forEach((domain) => {\n\t\t\tuniqueRange.forEach((range) => {\n\t\t\t\tconst element = {\n\t\t\t\t\tvalue: this._matrix[domain][range].value,\n\t\t\t\t\tindex: this._matrix[domain][range].index,\n\t\t\t\t};\n\t\t\t\telement[domainIdentifier] = domain;\n\t\t\t\telement[rangeIdentifier] = range;\n\t\t\t\tarr.push(element);\n\t\t\t});\n\t\t});\n\n\t\treturn arr;\n\t}\n\n\t/**\n\t * Generate tabular data from display data\n\t * @returns Array<Object>\n\t */\n\tgetTabularDataArray() {\n\t\tconst displayData = this.getDisplayData();\n\n\t\tconst {\n\t\t\tprimaryDomain,\n\t\t\tprimaryRange,\n\t\t\tsecondaryDomain,\n\t\t\tsecondaryRange,\n\t\t} = this.assignRangeAndDomains();\n\n\t\tlet domainValueFormatter;\n\n\t\tconst result = [\n\t\t\t[primaryDomain.label, primaryRange.label, 'Value'],\n\t\t\t...displayData.map((datum) => [\n\t\t\t\tdatum[primaryDomain.identifier] === null\n\t\t\t\t\t? '&ndash;'\n\t\t\t\t\t: domainValueFormatter\n\t\t\t\t\t? domainValueFormatter(datum[primaryDomain.identifier])\n\t\t\t\t\t: datum[primaryDomain.identifier],\n\t\t\t\tdatum[primaryRange.identifier] === null\n\t\t\t\t\t? '&ndash;'\n\t\t\t\t\t: datum[primaryRange.identifier].toLocaleString(),\n\t\t\t\tdatum['value'],\n\t\t\t]),\n\t\t];\n\n\t\treturn result;\n\t}\n\n\t// Uses quantize scale to return class names\n\tgetColorClassName(configs: { value?: number; originalClassName?: string }) {\n\t\treturn `${configs.originalClassName} ${this._colorScale(\n\t\t\tconfigs.value as number\n\t\t)}`;\n\t}\n\n\tprotected setColorClassNames() {\n\t\tconst options = this.getOptions();\n\n\t\tconst customColors = Tools.getProperty(\n\t\t\toptions,\n\t\t\t'color',\n\t\t\t'gradient',\n\t\t\t'colors'\n\t\t);\n\t\tconst customColorsEnabled = !Tools.isEmpty(customColors);\n\n\t\tlet colorPairingOption = Tools.getProperty(\n\t\t\toptions,\n\t\t\t'color',\n\t\t\t'pairing',\n\t\t\t'option'\n\t\t);\n\n\t\t// If domain consists of negative and positive values, use diverging palettes\n\t\tconst domain = this.getValueDomain();\n\t\tconst colorScheme = domain[0] < 0 && domain[1] > 0 ? 'diverge' : 'mono';\n\n\t\t// Use default color pairing options if not in defined range\n\t\tif (\n\t\t\tcolorPairingOption < 1 &&\n\t\t\tcolorPairingOption > 4 &&\n\t\t\tcolorScheme === 'mono'\n\t\t) {\n\t\t\tcolorPairingOption = 1;\n\t\t} else if (\n\t\t\tcolorPairingOption < 1 &&\n\t\t\tcolorPairingOption > 2 &&\n\t\t\tcolorScheme === 'diverge'\n\t\t) {\n\t\t\tcolorPairingOption = 1;\n\t\t}\n\n\t\t// Uses css classes for fill\n\t\tconst colorPairing = customColorsEnabled ? customColors : [];\n\n\t\tif (!customColorsEnabled) {\n\t\t\t// Add class names to list and the amount based on the color scheme\n\t\t\t// Carbon charts has 11 colors for a single monochromatic palette & 17 for a divergent palette\n\t\t\tconst colorGroupingLength = colorScheme === 'diverge' ? 17 : 11;\n\t\t\tfor (let i = 1; i < colorGroupingLength + 1; i++) {\n\t\t\t\tcolorPairing.push(\n\t\t\t\t\t`fill-${colorScheme}-${colorPairingOption}-${i}`\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\t// Save scale type\n\t\tthis._colorScale = scaleQuantize()\n\t\t\t.domain(this.getValueDomain() as [number, number])\n\t\t\t.range(colorPairing);\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carbon/charts",
-  "version": "0.53.2",
+  "version": "0.54.0",
   "description": "Carbon charting components",
   "main": "./bundle.js",
   "module": "./index.js",

package/services/scales-cartesian.d.ts

@@ -37,6 +37,7 @@ export declare class CartesianScales extends Service {
     determineOrientation(): void;
     isDualAxes(): Boolean;
     determineAxisDuality(): void;
+    getCustomDomainValuesByposition(axisPosition: AxisPositions): any;
     getOrientation(): CartesianOrientations;
     getScaleByPosition(axisPosition: AxisPositions): any;
     getScaleTypeByPosition(axisPosition: AxisPositions): any;

package/services/scales-cartesian.js

@@ -181,6 +181,22 @@ var CartesianScales = /** @class */ (function (_super) {
             this.dualAxes = true;
         }
     };
+    CartesianScales.prototype.getCustomDomainValuesByposition = function (axisPosition) {
+        var domain = Tools.getProperty(this.model.getOptions(), 'axes', axisPosition, 'domain');
+        // Check if domain is an array
+        if (domain && !Array.isArray(domain)) {
+            throw new Error("Domain in " + axisPosition + " axis is not a valid array");
+        }
+        // Determine number of elements passed in domain depending on scale types
+        if (Array.isArray(domain)) {
+            if ((this.scaleTypes[axisPosition] === ScaleTypes.LINEAR ||
+                this.scaleTypes[axisPosition] === ScaleTypes.TIME) &&
+                domain.length !== 2) {
+                throw new Error("There can only be 2 elements in domain for scale type: " + this.scaleTypes[axisPosition]);
+            }
+        }
+        return domain;
+    };
     CartesianScales.prototype.getOrientation = function () {
         return this.orientation;
     };