@carbon/charts 1.8.0 → 1.9.0-rc.0

package/interfaces/components.d.ts

@@ -1,231 +0,0 @@
-import { LayoutGrowth, LegendPositions, Alignments, ToolbarControlTypes, ZoomBarTypes } from './enums';
-import { Component } from '../components/component';
-import { TruncationOptions } from './truncation';
-/**
- * customize the overlay contents
- */
-export interface LayoutComponentChild {
-    id: string;
-    /**
-     * the component that'll be rendered inside layout child
-     */
-    components: Component[];
-    /**
-     * size of the layout child
-     */
-    size?: number;
-    /**
-     * how the layout child will grow or shrink
-     */
-    growth: LayoutGrowth;
-}
-/**
- * customize the legend component
- */
-export interface LegendOptions {
-    enabled?: boolean;
-    position?: LegendPositions;
-    /**
-     * the clickability of legend items
-     */
-    clickable?: boolean;
-    truncation?: TruncationOptions;
-    alignment?: Alignments;
-    order?: string[];
-    /**
-     * customized legend items
-     */
-    additionalItems?: LegendItem[];
-}
-/**
- * customize the legend item
- */
-export interface LegendItem {
-    type: string;
-    name: string;
-    fill?: string;
-    stroke?: string;
-}
-export interface TooltipOptions {
-    /**
-     * enable or disable tooltip
-     */
-    enabled?: boolean;
-    /**
-     * a function to format the tooltip values
-     */
-    valueFormatter?: Function;
-    /**
-     * custom function for returning tooltip HTML
-     * passed an array or object with the data, and then the default tooltip markup
-     */
-    customHTML?: Function;
-    /**
-     * customizes the `Group` label shown inside tooltips
-     */
-    groupLabel?: string;
-    /**
-     * show total of items
-     */
-    showTotal?: boolean;
-    /**
-     * customizes the `Total` label shown inside tooltips
-     */
-    totalLabel?: string;
-    truncation?: TruncationOptions;
-}
-/**
- * Threshold options
- */
-export interface ThresholdOptions {
-    /**
-     * threshold value
-     */
-    value: number | Date;
-    /**
-     * a function to format the threshold values
-     */
-    valueFormatter?: Function;
-    /**
-     * hex threshold line color
-     */
-    fillColor: string;
-    /**
-     * threshold label
-     */
-    label: string;
-}
-export interface GridOptions {
-    y?: {
-        enabled?: boolean;
-        numberOfTicks?: number;
-        alignWithAxisTicks?: boolean;
-    };
-    x?: {
-        enabled?: boolean;
-        numberOfTicks?: number;
-        alignWithAxisTicks?: boolean;
-    };
-}
-/**
- * Ruler options
- */
-export interface RulerOptions {
-    enabled?: boolean;
-}
-export interface BarOptions {
-    width?: number;
-    maxWidth?: number;
-    spacingFactor?: number;
-}
-export interface StackedBarOptions extends BarOptions {
-    dividerSize?: number;
-}
-/**
- * customize the Toolbar component
- */
-export interface ToolbarOptions {
-    /**
-     * is the toolbar visible or not
-     */
-    enabled?: boolean;
-    /**
-     * the maximum toolbar controls to be displayed as icons
-     * controls more than this number will appear in the overflow menu
-     * minimum is 1. (all toolbar controls are in overflow menu)
-     */
-    numberOfIcons?: number;
-    /**
-     * toolbar controls which will be displayed following the array order
-     */
-    controls?: ToolbarControl[];
-}
-/**
- * options for each toolbar control
- */
-export interface ToolbarControl {
-    /**
-     * the toolbar control type
-     */
-    type: ToolbarControlTypes;
-    /**
-     * used as aria-label for toolbar control
-     */
-    title?: string;
-    /**
-     * the text to display (if this control is displayed in overflow menu)
-     * type value will be displayed if text is not available
-     */
-    text?: string;
-    /**
-     * custom id for button
-     */
-    id?: String;
-    /**
-     * SVG HTML element
-     */
-    iconSVG?: {
-        content?: string;
-        height?: string;
-        width?: string;
-    };
-    shouldBeDisabled?: Function;
-    /**
-     * function to execute on button click
-     * alternatively, users can choose to not pass in a function and can
-     * listen for events to execute asynchronously
-     */
-    clickFunction?: Function;
-}
-/**
- * customize the ZoomBars in a chart
- */
-export interface ZoomBarsOptions {
-    /**
-     * a variable to handle default zoom in ratio (0 ~ 1.0)
-     * ex: shift click zoom in ratio
-     */
-    zoomRatio?: number;
-    /**
-     * a variable to define the minimum zoom ratio (0 ~ 1.0)
-     * If  ( zoom domain / max domain ) < minZoomRatio, zoom-in functions will be disabled
-     */
-    minZoomRatio?: number;
-    /**
-     * currently only the top position is supported
-     */
-    top?: ZoomBarOptions;
-    /**
-     * whether keep updating range axis in real time while zoom domain is changing
-     */
-    updateRangeAxis?: boolean;
-}
-/**
- * customize the ZoomBar component
- */
-export interface ZoomBarOptions {
-    /**
-     * is the zoom-bar visible or not
-     */
-    enabled?: boolean;
-    /**
-     * is the zoom-bar in loading state
-     */
-    loading?: boolean;
-    /**
-     * is the zoom-bar in locked state
-     */
-    locked?: boolean;
-    /**
-     * whether the zoom bar is showing a slider view or a graph view etc.
-     */
-    type?: ZoomBarTypes;
-    /**
-     * an two element array which represents the initial zoom domain
-     */
-    initialZoomDomain?: Object[];
-    /**
-     * options related to zoom bar data
-     */
-    data?: Object[];
-}

