@carbon/charts 0.59.0-beta.0 → 1.0.3

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

@@ -0,0 +1,249 @@
+import * as EventEnums from './events';
+export declare const Events: typeof EventEnums;
+export declare enum RenderTypes {
+    HTML = "html",
+    SVG = "svg"
+}
+/**
+ * enum of all supported chart themes
+ */
+export declare enum ChartTheme {
+    DEFAULT = "default",
+    G100 = "g100",
+    G90 = "g90",
+    G10 = "g10"
+}
+/**
+ * enum of all color classname types
+ */
+export declare enum ColorClassNameTypes {
+    BACKGROUND = "background",
+    FILL = "fill",
+    STROKE = "stroke",
+    TOOLTIP = "tooltip"
+}
+/**
+ * enum of all possible axis positions
+ */
+export declare enum AxisPositions {
+    LEFT = "left",
+    RIGHT = "right",
+    TOP = "top",
+    BOTTOM = "bottom"
+}
+/**
+ * enum of all possible axis positions
+ */
+export declare enum ZoomBarTypes {
+    GRAPH_VIEW = "graph_view",
+    SLIDER_VIEW = "slider_view"
+}
+/**
+ * enum of all possible truncation types
+ */
+export declare enum TruncationTypes {
+    END_LINE = "end_line",
+    MID_LINE = "mid_line",
+    FRONT_LINE = "front_line",
+    NONE = "none"
+}
+/**
+ * enum of all possible cartesian orientations
+ * to be used for determining the orientation
+ * of graphs being draw over
+ * cartesian scales
+ */
+export declare enum CartesianOrientations {
+    VERTICAL = "vertical",
+    HORIZONTAL = "horizontal"
+}
+/**
+ * enum of all possible scale types
+ */
+export declare enum ScaleTypes {
+    TIME = "time",
+    LINEAR = "linear",
+    LOG = "log",
+    LABELS = "labels",
+    LABELS_RATIO = "labels-ratio"
+}
+/**
+ * enum of all possible legend positions
+ */
+export declare enum LegendPositions {
+    RIGHT = "right",
+    LEFT = "left",
+    TOP = "top",
+    BOTTOM = "bottom"
+}
+/**
+ * enum of all possible alignments
+ */
+export declare enum Alignments {
+    LEFT = "left",
+    CENTER = "center",
+    RIGHT = "right"
+}
+/**
+ * enum of all possible legend orientations
+ */
+export declare enum LegendOrientations {
+    HORIZONTAL = "horizontal",
+    VERTICAL = "vertical"
+}
+/**
+ * enum of tree types for the tree chart
+ */
+export declare enum TreeTypes {
+    TREE = "tree",
+    DENDROGRAM = "dendrogram"
+}
+/**
+ * enum of all possible layout directions
+ */
+export declare enum LayoutDirection {
+    ROW = "row",
+    COLUMN = "column",
+    ROW_REVERSE = "row-reverse",
+    COLUMN_REVERSE = "column-reverse"
+}
+/**
+ * enum of all possible layout growth values
+ */
+export declare enum LayoutGrowth {
+    FIXED = "fixed",
+    PREFERRED = "preferred",
+    STRETCH = "stretch"
+}
+/**
+ * enum of all possible layout align-items values
+ */
+export declare enum LayoutAlignItems {
+    CENTER = "center"
+}
+/**
+ * enum of all possible callout directions
+ */
+export declare enum CalloutDirections {
+    LEFT = "left",
+    RIGHT = "right"
+}
+/**
+ * enum of all possible skeleton/empty state types
+ */
+export declare enum Skeletons {
+    GRID = "grid",
+    VERT_OR_HORIZ = "vertOrHoriz",
+    PIE = "pie",
+    DONUT = "donut"
+}
+/**
+ * enum of all possible attributes used to aling text horizontally
+ */
+export declare enum TextAnchor {
+    START = "start",
+    MIDDLE = "middle",
+    END = "end"
+}
+/**
+ * enum of all possible attributes used to aling text vertically
+ */
+export declare enum DominantBaseline {
+    BASELINE = "baseline",
+    MIDDLE = "middle",
+    HANGING = "hanging"
+}
+export declare enum GaugeTypes {
+    SEMI = "semi",
+    FULL = "full"
+}
+/**
+ * enum of all possible callout directions
+ */
+export declare enum ArrowDirections {
+    UP = "up",
+    DOWN = "down"
+}
+/**
+ * enum of carbon statuses
+ */
+export declare enum Statuses {
+    SUCCESS = "success",
+    WARNING = "warning",
+    DANGER = "danger"
+}
+/**
+ * enum of axis ticks rotation
+ */
+export declare enum TickRotations {
+    ALWAYS = "always",
+    AUTO = "auto",
+    NEVER = "never"
+}
+/**
+ * enum of chartTypes that work with combo chart
+ */
+export declare enum ChartTypes {
+    SCATTER = "scatter",
+    LINE = "line",
+    SIMPLE_BAR = "simple-bar",
+    STACKED_BAR = "stacked-bar",
+    GROUPED_BAR = "grouped-bar",
+    AREA = "area",
+    STACKED_AREA = "stacked-area"
+}
+/**
+ * enum of supported toolbar control types
+ */
+export declare enum ToolbarControlTypes {
+    EXPORT_CSV = "Export as CSV",
+    EXPORT_PNG = "Export as PNG",
+    EXPORT_JPG = "Export as JPG",
+    ZOOM_IN = "Zoom in",
+    ZOOM_OUT = "Zoom out",
+    RESET_ZOOM = "Reset zoom",
+    MAKE_FULLSCREEN = "Make fullscreen",
+    SHOW_AS_DATATABLE = "Show as data-table",
+    CUSTOM = "Custom"
+}
+/**
+ * enum of title orientations for _vertical axes_
+ */
+export declare enum AxisTitleOrientations {
+    LEFT = "left",
+    RIGHT = "right"
+}
+/**
+ * enum of legend item type
+ */
+export declare enum LegendItemType {
+    CHECKBOX = "checkbox",
+    RADIUS = "radius",
+    AREA = "area",
+    SIZE = "size",
+    LINE = "line",
+    QUARTILE = "quartile",
+    ZOOM = "zoom"
+}
+/**
+ * enum of color legend types
+ */
+export declare enum ColorLegendType {
+    LINEAR = "linear",
+    QUANTIZE = "quantize"
+}
+/**
+ * enum of divider status for heatmap
+ */
+export declare enum DividerStatus {
+    ON = "on",
+    AUTO = "auto",
+    OFF = "off"
+}
+/**
+ * enum of axis flavor
+ */
+export declare enum AxisFlavor {
+    DEFAULT = "default",
+    HOVERABLE = "hoverable"
+}

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

