Name	Name	Last commit message	Last commit date
parent directory ..
docs	docs
src	src
CHANGELOG.md	CHANGELOG.md
LICENSE	LICENSE
README.md	README.md
package.json	package.json
stencil.config.ts	stencil.config.ts
tsconfig.dev.json	tsconfig.dev.json
tsconfig.json	tsconfig.json
tsconfig.prod.json	tsconfig.prod.json
tslint.json	tslint.json
yarn.lock	yarn.lock

@visa/dumbbell-plot

<dumbbell-plot
  accessibility = {...}
  data = {[{"date":"2016-01-01T00:00:00.000Z","category":"Card A","value":7670994739,"offset":-8},{data}]}
  valueAccessor = {"value"}
  ordinalAccessor = {"date"}
  seriesAccessor = {"category"}
/>

Jump To:

Installation Steps
Props Documentation

# Installation Steps

Using npm
```
$ npm i @visa/dumbbell-plot
```
Using yarn
```
$ yarn add @visa/dumbbell-plot
```

# Props Documentation

# Base Props <>

Name	Type	Default Value(s)	Description
`height`	number	300	Height in px of the chart container
`width`	number	650	Width in px of the chart container
`mainTitle`	string	'Dumbbell Plot Title'	The `dynamic` tag of title for the chart (or you can create your own separately). See `highestHeadingLevel` prop for how tags get assigned.
`subTitle`	string/ISubTitleType	'This is a subtitle'	The `dynamic` tag for a sub title for the chart (or you can create your own separately). See `highestHeadingLevel` prop for how tags get assigned.
`highestHeadingLevel`	string/number	'h2'	Sets the heading level (which also sets sublevels) for the chart. "p", "span", and "div" are also valid.
`layout`	string	'vertical'	Displays dumbbells in chart vertically or horizontally. (`vertical` and `horizontal` are the only valid inputs). If ordinalAccessor is a date, dumbbells will only display vertically.

ISubTitleType Definition

Name	Type	Default Value(s)	Description
`text`	string	‘’	Text of the subtitle.
`keywordsHighlight`	IKeywordsHighlightType[]	''	Configuration used to create highlighted words in the subtitle, an array of objects which includes `text`, `mode`, `color` and `index` keys. See `IKeywordsHighlightType` definition below for additional details.

IKeywordsHighlightType Definition

Name (keywordsHighlight.)	Type	Default Value(s)	Description
`text`	string	''	A string of one or multiple words in the subtitle text to be given the highlight treatment
`color`	string	''	HEX code color string to apply to the highlight treatment.
`mode`	'text' or 'background'	'background'	'text' will highlight the text itself with the provided color, using `ensureTextContrast` utility to ensure text contrast. 'background' will highlight the background-color of the created `span` with the provided color.
`index`	number		If provided, highlight treatment is provided to the specific instance of the text within the sub-title. Otherwise, all instances of the provided string will be given highlight treatment.

# Data Props <>

Name	Type	Default Value(s)	Description
`ordinalAccessor`	string	'date'	Key used to determine dumbbell's categorical property.
`valueAccessor`	string	'value'	Key used to determine dumbbell's numeric property.
`seriesAccessor`	string	'category'	Key used to determine dumbbell's series.
`uniqueID`	string	`undefined`	ID used to identify chart (must be unique per chart), helpful for validation messages. Defaults to UUID v4 standard.
`data`	object[]	`undefined`	Data used to create chart, an array of objects which includes keys that map to above accessors.
`sortOrder`	string	''	Sets bar sort order. Accepts `'asc'`, `'desc'`, `'diffAsc'` , `'diffDesc'` , `'focusAsc'`, `'focusDesc'`, `'absoluteDiffAsc'`, `'absoluteDiffDesc'` .

# Accessibility Props <>

Name	Type	Default Value(s)	Description
`accessibility`	object (custom type)	IAccessibilityType	Manages messages and settings for chart accessibility, see object definition below.