package/interfaces/components.js

@@ -1 +0,0 @@
-//# sourceMappingURL=../../src/interfaces/components.js.map

package/interfaces/components.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"components.js","sourceRoot":"","sources":["components.ts"],"names":[],"mappings":"","sourcesContent":["import {\n\tLayoutGrowth,\n\tLegendPositions,\n\tAlignments,\n\tToolbarControlTypes,\n\tZoomBarTypes,\n} from './enums';\nimport { Component } from '../components/component';\nimport { TruncationOptions } from './truncation';\n\n/**\n * customize the overlay contents\n */\nexport interface LayoutComponentChild {\n\tid: string;\n\t/**\n\t * the component that'll be rendered inside layout child\n\t */\n\tcomponents: Component[];\n\t/**\n\t * size of the layout child\n\t */\n\tsize?: number;\n\t/**\n\t * how the layout child will grow or shrink\n\t */\n\tgrowth: LayoutGrowth;\n}\n\n/**\n * customize the legend component\n */\nexport interface LegendOptions {\n\tenabled?: boolean;\n\tposition?: LegendPositions;\n\t/**\n\t * the clickability of legend items\n\t */\n\tclickable?: boolean;\n\ttruncation?: TruncationOptions;\n\talignment?: Alignments;\n\torder?: string[];\n\t/**\n\t * customized legend items\n\t */\n\tadditionalItems?: LegendItem[];\n}\n\n/**\n * customize the legend item\n */\nexport interface LegendItem {\n\ttype: string;\n\tname: string;\n\tfill?: string;\n\tstroke?: string;\n}\n\nexport interface TooltipOptions {\n\t/**\n\t * enable or disable tooltip\n\t */\n\tenabled?: boolean;\n\t/**\n\t * a function to format the tooltip values\n\t */\n\tvalueFormatter?: Function;\n\t/**\n\t * custom function for returning tooltip HTML\n\t * passed an array or object with the data, and then the default tooltip markup\n\t */\n\tcustomHTML?: Function;\n\t/**\n\t * customizes the `Group` label shown inside tooltips\n\t */\n\tgroupLabel?: string;\n\t/**\n\t * show total of items\n\t */\n\tshowTotal?: boolean;\n\t/**\n\t * customizes the `Total` label shown inside tooltips\n\t */\n\ttotalLabel?: string;\n\ttruncation?: TruncationOptions;\n}\n\n/**\n * Threshold options\n */\nexport interface ThresholdOptions {\n\t/**\n\t * threshold value\n\t */\n\tvalue: number | Date;\n\t/**\n\t * a function to format the threshold values\n\t */\n\tvalueFormatter?: Function;\n\t/**\n\t * hex threshold line color\n\t */\n\tfillColor: string;\n\t/**\n\t * threshold label\n\t */\n\tlabel: string;\n}\n\nexport interface GridOptions {\n\ty?: {\n\t\tenabled?: boolean;\n\t\tnumberOfTicks?: number;\n\t\talignWithAxisTicks?: boolean;\n\t};\n\tx?: {\n\t\tenabled?: boolean;\n\t\tnumberOfTicks?: number;\n\t\talignWithAxisTicks?: boolean;\n\t};\n}\n\n/**\n * Ruler options\n */\nexport interface RulerOptions {\n\tenabled?: boolean;\n}\n\nexport interface BarOptions {\n\twidth?: number;\n\tmaxWidth?: number;\n\t/*\n\t * can be used to manually modify spacing between bars\n\t * @default 0.25\n\t */\n\tspacingFactor?: number;\n}\n\nexport interface StackedBarOptions extends BarOptions {\n\tdividerSize?: number;\n}\n\n/**\n * customize the Toolbar component\n */\nexport interface ToolbarOptions {\n\t/**\n\t * is the toolbar visible or not\n\t */\n\tenabled?: boolean;\n\t/**\n\t * the maximum toolbar controls to be displayed as icons\n\t * controls more than this number will appear in the overflow menu\n\t * minimum is 1. (all toolbar controls are in overflow menu)\n\t */\n\tnumberOfIcons?: number;\n\t/**\n\t * toolbar controls which will be displayed following the array order\n\t */\n\tcontrols?: ToolbarControl[];\n}\n\n/**\n * options for each toolbar control\n */\nexport interface ToolbarControl {\n\t/**\n\t * the toolbar control type\n\t */\n\ttype: ToolbarControlTypes;\n\t/**\n\t * used as aria-label for toolbar control\n\t */\n\ttitle?: string;\n\t/**\n\t * the text to display (if this control is displayed in overflow menu)\n\t * type value will be displayed if text is not available\n\t */\n\ttext?: string;\n\t/**\n\t * custom id for button\n\t */\n\tid?: String;\n\t/**\n\t * SVG HTML element\n\t */\n\ticonSVG?: {\n\t\tcontent?: string;\n\t\theight?: string;\n\t\twidth?: string;\n\t};\n\tshouldBeDisabled?: Function;\n\t/**\n\t * function to execute on button click\n\t * alternatively, users can choose to not pass in a function and can\n\t * listen for events to execute asynchronously\n\t */\n\tclickFunction?: Function;\n}\n\n/**\n * customize the ZoomBars in a chart\n */\nexport interface ZoomBarsOptions {\n\t/**\n\t * a variable to handle default zoom in ratio (0 ~ 1.0)\n\t * ex: shift click zoom in ratio\n\t */\n\tzoomRatio?: number;\n\t/**\n\t * a variable to define the minimum zoom ratio (0 ~ 1.0)\n\t * If  ( zoom domain / max domain ) < minZoomRatio, zoom-in functions will be disabled\n\t */\n\tminZoomRatio?: number;\n\t/**\n\t * currently only the top position is supported\n\t */\n\ttop?: ZoomBarOptions;\n\t/**\n\t * whether keep updating range axis in real time while zoom domain is changing\n\t */\n\tupdateRangeAxis?: boolean;\n}\n\n/**\n * customize the ZoomBar component\n */\nexport interface ZoomBarOptions {\n\t/**\n\t * is the zoom-bar visible or not\n\t */\n\tenabled?: boolean;\n\t/**\n\t * is the zoom-bar in loading state\n\t */\n\tloading?: boolean;\n\t/**\n\t * is the zoom-bar in locked state\n\t */\n\tlocked?: boolean;\n\t/**\n\t * whether the zoom bar is showing a slider view or a graph view etc.\n\t */\n\ttype?: ZoomBarTypes;\n\t/**\n\t * an two element array which represents the initial zoom domain\n\t */\n\tinitialZoomDomain?: Object[];\n\t/**\n\t * options related to zoom bar data\n\t */\n\tdata?: Object[];\n}\n"]}

package/interfaces/enums.d.ts

@@ -1,261 +0,0 @@
-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 {
-    WHITE = "white",
-    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"
-}
-/**
- * enum of supported projection types
- */
-export declare enum Projection {
-    geoEqualEarth = "geoEqualEarth",
-    geoAlbers = "geoAlbers",
-    geoConicEqualArea = "geoConicEqualArea",
-    geoConicEquidistant = "geoConicEquidistant",
-    geoEquirectangular = "geoEquirectangular",
-    geoMercator = "geoMercator",
-    geoNaturalEarth1 = "geoNaturalEarth1"
-}