@@ -0,0 +1,230 @@
+/**
+ * enum of all events related to the chart on the DOM
+ */
+export declare enum Chart {
+    RENDER_FINISHED = "render-finished",
+    RESIZE = "chart-resize",
+    MOUSEOVER = "chart-mouseover",
+    MOUSEOUT = "chart-mouseout"
+}
+/**
+ * enum of all events related to the overlay modal
+ */
+export declare enum Modal {
+    SHOW = "show-modal",
+    HIDE = "hide-modal"
+}
+/**
+ * enum of all events related to the chart model
+ */
+export declare enum Model {
+    UPDATE = "model-update"
+}
+/**
+ * enum of all toolbar events
+ */
+export declare enum Toolbar {
+    SHOW_OVERFLOW_MENU = "show-toolbar-overflow-menu",
+    HIDE_OVERFLOW_MENU = "hide-toolbar-overflow-menu",
+    BUTTON_CLICK = "toolbar-button-click"
+}
+/**
+ * enum of all events related to the zoom-bar
+ */
+export declare enum ZoomBar {
+    UPDATE = "zoom-bar-update",
+    SELECTION_START = "zoom-bar-selection-start",
+    SELECTION_IN_PROGRESS = "zoom-bar-selection-in-progress",
+    SELECTION_END = "zoom-bar-selection-end"
+}
+/**
+ * enum of all events related to the zoom domain
+ */
+export declare enum ZoomDomain {
+    CHANGE = "zoom-domain-change"
+}
+/** enum of all events related to canvas zoom *
+ *
+ */
+export declare enum CanvasZoom {
+    CANVAS_ZOOM_IN = "canvas-zoom-in",
+    CANVAS_ZOOM_OUT = "canvas-zoom-out"
+}
+/**
+ * enum of all axis-related events
+ */
+export declare enum Axis {
+    LABEL_MOUSEOVER = "axis-label-mouseover",
+    LABEL_MOUSEMOVE = "axis-label-mousemove",
+    LABEL_CLICK = "axis-label-click",
+    LABEL_MOUSEOUT = "axis-label-mouseout",
+    LABEL_FOCUS = "axis-label-focus",
+    LABEL_BLUR = "axis-label-blur",
+    RENDER_COMPLETE = "axis-render-complete"
+}
+/**
+ * enum of all area graph events
+ */
+export declare enum Area {
+    POINT_MOUSEOVER = "scatter-mouseover",
+    POINT_MOUSEMOVE = "scatter-mousemove",
+    POINT_CLICK = "scatter-click",
+    POINT_MOUSEOUT = "scatter-mouseout"
+}
+/**
+ * enum of all wordcloud graph events
+ */
+export declare enum WordCloud {
+    WORD_MOUSEOVER = "wordcloud-word-mouseover",
+    WORD_MOUSEMOVE = "wordcloud-word-mousemove",
+    WORD_CLICK = "wordcloud-word-click",
+    WORD_MOUSEOUT = "wordcloud-word-mouseout"
+}
+/**
+ * enum of all pie graph events
+ */
+export declare enum Pie {
+    SLICE_MOUSEOVER = "pie-slice-mouseover",
+    SLICE_MOUSEMOVE = "pie-slice-mousemove",
+    SLICE_CLICK = "pie-slice-click",
+    SLICE_MOUSEOUT = "pie-slice-mouseout"
+}
+/**
+ * enum of all gauge graph events
+ */
+export declare enum Gauge {
+    ARC_MOUSEOVER = "gauge-arc-mouseover",
+    ARC_MOUSEMOVE = "gauge-arc-mousemove",
+    ARC_CLICK = "gauge-arc-click",
+    ARC_MOUSEOUT = "gauge-arc-mouseout"
+}
+/**
+ * enum of all bar graph events
+ */
+export declare enum Bar {
+    BAR_MOUSEOVER = "bar-mouseover",
+    BAR_MOUSEMOVE = "bar-mousemove",
+    BAR_CLICK = "bar-click",
+    BAR_MOUSEOUT = "bar-mouseout"
+}
+/**
+ * enum of all boxplot graph events
+ */
+export declare enum Boxplot {
+    BOX_MOUSEOVER = "box-mouseover",
+    BOX_MOUSEMOVE = "box-mousemove",
+    BOX_CLICK = "box-click",
+    BOX_MOUSEOUT = "box-mouseout",
+    OUTLIER_MOUSEOVER = "outlier-mouseover",
+    OUTLIER_MOUSEMOVE = "outlier-mousemove",
+    OUTLIER_CLICK = "outlier-click",
+    OUTLIER_MOUSEOUT = "outlier-mouseout"
+}
+/**
+ * enum of all scatter graph events
+ */
+export declare enum Scatter {
+    SCATTER_MOUSEOVER = "scatter-mouseover",
+    SCATTER_MOUSEMOVE = "scatter-mousemove",
+    SCATTER_CLICK = "scatter-click",
+    SCATTER_MOUSEOUT = "scatter-mouseout"
+}
+/**
+ * enum of all line graph events
+ */
+export declare enum Line {
+    POINT_MOUSEOVER = "scatter-mouseover",
+    POINT_MOUSEMOVE = "scatter-mousemove",
+    POINT_CLICK = "scatter-click",
+    POINT_MOUSEOUT = "scatter-mouseout"
+}
+/**
+ * enum of all radar graph events
+ */
+export declare enum Radar {
+    X_AXIS_MOUSEOVER = "radar-x-axis-mouseover",
+    X_AXIS_MOUSEMOVE = "radar-x-axis-mousemove",
+    X_AXIS_CLICK = "radar-x-axis-click",
+    X_AXIS_MOUSEOUT = "radar-x-axis-mouseout"
+}
+/**
+ * enum of all tree graph events
+ */
+export declare enum Tree {
+    NODE_MOUSEOVER = "tree-node-mouseover",
+    NODE_CLICK = "tree-node-click",
+    NODE_MOUSEOUT = "tree-node-mouseout"
+}
+/**
+ * enum of all treemap graph events
+ */
+export declare enum Treemap {
+    LEAF_MOUSEOVER = "leaf-mouseover",
+    LEAF_MOUSEMOVE = "leaf-mousemove",
+    LEAF_CLICK = "leaf-click",
+    LEAF_MOUSEOUT = "leaf-mouseout"
+}
+/**
+ * enum of all tooltip events
+ */
+export declare enum Tooltip {
+    SHOW = "show-tooltip",
+    MOVE = "move-tooltip",
+    HIDE = "hide-tooltip"
+}
+/**
+ * enum of all threshold events
+ */
+export declare enum Threshold {
+    SHOW = "show-threshold",
+    HIDE = "hide-threshold"
+}
+/**
+ * enum of all legend related events
+ */
+export declare enum Legend {
+    ITEM_HOVER = "legend-item-onhover",
+    ITEM_CLICK = "legend-item-onclick",
+    ITEM_MOUSEOUT = "legend-item-onmouseout",
+    ITEMS_UPDATE = "legend-items-update"
+}
+/**
+ * enum of all circlepack related events
+ */
+export declare enum CirclePack {
+    CIRCLE_MOUSEOVER = "circle-leaf-mouseover",
+    CIRCLE_CLICK = "circle-leaf-click",
+    CIRCLE_MOUSEOUT = "circle-leaf-mouseout",
+    CIRCLE_MOUSEMOVE = "circle-leaf-mousemove"
+}
+/**
+ * enum of all alluvial related events
+ */
+export declare enum Alluvial {
+    NODE_MOUSEOVER = "alluvial-node-mouseover",
+    NODE_CLICK = "alluvial-node-click",
+    NODE_MOUSEOUT = "alluvial-node-mouseout",
+    NODE_MOUSEMOVE = "alluvial-node-mousemove",
+    LINE_MOUSEOVER = "alluvial-line-mouseover",
+    LINE_CLICK = "alluvial-line-click",
+    LINE_MOUSEOUT = "alluvial-line-mouseout",
+    LINE_MOUSEMOVE = "alluvial-line-mousemove"
+}
+/**
+ * enum of all meter related events
+ */
+export declare enum Meter {
+    METER_MOUSEOVER = "meter-mouseover",
+    METER_CLICK = "meter-click",
+    METER_MOUSEOUT = "meter-mouseout",
+    METER_MOUSEMOVE = "meter-mousemove"
+}
+/**
+ * enum of all heatmap related events
+ */
+export declare enum Heatmap {
+    HEATMAP_MOUSEOVER = "heatmap-mouseover",
+    HEATMAP_CLICK = "heatmap-click",
+    HEATMAP_MOUSEOUT = "heatmap-mouseout",
+    HEATMAP_MOUSEMOVE = "hetmap-mousemove"
+}

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