IAccessibilityType Definition

Name (accessibility.)	Type	Default Value(s)	Description
`longDescription`	string	''	Use this to add a helpful description of the chart.
`executiveSummary`	string	''	Use this to describe the biggest takeaway of the chart.
`purpose`	string	''	Use this to describe the purpose of this particular chart.
`contextExplanation`	string	''	Use this to explain any controls or content on your page that affect or are affected by this chart.
`title`	string	''	Gives the chart an alternate title to be used by screen readers.
`elementDescriptionAccessor`	string	''	Optional key used to add an additional description to any element, from your data.
`statisticalNotes`	string	''	Use this to provide any statistical explanations, such as trends, clusters, patterns, or outliers.
`structureNotes`	string	''	Use this to describe special visual features of the chart, such as sorting, color grouping, etc.
`includeDataKeyNames`	boolean	false	If true, includes data key names in voice over description of each element. EG "Year over year growth: 5.6%" instead of just "5.6%"
`hideDataTableButton`	boolean	false	If true, hides the data table button (but it is still available to screen reader users).
`disableValidation`	boolean	false	If true, disables validations of accessibility props for this chart. Validation is intended to be used during development; upon completion, validation should be disabled.
`elementsAreInterface`	any/boolean	null	Defaults to null. Set to true if interacting with the elements in this chart affects your application. Otherwise, must be set to false.
`onChangeFunc`	function	`undefined`	Custom event listener (changeFunc) that enables dev to control accessibility page experience when chart data updates.
`showSmallLabels`	boolean	false	Defaults to false. Set to true if you would like to display labels on small elements that are likely to overlap. Note, this could impact accessibility of your graphic.
`hideStrokes`	boolean	false	Defaults to false. Set to true if you would like to remove automated stroke outlines from the chart, note, this could impact accessibility of your graphic.
`hideTextures`	boolean	false	Defaults to false. Set to true if you would like to remove textures from the chart, note, this could impact accessibility of your graphic.
`keyboardNavConfig`	IKeyConfig	`{ disabled: false }`	Defaults disabled to false. May be set to true if `accessibility.elementsAreInterface = false` and `suppressEvents = true`. This will disable keyboard navigation and simplify chart instructions for screen reader users.
`showExperimentalTextures`	boolean	false	Defaults to false. Set to true if you would like leverage our textures which are still undergoing research and development.

// accessibility = { ...accessibility, onChangeFunc: d => changeHandler(d)}
// example of setting updates on page based on changeFunc custom events
const changeHandler = d => {
  if (d.updated && (d.removed || d.added)) {
    let updates = 'The dumbbell chart has ';
    if (d.removed) {
      updates += 'removed ' + d.removed + ' bar' + (d.removed > 1 ? 's ' : ' ');
    }
    if (d.added) {
      updates += (d.removed ? 'and ' : '') + 'added ' + d.added + (d.removed ? '' : d.added > 1 ? ' bars' : ' bar');
    }
    setChartUpdates(updates);
  } else if (d.updated) {
    const newUpdate = "The chart's data has changed, but no bars were removed or added.";
    setChartUpdates(
      newUpdate !== chartUpdates ? newUpdate : "The chart's data has changed again, but no bars were removed or added."
    );
  }
};

# Localization Props <>

Name	Type	Default Value(s)	Description
`localization`	object (custom type)	ILocalizationType	Manages messages and settings for chart localization, see object definition below.

ILocalizationType Definition

Name (localization.)	Type	Default Value(s)	Description
`language`	string/object	en	Use this to add a language to a chart. This can be string value like `en` or valid translation object.
`numeralLocale`	string/object	US	Use this to add a numerical locale to a chart. This can be string value like `US` or valid numeralLocale object.
`overwrite`	boolean	false	Use this to describe the purpose of this particular chart.
`skipValidation`	boolean	false	If true, disables validations of localization props for this chart. Validation is intended to be used during development; upon completion, validation should be disabled.

