@visx/grid

What is @visx/grid?

@visx/grid is a part of the VisX library, which provides a set of low-level visualization components for building custom visualizations in React. The @visx/grid package specifically offers components for rendering grid lines in charts, which can help in creating more readable and organized data visualizations.

What are @visx/grid's main functionalities?

Grid Rows

This feature allows you to render horizontal grid lines (rows) in your chart. The GridRows component takes a scale, width, height, and other styling properties to render the grid lines.

import { GridRows } from '@visx/grid';
import { scaleLinear } from '@visx/scale';
import { extent } from 'd3-array';

const data = [10, 20, 30, 40, 50];
const yScale = scaleLinear({
  domain: extent(data),
  range: [0, 400],
});

<GridRows
  scale={yScale}
  width={500}
  height={400}
  stroke="black"
  strokeDasharray="2,2"
/>

Grid Columns

This feature allows you to render vertical grid lines (columns) in your chart. The GridColumns component takes a scale, height, and other styling properties to render the grid lines.

import { GridColumns } from '@visx/grid';
import { scaleLinear } from '@visx/scale';
import { extent } from 'd3-array';

const data = [10, 20, 30, 40, 50];
const xScale = scaleLinear({
  domain: extent(data),
  range: [0, 500],
});

<GridColumns
  scale={xScale}
  height={400}
  stroke="black"
  strokeDasharray="2,2"
/>

Grid

This feature allows you to render both horizontal and vertical grid lines in your chart. The Grid component takes xScale, yScale, width, height, and other styling properties to render the grid lines.

import { Grid } from '@visx/grid';
import { scaleLinear } from '@visx/scale';
import { extent } from 'd3-array';

const data = [10, 20, 30, 40, 50];
const xScale = scaleLinear({
  domain: extent(data),
  range: [0, 500],
});
const yScale = scaleLinear({
  domain: extent(data),
  range: [0, 400],
});

<Grid
  xScale={xScale}
  yScale={yScale}
  width={500}
  height={400}
  stroke="black"
  strokeDasharray="2,2"
/>

Other packages similar to @visx/grid

d3

D3.js is a powerful JavaScript library for creating data visualizations. It provides extensive functionality for creating and manipulating SVG elements, including grid lines. However, D3.js is more low-level compared to @visx/grid, which is specifically designed for React and provides higher-level components for grid lines.

recharts

Recharts is a composable charting library built on React components. It provides a variety of chart types and includes grid line functionality out of the box. Recharts is more opinionated and higher-level compared to @visx/grid, which offers more flexibility and customization options.

victory

Victory is another React-based charting library that provides a set of modular charting components, including grid lines. Victory is similar to @visx/grid in that it is designed for React, but it offers a more comprehensive set of charting components and is easier to use for common chart types.

README

@visx/grid

The @visx/grid package lets you create gridlines for charts. <GridRows /> render horizontally, <GridColumns /> render vertically, or you can use a <Grid /> to get them both at once!

Usage

import { Grid } from '@visx/grid';
// or
// import * as Grid from '@visx/grid';
// <Grid.Grid />

const grid = (
  <Grid
    xScale={xScale}
    yScale={yScale}
    width={xMax}
    height={yMax}
    numTicksRows={numTicksForHeight(height)}
    numTicksColumns={numTicksForWidth(width)}
  />
);

Installation

npm install --save @visx/grid

Changelog

v3.12.0 (2024-11-07)

:rocket: Enhancements

• feat(sankey): add @visx/sankey #1880

:memo: Documentation

• Fix small error in the code example in the "Theming" section #1863

:trophy: Contributors

• jacksonhardaker
• maurer2