@@ -0,0 +1,15 @@
+import { LayoutAlignItems, LayoutDirection, RenderTypes } from './enums';
+export interface LayoutConfigs {
+    /**
+     * Direction/orientation of the layout
+     */
+    direction?: LayoutDirection;
+    /**
+     * Whether to render through SVG or HTML
+     */
+    renderType?: RenderTypes;
+    /**
+     * how the layout will align its children
+     */
+    alignItems?: LayoutAlignItems;
+}

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

@@ -0,0 +1,35 @@
+import { AxisChartOptions } from './charts';
+export declare type ChartTabularData = Record<string, any>[];
+/**
+ * Configuration passed to the chart.
+ *
+ * Includes options and data
+ */
+export interface ChartConfig<T extends AxisChartOptions> {
+    options: T;
+    data: ChartTabularData;
+}
+export interface DataSet {
+    /**
+     * Label for the dataset
+     */
+    label: string;
+    /**
+     * Array of hex background colors
+     */
+    fillColors: string[];
+    /**
+     * Array of data values
+     */
+    data: any[];
+}
+export interface ChartData {
+    /**
+     * Labels for the x (horizontal) axis. Should match the number of items in each dataset data array
+     */
+    labels: string[];
+    /**
+     * Array of datasets to display in the chart
+     */
+    datasets: DataSet[];
+}

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