# Annotation Props <>

Name	Type	Default Value(s)	Description
`annotations`	array[{annotations}]	[]	Adds annotations to the chart, see d3-svg-annotation by Susie Lu.

annotations object definition

annotations is an array of objects which needs to have the following properties within them. See the detailed api specifications from d3-svg-annotation, along with additional properties layered on top of that work, documented below.

Name	Type	Default Value(s)	Description
`accessibilityDescription`	string	`undefined`	Sets the accessibility description for the annotation for screen reader users.

# Axis Props <>

Name	Type	Default Value(s)	Description
`xAxis`	object (custom type)	IAxisType	Manages settings for the chart's x axis, see object definition below.
`yAxis`	object (custom type)	IAxisType	Manages settings for the chart's y axis, see object definition below.
`minValueOverride`	number	`undefined`	Overrides the calculated default min value.
`maxValueOverride`	number	`undefined`	Overrides the calculated default max value.
`showBaselineX`	boolean	false	When selected and layout = vertical, shows the x baseline
`showBaselineY`	boolean	false	When selected and layout = horizontal, shows the y baseline
`wrapLabel`	boolean	true	When selected, wraps the ordinal axis labels.

IAxisType Definition

Name (xAxis./yAxis.)	Type	Default Value(s)	Description
`visible`	boolean	true	Toggles the visibility of the axis.
`displayOnly`	string/array	'all'	Sets display of the available data labels. Options: `all`, `first`, `last`, `min` `max`. Combinations can be done with array.
`gridVisible`	boolean	true	Toggles the visibility of the axis grid.
`label`	string	'X Axis'	Sets the label for the axis.
`unit`	string	'' or 'month'	Sets the unit of padding for the axis when accessor is a date.
`format`	string	'' or '%b %y' or '0[.][0][0]a'	Sets the formatting for axis elements, EG %b, refer to d3-time-format and numeral.js.
`tickInterval`	number	1	Can be used to reduce the frequency of axis ticks. This number sets the interval of axis ticks that are shown.

# Bar & Marker Props <>

Name	Type	Default Value(s)	Description
`barStyle`	object (custom type)	IBarStyleType	Set styling for the dumbbell's bar, see object definition below.
`marker`	object (custom type)	IMarkerStyleType	Sets the visibility, type, and size of the bar marker, see object definition below.
`focusMarker`	object (custom type)	IFocusStyleType	Optional. Specifies the key value and size to focus one marker (based on seriesAccessor), see object definition below.

IBarStyleType Definition

Name (barStyle.)	Type	Default Value(s)	Description
`colorRule`	string	'default'	Sets the color rule for the dumbbell bar (options are 'greaterValue', 'focus' or 'default').
`opacity`	number	1	Sets the opacity of the dumbbell bar.
`width`	number	1	Sets the width of the dumbbell bar.

IMarkerStyleType Definition

Name (marker.)	Type	Default Value(s)	Description
`type`	string	'dot'	Sets the shape type of dumbbell markers.
`sizeFromBar`	number	8	Sets the size of the marker.
`visible`	boolean	true	Sets the visibility of dumbbell markers.

IFocusStyleType Definition

Name (focusMarker.)	Type	Default Value(s)	Description
`key`	string	''	Key used to determine which marker to focus.
`sizeFromBar`	number	12	Sets the size of the focus marker.

# Event Props <>

Events in stencil.js dispatch Custom DOM events for other components to handle, we use Stencil's @Event() decorator to emit events (click, hover, mouseOut) from end user activity on our charts.

