@visa/world-map

world-map component

Usage no npm install needed!

<script type="module">
  import visaWorldMap from 'https://cdn.skypack.dev/@visa/world-map';
</script>

README

@visa/world-map


An image depicting an example of the default world-map component

<world-map
  accessibility = {...}
  data = {[{"ID":0,"Name":"USA","Value":50,"Country Code":"840"},{data}]}
  joinAccessor = {"Country Code"}
  joinNameAccessor = {"Name"}
  valueAccessor = {"Value"}
/>

Jump To:
  1. Installation Steps
  2. Props Documentation

# Installation Steps


  • Using npm

    $ npm i @visa/world-map
    
  • Using yarn

    $ yarn add @visa/world-map
    

# Props Documentation



# Base Props <>

Name Type Default Value(s) Description
height number 325 Height in px of the map container
width number 500 Width in px of the map container
mainTitle string 'This is the Map title' The dynamic tag of title for the map (or you can create your own separately). See highestHeadingLevel prop for how tags get assigned.
subTitle string 'This is the Map subtitle' The dynamic tag for a sub title for the map (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 map. "p", "span", and "div" are also valid.


# Data Props <>

Name Type Default Value(s) Description
joinAccessor string 'countryCode' Key used to determine country's key property (ISO 3-Digit Code).
joinNameAccessor string 'countryName' Key used to determine country's name property.
groupAccessor string '' Key used to determine country/marker color.
valueAccessor string 'value' Key used to determine the country/marker's numeric property.
latitudeAccessor string '' Key used to determine marker's latitude property .
longitudeAccessor string '' Key used to determine marker's longitude property.
markerAccessor string '' Key used to determine marker's key property.
markerNameAccessor string '' Key used to determine marker's name property.
minValueOverride number undefined Overrides the calculated default min value for marker/color scales.
maxValueOverride number undefined Overrides the calculated default max value for marker/color scales.
sortOrder string '' Can be used to sort the markers ascending/descending to ensure they are layered correctly. Accepts 'asc' and 'desc'.
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 map, an array of objects which includes keys that map to above accessors.


# Accessibility Props <>

Name Type Default Value(s) Description
accessibility object (custom type) IAccessibilityType Manages messages and settings for map 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 map.
executiveSummary string '' Use this to describe the biggest takeaway of the map.
purpose string '' Use this to describe the purpose of this particular map.
contextExplanation string '' Use this to explain any controls or content on your page that affect or are affected by this map.
title string '' Gives the map 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 map, 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 map. 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 map 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 map 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 map, 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 map, 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 world map has ';
    if (d.removed) {
      updates += 'removed ' + d.removed + ' marker' + (d.removed > 1 ? 's ' : ' ');
    }
    if (d.added) {
      updates +=
        (d.removed ? 'and ' : '') + 'added ' + d.added + (d.removed ? '' : d.added > 1 ? ' markers' : ' marker');
    }
    setChartUpdates(updates);
  } else if (d.updated) {
    const newUpdate = "The map's data has changed, but no markers were removed or added.";
    setChartUpdates(
      newUpdate !== mapUpdates ? newUpdate : "The map's data has changed again, but no markers were removed or added."
    );
  }
};


# Annotation Props <>

Name Type Default Value(s) Description
annotations array[{annotations}] [] Adds annotations to the map, 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.


# Map & Marker Props <>

Name Type Default Value(s) Description
countryStyle object (custom type) ICountryStyleType Sets various style attribute for countries, see object definition.
markerStyle object (custom type) IMarkerStyleType Object for setting various style attribute for map dots/markers, see object definition.
mapProjection string 'Equal Earth' Sets the projection of the world-map to display.
mapScaleZoom number 1.25 Adjusts the zoom of the map (take caution when modifying this prop).
quality string 'High' Sets the quality of the map's vector shapes.
showGridlines boolean '' Toggles whether to display background map gridlines.

ICountryStyleType Definition

Name Type Default Value(s) Description
fill boolean true Toggles whether to color scale the countries based on valueAccessor (choropleth), joinAccessor required.
color string 'base_grey' Sets the color of the countries if fill is false.
strokeWidth string '.5px' Sets the stroke width of the countries on the map.
opacity number 0.8 Sets the opacity of the countries on the map.

IMarkerStyleType Definition

Name Type Default Value(s) Description
blend boolean false Toggles whether to use css blending mode (true = multiply, false = normal).
color string 'base_grey' Sets the color of the marker if fill is false.
fill boolean true Toggles whether to color scale the markers based on valueAccessor (requires markerAccessor).
opacity number 0.8 Sets the opacity of the markers on the map.
radius number 5 Sets the radius of the markers on the map (overwritten by radiusRange).
radiusRange string '' Sets the range for the radius scale for the markers on the map (overwrites radius).
strokeWidth string '1px' Sets the stroke width of the markers on the map.
visible boolean false Toggles whether to show markers on map.


# 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 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 map selections, an array of objects which includes keys that map to above accessors.
clickStyle object (custom type) IClickStyleType Sets the styling of elements 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 map element, the object should include keys that map to above accessors.
hoverStyle object (custom type) IHoverStyleType Sets the styling of elements 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 map geometry.
onInitialLoadEvent function undefined When initalLoad event occurs (e.g., map 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.
onDrawStartEvent function undefined When drawStart event occurs (e.g., map 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., map'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., map 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 map
//...
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
<world-map
  data={[{ data }]}
  joinAccessor={'Country Code'}
  joinNameAccessor={'Name'}
  valueAccessor={'Value'}
  interactionKeys={['Name']}
  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.
legend object (custom type) ILegendType Controls visibility and label of the map legend, see object definition below.
showTooltip boolean true When selected, allows tooltips to be displayed.
tooltipLabel object (custom type) ITooltipLabelType Controls visibility, content and format of the map's tooltip, see object definition below.

IDataLabelType Definition

Name Type Default Value(s) Description
labelAccessor string '' Key that determines which property of the data is displayed in the label.
visible boolean false Toggles the visibility (opacity) of the data labels.
placement string 'bottom' Sets the placement of the data label, accepts 'bottom'. Placement option 'auto' leverages the resolveLabelCollision algorithm and places labels without overlaps in available space on the chart.
format string '' Sets the formatting for the data labels, EG %b, refer to d3-time-format and numeral.js.
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.

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.
type string 'key' Changes legend type. Accepts 'default', 'key', or 'gradient'.
format string '0[.][0][0]a' Sets the formatting for the legend labels, EG %b, refer to d3-time-format and numeral.js.
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 map area, or between the title and map area if no subtitle is specified, see object definition below.
padding object (custom type) IBoxModelType Adds padding to plot area, see object definition below.

IBoxModelType Definition

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


# Style Props <>

Name Type Default Value(s) Description
colorPalette string 'sequential_blue' Sets the color palette of the countries/markers. Overridden by colors. Included color palettes can be found in our color utility.
colorSteps number 4 Specifies the number of steps to use from colorPalette, overridden by colors.
colors string[] undefined Accepts array of color strings or values to customize colors.