@@ -0,0 +1,17 @@
+export interface TruncationOptions {
+    /**
+     * truncation configuration
+     */
+    /**
+     * truncation type
+     */
+    type?: string;
+    /**
+     * truncation threshold
+     */
+    threshold?: Number;
+    /**
+     * how many characters to be shown
+     */
+    numCharacter?: Number;
+}

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

@@ -0,0 +1,8 @@
+import { ChartModelCartesian } from './cartesian-charts';
+/**
+ * Alluvial chart model layer
+ */
+export declare class AlluvialChartModel extends ChartModelCartesian {
+    constructor(services: any);
+    getTabularDataArray(): any[];
+}

package/build/src/model/binned-charts.d.ts

@@ -0,0 +1,7 @@
+import { ChartModelCartesian } from './cartesian-charts';
+/**
+ * this is intended for binned type of charts
+ * */
+export declare class ChartModelBinned extends ChartModelCartesian {
+    getTabularDataArray(): any[];
+}

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

@@ -0,0 +1,14 @@
+import { ChartModelCartesian } from './cartesian-charts';
+/** The charting model layer which includes mainly the chart data and options,
+ * as well as some misc. information to be shared among components */
+export declare class BoxplotChartModel extends ChartModelCartesian {
+    constructor(services: any);
+    getBoxQuartiles(d: any): {
+        q_25: number;
+        q_50: number;
+        q_75: number;
+    };
+    getBoxplotData(): any[];
+    getTabularDataArray(): any[][];
+    protected setColorClassNames(): void;
+}

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