Name	Type	Default Value(s)	Description
`suppressEvents`	boolean	false	Suppresses and disables click, hover and mouseOut event emitters. Setting to true can increase performance for non-interactive charts.
`cursor`	string	'default'	Changes pointer type during mouse over on data elements. Valid values are 'default' or 'pointer'.
`onClickEvent`	function	`undefined`	When clickEvent event occurs (e.g., mouse/keyboard click on chart geometry), this event handler will be called with the custom event object (e.g., e), containing data and target node at e.detail `{data: d, target: n}`. You will need to construct your own functionality of what actions to take within the callback.
`clickHighlight`	object[]	[]	Data used to track chart selections, an array of objects which includes keys that map to above accessors.
`clickStyle`	object (custom type)	IClickStyleType	Sets the styling of a data element when they are selected, see object definition below.
`onHoverEvent`	function	`undefined`	When hoverEvent event occurs (e.g., mouse hover/keyboard focus on chart geometry), this event handler will be called with the custom event object (e.g., e), containing data and target node at e.detail `{data: d, target: n}`. You will need to construct your own functionality of what actions to take within the callback.
`onMouseOutEvent`	function	`undefined`	When mouseOutEvent event occurs (e.g., mouse/keyboard blur on chart geometry), this event handler will be called, and has no data object. You will need to construct your own functionality of what actions to take within the callback.
`hoverHighlight`	object	{}	Datum object used to track active chart element, the object should include keys that map to above accessors.
`hoverStyle`	object (custom type)	IHoverStyleType	Sets the styling of a data element when they are hovered/focused, see object definition below.
`interactionKeys`	string[]	[]	Sets the column names of data to interact with.
`hoverOpacity`	number	1	Sets opacity of inactive elements when hovering/focused on a chart geometry.
`onInitialLoadEvent`	function	`undefined`	When initalLoad event occurs (e.g., chart is mounted to window), this event handler will be called with the custom event object (e.g., e), containing the corresponding chartID at e.detail. You will need to construct your own functionality of what actions to take within the callback.
`onInitialLoadEndEvent`	function	`undefined`	When initalLoadEnd event occurs (e.g., chart has been mounted to window), this event handler will be called with the custom event object (e.g., e), containing the corresponding chartID at e.detail. You will need to construct your own functionality of what actions to take within the callback.
`onDrawStartEvent`	function	`undefined`	When drawStart event occurs (e.g., chart render function is called), this event handler will be called with the custom event object (e.g., e), containing the corresponding chartID at e.detail. You will need to construct your own functionality of what actions to take within the callback.
`onDrawEndEvent`	function	`undefined`	When drawEnd event occurs (e.g., chart's stencil lifecycle completes), this event handler will be called with the custom event object (e.g., e), containing the corresponding chartID at e.detail. You will need to construct your own functionality of what actions to take within the callback.
`onTransitionEndEvent`	function	`undefined`	When transitionEnd event occurs (e.g., chart geometry's transition lifecycle completes), this event handler will be called with the custom event object (e.g., e), containing the corresponding chartID at e.detail. You will need to construct your own functionality of what actions to take within the callback.

IClickStyleType Definition

Name	Type	Default Value(s)	Description
`color`	string	''	Sets the color of the clicked element (requires clickHighlight to be valid and sent).
`strokeWidth`	number	2	Sets the stroke width of the clicked element (requires clickHighlight to be valid and sent).

IHoverStyleType Definition

Name	Type	Default Value(s)	Description
`color`	string	''	Sets the color of the hovered element (requires hoverHighlight to be valid and sent).
`strokeWidth`	number	2	Sets the stroke width of the hovered element (requires hoverHighlight to be valid and sent).

// example of interactivity code
// note this only tracks a single click, you need your own logic to build the array of currnet selections made by user and then pass that result back to chart
//...
const clickHandler = evt => {
  const d = evt.detail.data; // data is located here
  const t = evt.detail.target; // chart mark/label clicked is located here

  this.currentClickedElement = [d]; // this is passed to clickHighlight prop
};

const hoverHandler = evt => {
  const d = evt.detail.data; // data is located here
  const t = evt.detail.target; // chart mark/label clicked is located here

  this.currentHoveredElement = d; // this is passed to hoverHighlight prop
};

const mouseOutHandler = evt => {
  this.currentHoveredElement = ''; // this is passed to hoverHighlight prop
};

// an example of calling these from within a stencil.js component
<dumbbell-plot
  data={[{ data }]}
  valueAccessor={'value'}
  ordinalAccessor={'date'}
  seriesAccessor={'category'}
  interactionKeys={['date']}
  onClickEvent={this.onClickEvent}
  clickHighlight={this.currentClickedElement}
  clickStyle={this.clickStyle}
  onHoverEvent={this.onHoverEvent}
  onMouseOutEvent={this.onMouseOut}
  hoverHighlight={this.currentHoveredElement}
  hoverStyle={this.hoverStyle}
/>;
//...

# Label Props <>

Name	Type	Default Value(s)	Description
`dataLabel`	object (custom type)	IDataLabelType	Controls visibility, styling and placement of data labels, see object definition below.
`dataKeyNames`	object	`undefined`	Object that contains mapping of data keys (e.g., accessors) and user friendly names of the data fields. This prop can be used to enable translation of data keys between languages, or just provide a meaningful name for data elements within a chart. The key:value pairs in this object will effect tooltips, data table, aria labels, axes, etc. Anywhere in chart where data key may be exposed to consumers.
`differenceLabel`	object (custom type)	IDifferenceLabelType	Controls visibility, styling and placement of difference labels, see object definition below.
`seriesLabel`	object (custom type)	ISeriesLabelType	Controls visibility, styling and placement of series labels, see object definition below.
`legend`	object (custom type)	ILegendType	Controls visibility and label of the chart legend, see object definition below.
`showTooltip`	boolean	true	Toggles whether to display the tooltip on hover/focus on chart geometries.
`tooltipLabel`	object (custom type)	ITooltipLabelType	Controls visibility, content and format of the chart tooltip, see object definition below.

IDataLabelType Definition

Name	Type	Default Value(s)	Description
`labelAccessor`	string	''	Key used to determine label's property.
`visible`	boolean	true	Toggles the visibility (opacity) of the data labels.
`placement`	string	'ends'	Sets the placement of the data label. Accepts 'top', 'bottom', 'left', 'right', and 'ends'. Placement option 'auto' leverages the resolveLabelCollision algorithm and places labels without overlaps in available space on the chart.
`format`	string	'0[.][0][0]a'	Sets the formatting for the data labels, EG %b, refer to d3-time-format and numeral.js. If used with `text` or `string` values, the value declared in `labelAccessor` will be used without any additional formatting.
`collisionHideOnly`	boolean	false	Toggles whether to run resolveLabelCollision algorithm and hide labels if collision is detected (vs hide and then place). This is overridden by placement being set to `auto`.

IDifferenceLabelType Definition

Name	Type	Default Value(s)	Description
`calculation`	string	'difference'	Sets the calculation used in the difference label. Accepts 'difference' or 'middle'.
`visible`	boolean	true	Toggles the visibility (opacity) of the difference labels.
`placement`	string	'left'	Sets the placement of the data label. Accepts 'top', 'bottom', 'left', and 'right'.
`format`	string	'0[.][0][0]a'	Sets the formatting for the data labels, EG %b, refer to d3-time-format and numeral.js. Placement option 'auto' leverages the resolveLabelCollision algorithm and places labels without overlaps in available space on the chart.
`collisionHideOnly`	boolean	false	Toggles whether to run resolveLabelCollision algorithm and hide difference labels if collision is detected (vs hide and then place). This is overridden by placement being set to `auto`.

ISeriesLabel Definition

Name	Type	Default Value(s)	Description
`label`	string[]	[]	An array which determines the labels for each series, in order.
`visible`	boolean	true	Toggles the visibility (opacity) of the series labels.
`placement`	string	'right'	Sets the placement of the series label, accepts 'left', 'right', 'top', and 'bottom' Placement option 'auto' leverages the resolveLabelCollision algorithm and places labels without overlaps in available space on the chart.
`collisionHideOnly`	boolean	false	Toggles whether to run resolveLabelCollision algorithm and hide series labels if collision is detected (vs hide and then place). This is overridden by placement being set to `auto`.

ILegendType Definition

Name	Type	Default Value(s)	Description
`visible`	boolean	true	Toggles the visibility (opacity/display) of the legend.
`interactive`	boolean	false	Toggles the interactivity of the legend.
`labels`	string[]	''	An array that sets each label in the legend, in order. Passing empty string will populate legend labels directly from data values.

ITooltipLabelType Definition

Name	Type	Default Value(s)	Description
`labelAccessor`	string[]	[]	An array that determines which property of the data is displayed in the tooltip.
`labelTitle`	string[]	[]	An array that sets the title for each data property in the tooltip.
`format`	string	''	Sets the formatting for the data properties in the tooltip, EG %b, refer to d3-time-format and numeral.js.

# Margin & Padding Props <>

Name	Type	Default Value(s)	Description
`margin`	object (custom type)	IBoxModelType	Margin between the subtitle and the chart area, or between the title and chart area if no subtitle is specified, see object definition below.
`padding`	object (custom type)	IBoxModelType	Padding between plot area and axes lines, see object definition below.

IBoxModelType Definition

Name	Type	Default Value(s)	Description
`top`	number	height * 0.01	Sets the top margin/padding for the chart container.
`bottom`	number	height * 0.01	Sets the bottom margin/padding for the chart container.
`left`	number	width * 0.01	Sets the top margin/padding for the chart container.
`right`	number	width * 0.01	Sets the top margin/padding for the chart container.

# Style Props <>

Name	Type	Default Value(s)	Description
`colorPalette`	string	'categorical'	Included color palettes can be found in our color utility. Overridden by colors.
`colors`	string[]	`undefined`	Accepts array of color strings or color values to customize colors beyond our palettes. Colors assigned in order.

# Reference Line Props <>

Name	Type	Default Value(s)	Description
`referenceLines`	object[]	[]	Data that sets the location and labeling of the reference line(s) see object definition below. ### IReferenceLineType
`referenceStyle`	object (custom type)	IReferenceStyleType	Sets the styling of reference line(s) placed on the chart, see object definition below. #### IReferenceStyleType Definition

IReferenceStyleType Definition

Name	Type	Default Value(s)	Description
`color`	string	'pri_grey'	Sets the color of the reference line.
`strokeWidth`	number	1	Sets the stroke width of the reference line.
`opacity`	number	1	Sets the opacity of the reference line.
`dashed`	string	''	Sets the dash array property of the path element of the reference line.

referenceLines object definition

referenceLines is an array of objects which needs to have the following properties within them.

Name	Type	Default Value(s)	Description
`label`	string	`undefined`	Sets the label to show for the reference line.
`labelPlacementHorizontal`	string	Chart horizontal layout mode: `left` or `middle` or `right`. Chart vertical layout mode: `top` or `bottom`.	Sets the horizontal label placement for the reference line.
`labelPlacementVertical`	string	Chart horizontal layout mode: `left` or `right`. Chart vertical layout mode: `top` or `middle` or `bottom`.	Sets the vertical label placement for the reference line.
`value`	number	`undefined`	Sets the value where to place the reference line, per the axis.
`accessibilityDescription`	string	`undefined`	Descriptive text for the reference line which will be provided to screen reader users via VCCs accessibility description's setAccessAnnotation utility.
`accessibilityDecorationOnly`	boolean	`undefined`	When the reference line is decorative (e.g., does not provide any additional information), set accessibilityDecorationOnly to true to avoid unnecessary reference line content in VCCs accessibility descriptions.

# Unit Testing Props <>

These props are used in development mode only to facilitate robust testing of charts, the should not be leveraged in a production deployments.

Name	Type	Default Value(s)	Description
`unitTest`	boolean	false	If true, attaches relevant testing attributes to the chart's DOM elements, this only needs to be true when running our unit tests.

Files

dumbbell-plot

Directory actions

More options