OECD chart

OECD Chart library

Getting started

npm install @oecd-pac/chart --save

Then simply import and use the Chart component:

import React from 'react';
import { Chart } from '@oecd-pac/chart';

const App = () => (
  <div style={{ width: '800px', height: '600px' }}>
    <Chart chartId="xxxxxxx" />
  </div>
);

export default App;

The only required prop is chartId but if the corresponding chart is configured to use variables, var1, var2, var3,... var10 can be used as well:

<Chart chartId="xxxxxxx" var1="FRA" var2="USA" />

Note about sizing

A chart does not have an intrinsic size like an image (it can be any size) and therefore the Chart component cannot "guess" the desired size.

By default (if width and height are omitted) the chart will use all available space within its parent container.

A width can be passed (number or string are accepted: e.g.: width={300}, width="300", width="300px", width="50%"...)

The Chart component also accepts a height (number only; any non numerical values will be ignored, e.g.: height="300px", height="50%")

Specifying height or not makes a subtle difference when the chart has controls and this allows two sizing strategies:

Strategy 1: Omit height

The chart will take as much space as it can (within the constraints of the parent container):

<div style={{ width: '100%', maxWidth: '400px', height: '300px' }}>
  <Chart chartId="xxxxxxx" />
</div>

• Pro: The height of the chart (including controls) is guaranteed.
• Cons: If the chart contains controls, it is not guaranteed that they will be displayed; the controls might stack (for instance, when the width is very low) and the controls may be automatically hidden as they are considered less important than the chart itself.

Strategy 2: Pass height explicitly

It is important to note that height implicitly means "chart height" (not including potential controls).

When using this approach, the parent container has to use minHeight (not height):

<div style={{ width: '100%', maxWidth: '400px', minHeight: '300px' }}>
  <Chart chartId="xxxxxxx" width={400} height={300} />
</div>

• Pro: The controls are guaranteed to be displayed, even if the total height of the chart + controls is more than the specified height (300 in the previous example).
• Con: The total height of the chart + controls is not guaranteed.

Lazy loading

The charts are lazy loaded by befault (when the top edge is 100px from viewport).

It can be disabled using lazyLoad={false}.

Language

When a chart exists in multiple languages, the language prop can be used, e.g.: language="fr".

If omitted (or the requested language has not been configured) the default one will be used.

Hiding elements

The following props are supported:

• hideTitle: hides the title
• hideSubtitle: hides the subtitle
• hideSource: hides the source
• hideNote: hides the note
• hideToolbox: hides the toolbox

Web components

Even though this is a React library, the charts can be used in pages / apps that are not React based. For this purpose "web components" are also exported. Note that React (18) and ReactDOM still have to be in scope.

The bundle can be found here: node_modules\@oecd-pac\chart\dist\oecd-chart-latest.js

Once loaded, charts can be used as follow:

<div style="width: 400px; height: 300px">
  <oecd-chart chart-id="xxxxxxx"></oecd-chart>
</div>

Development

Building

npm run build

Testing

This project uses Jest with React Testing Library for testing. See TESTING.md for detailed testing documentation.

npm test                # Run tests
npm run test:watch      # Run tests in watch mode
npm run test:coverage   # Run tests with coverage report

Linting

npm run lint