@@ -0,0 +1,14 @@
+import { ChartModelCartesian } from './cartesian-charts';
+/**
+ * Bullet chart model layer
+ */
+export declare class BulletChartModel extends ChartModelCartesian {
+    constructor(services: any);
+    /**
+     * Determines the index of the performance area titles to use
+     * @param datum
+     * @returns number
+     */
+    getMatchingRangeIndexForDatapoint(datum: any): any;
+    getTabularDataArray(): any[];
+}

package/build/src/model/cartesian-charts.d.ts

@@ -0,0 +1,24 @@
+import { ChartModel } from './model';
+import { AxisFlavor } from '../interfaces';
+/**
+ * This supports adding X and Y Cartesian[2D] zoom data to a ChartModel
+ * */
+export declare class ChartModelCartesian extends ChartModel {
+    protected axisFlavor: AxisFlavor;
+    constructor(services: any);
+    protected assignRangeAndDomains(): {
+        primaryDomain: any;
+        primaryRange: any;
+        secondaryDomain: any;
+        secondaryRange: any;
+    };
+    getTabularDataArray(): any[];
+    setData(newData: any): any;
+    /**
+     * @param zoomBarData any special zoom bar data to use instead of the model data
+     */
+    setZoomBarData(newZoomBarData?: any): void;
+    getZoomBarData(): any;
+    protected sanitizeDateValues(data: any): any;
+    protected sanitize(data: any): any;
+}

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

@@ -0,0 +1,36 @@
+import { ChartModel } from './model';
+import { LegendItemType } from '../interfaces/enums';
+/** The charting model layer which includes mainly the chart data and options,
+ * as well as some misc. information to be shared among components */
+export declare class CirclePackChartModel extends ChartModel {
+    parentNode: boolean;
+    constructor(services: any);
+    setData(newData: any): void;
+    setOptions(newOptions: any): void;
+    getZoomOptions(options?: any): {
+        legend?: undefined;
+    } | {
+        legend: {
+            additionalItems: {
+                type: LegendItemType;
+                name: string;
+            }[];
+        };
+    };
+    setZoom(options?: any): void;
+    updateHierarchyLevel(depth: number): void;
+    getHierarchyLevel(): any;
+    hasParentNode(): boolean;
+    setDataGroups(): void;
+    protected setChildrenDataGroup(node: any, name: any): any;
+    getTabularDataArray(): string[][];
+    /**
+     * Recursively determine the relationship between all the nested elements in the child
+     * @param children: Object
+     * @param parent: String
+     * @param result: Array<Object>
+     * @param totalSum: number
+     * @returns: number
+     */
+    private getChildrenDatums;
+}

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

@@ -0,0 +1,9 @@
+import { ChartModel } from './model';
+/**
+ * The gauge chart model layer
+ */
+export declare class GaugeChartModel extends ChartModel {
+    constructor(services: any);
+    getDataGroups(): any;
+    getTabularDataArray(): any[];
+}