Package Exports

@vx/legend
@vx/legend/lib/legends/Legend
@vx/legend/lib/shapes/Circle
@vx/legend/lib/shapes/Line
@vx/legend/lib/shapes/Rect

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vx/legend) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@vx/legend

Legends associate shapes and colors to data, and are associated with scales.

Example

import { LegendThreshold } from '@vx/legend';
import { scaleThreshold } from '@vx/scale';

const threshold = scaleThreshold({
  domain: [0.02, 0.04, 0.06, 0.08, 0.1],
  range: ['#f2f0f7', '#dadaeb', '#bcbddc', '#9e9ac8', '#756bb1', '#54278f'],
});

function MyChart() {
  return (
    <div>
      <svg>{/** chart stuff */}</svg>
      <LegendThreshold
        scale={threshold}
        direction="column-reverse"
        itemDirection="row-reverse"
        labelMargin="0 20px 0 0"
        shapeMargin="1px 0 0"
      />
    </div>
  );
}

Installation

npm install --save @vx/legend