@carbon/charts 0.59.0-beta.0 → 1.0.3

package/src/interfaces/components.ts

@@ -1,251 +0,0 @@
-import {
-	LayoutGrowth,
-	LegendPositions,
-	Alignments,
-	ToolbarControlTypes,
-	ZoomBarTypes,
-	ColorLegendType,
-} 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;
-	/*
-	 * can be used to manually modify spacing between bars
-	 * @default 0.25
-	 */
-	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;
-	/**
-	 * 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/src/interfaces/enums.ts

@@ -1,279 +0,0 @@
-import * as EventEnums from './events';
-export const Events = EventEnums;
-
-export enum RenderTypes {
-	HTML = 'html',
-	SVG = 'svg',
-}
-
-/**
- * enum of all supported chart themes
- */
-export enum ChartTheme {
-	DEFAULT = 'default',
-	G100 = 'g100',
-	G90 = 'g90',
-	G10 = 'g10',
-}
-
-/**
- * enum of all color classname types
- */
-export enum ColorClassNameTypes {
-	BACKGROUND = 'background',
-	FILL = 'fill',
-	STROKE = 'stroke',
-	TOOLTIP = 'tooltip',
-}
-
-/**
- * enum of all possible axis positions
- */
-export enum AxisPositions {
-	LEFT = 'left',
-	RIGHT = 'right',
-	TOP = 'top',
-	BOTTOM = 'bottom',
-}
-
-/**
- * enum of all possible axis positions
- */
-export enum ZoomBarTypes {
-	GRAPH_VIEW = 'graph_view',
-	SLIDER_VIEW = 'slider_view',
-}
-
-/**
- * enum of all possible truncation types
- */
-export 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 enum CartesianOrientations {
-	VERTICAL = 'vertical',
-	HORIZONTAL = 'horizontal',
-}
-
-/**
- * enum of all possible scale types
- */
-export enum ScaleTypes {
-	TIME = 'time',
-	LINEAR = 'linear',
-	LOG = 'log',
-	LABELS = 'labels',
-	LABELS_RATIO = 'labels-ratio',
-}
-
-/**
- * enum of all possible legend positions
- */
-export enum LegendPositions {
-	RIGHT = 'right',
-	LEFT = 'left',
-	TOP = 'top',
-	BOTTOM = 'bottom',
-}
-
-/**
- * enum of all possible alignments
- */
-export enum Alignments {
-	LEFT = 'left',
-	CENTER = 'center',
-	RIGHT = 'right',
-}
-
-/**
- * enum of all possible legend orientations
- */
-export enum LegendOrientations {
-	HORIZONTAL = 'horizontal',
-	VERTICAL = 'vertical',
-}
-
-/**
- * enum of tree types for the tree chart
- */
-export enum TreeTypes {
-	TREE = 'tree',
-	DENDROGRAM = 'dendrogram',
-}
-
-/**
- * enum of all possible layout directions
- */
-export enum LayoutDirection {
-	ROW = 'row',
-	COLUMN = 'column',
-	ROW_REVERSE = 'row-reverse',
-	COLUMN_REVERSE = 'column-reverse',
-}
-
-/**
- * enum of all possible layout growth values
- */
-export enum LayoutGrowth {
-	FIXED = 'fixed',
-	PREFERRED = 'preferred',
-	STRETCH = 'stretch',
-}
-
-/**
- * enum of all possible layout align-items values
- */
-export enum LayoutAlignItems {
-	CENTER = 'center',
-}
-
-/**
- * enum of all possible callout directions
- */
-export enum CalloutDirections {
-	LEFT = 'left',
-	RIGHT = 'right',
-}
-
-/**
- * enum of all possible skeleton/empty state types
- */
-export enum Skeletons {
-	GRID = 'grid',
-	VERT_OR_HORIZ = 'vertOrHoriz',
-	PIE = 'pie',
-	DONUT = 'donut',
-}
-
-/**
- * enum of all possible attributes used to aling text horizontally
- */
-export enum TextAnchor {
-	START = 'start',
-	MIDDLE = 'middle',
-	END = 'end',
-}
-
-/**
- * enum of all possible attributes used to aling text vertically
- */
-export enum DominantBaseline {
-	BASELINE = 'baseline',
-	MIDDLE = 'middle',
-	HANGING = 'hanging',
-}
-
-export enum GaugeTypes {
-	SEMI = 'semi',
-	FULL = 'full',
-}
-
-/**
- * enum of all possible callout directions
- */
-export enum ArrowDirections {
-	UP = 'up',
-	DOWN = 'down',
-}
-
-/**
- * enum of carbon statuses
- */
-export enum Statuses {
-	SUCCESS = 'success',
-	WARNING = 'warning',
-	DANGER = 'danger',
-}
-
-/**
- * enum of axis ticks rotation
- */
-export enum TickRotations {
-	ALWAYS = 'always',
-	AUTO = 'auto',
-	NEVER = 'never',
-}
-
-/**
- * enum of chartTypes that work with combo chart
- */
-export 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 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 enum AxisTitleOrientations {
-	LEFT = 'left',
-	RIGHT = 'right',
-}
-
-/**
- * enum of legend item type
- */
-export enum LegendItemType {
-	CHECKBOX = 'checkbox',
-	RADIUS = 'radius',
-	AREA = 'area',
-	SIZE = 'size',
-	LINE = 'line',
-	QUARTILE = 'quartile',
-	ZOOM = 'zoom',
-}
-
-/**
- * enum of color legend types
- */
-export enum ColorLegendType {
-	LINEAR = 'linear',
-	QUANTIZE = 'quantize',
-}
-
-/**
- * enum of divider status for heatmap
- */
-export enum DividerStatus {
-	ON = 'on',
-	AUTO = 'auto',
-	OFF = 'off',
-}
-
-/**
- * enum of axis flavor
- */
-export enum AxisFlavor {
-	DEFAULT = 'default',
-	HOVERABLE = 'hoverable',
-}