Global

Members

(constant) getDefaultSVGProps

Source:

core/Shape/Shape.js, line 16

Properties:

Name	Type	Description
`svgClassNames`	string	SVG class name
`svgStyles`	string	SVG styles
`transformFn`	function	Function callback for translating SVG
`onClickFn`	function	Function callback for onclick event
`a11yAttributes`	object	a11y attributes for SVG

Creates a skeleton for SVG props used to generate nested SVG

(constant) getSVGObject

Source:

helpers/shapeSVG.js, line 10

Returns an object to create a svg circle for data point

(constant) getSVGObjectForEvent

Source:

helpers/shapeSVG.js, line 26

Returns an object to create a svg circle for event data point

(constant) helpers

Source:

carbon.js, line 34

Properties:

Name	Type	Description
`AXIS_TYPE`	object	Carbon API axis types constants
`COLORS`	object	Carbon API color constants
`LINE_TYPE`	object	Carbon API line type constants
`LOCALE`	object	Carbon API locale objects
`SHAPES`	object	Carbon API shape constants

Carbon helper constants

(constant) LINE :Object

Source:

core/Shape/shapeDefinitions.js, line 336

The S_0013_line.svg SVG file as an object.

Type:

Object

(constant) LINE_DASHED :Object

Source:

core/Shape/shapeDefinitions.js, line 346

The S_0014_dashed_line.svg SVG file as an object.

Type:

Object

(constant) LOCALE :Object

Source:

locale/index.js, line 48

Properties:

Name	Type	Description
`de_DE`	object	Carbon locale DE
`en_AU`	object	Carbon locale AU
`en_CA`	object	Carbon locale CA
`en_GB`	object	Carbon locale GB
`en_US`	object	Carbon locale default
`es_ES`	object	Carbon locale ES
`fr_FR`	object	Carbon locale FR
`pt_BR`	object	Carbon locale BR
`ja_JP`	object	Carbon locale JP
`nl_NL`	object	Carbon locale NL
`sv_SE`	object	Carbon locale SE

Locale objects serving as a default set. Consumer can provide a set of properties that axes ticks will honor when the locale is set.

Type:

Object

(constant) renderSelectionPathForEvents

Source:

controls/Gantt/helpers/datapointHelpers.js, line 99

Renders the circle svg element for event which shows up when clicked on the data point. It is hidden by default and toggled visible onClick.

(constant) tools :Object

Source:

carbon.js, line 20

Properties:

Name	Type	Description
`shape`	Object
`defaultSVGProps`	Object

Carbon tools for generating reusable items like different shapes

Type:

Object

Methods

getValueRegionSubset(dataTarget, getXDataValues) → {Array}

Source:

controls/Line/helpers/helpers.js, line 262

Extracts regions inside value and prepare a list of value region

Parameters:

Name	Type	Description
`dataTarget`	object	Data points object
`getXDataValues`	function	checks if the value is valid and extract value for x-axis

Returns:

value region subset

Type: Array

Type Definitions

Bubble

Source:

controls/Bubble/helpers/helpers.js, line 27

d3

Source:

controls/Bar/helpers/legendHelpers.js, line 10

d3

Source:

controls/Bar/helpers/selectionHelpers.js, line 10

d3

Source:

controls/Bar/helpers/translateHelpers.js, line 12

d3

Source:

controls/Pie/PieContent.js, line 2

Type:

object

d3

Source:

helpers/datetimeBuckets.js, line 4

Gantt

Source:

controls/Gantt/helpers/actionHelpers.js, line 24

GanttConfig

Source:

controls/Gantt/Gantt.js, line 47

Type:

object

GanttConfig

Source:

controls/Gantt/Track.js, line 2

Type:

object

GraphConfig

Source:

controls/Graph/Graph.js, line 46

Type:

object

Line

Source:

controls/Line/helpers/helpers.js, line 39

LineConfig

Source:

controls/Line/Line.js, line 35

Type:

object

PairedResult

Source:

controls/PairedResult/helpers/helpers.js, line 45

PairedResultConfig

Source:

controls/PairedResult/PairedResult.js, line 42

Type:

object

PieConfig

Source:

controls/Pie/Pie.js, line 22

Type:

object

Scatter

Source:

controls/Scatter/helpers/helpers.js, line 36

ScatterConfig

Source:

controls/Scatter/Scatter.js, line 32

Type:

object

TimelineConfig

Source:

controls/Timeline/Timeline.js, line 32

Type:

object

TimelineConfig

Source:

controls/Timeline/TimelineContent.js, line 2

Type:

object

TimelineContent

Source:

controls/Timeline/helpers/creationHelpers.js, line 33