Line

@nivo/linecanvas
svgcanvashttp api

A variation around the Line component. Well suited for large data sets as it does not impact DOM tree depth, however you'll lose the isomorphic ability and transitions.

The responsive alternative of this component is ResponsiveLineCanvas.

1331 nodes
Actions Logs
Start interacting with the chart to log actions
Base
object[]required

Chart data.

objectoptional

X scale configuration.

Function | stringoptional
open editor

Optional formatter for x values.

objectoptional

Y scale configuration.

Function | stringoptional
open editor

Optional formatter for y values.

numberrequired

Chart width.

numberrequired

Chart height.

numberoptionaldefault:'Depends on device'

Adjust pixel ratio, useful for HiDPI screens.

supportsvgcanvasapi
objectoptional
px
px
px
px

Chart margin.

Style
stringoptionaldefault:'linear'
monotoneX

Curve interpolation.

Themeoptional

Define style for common elements such as labels, axes…

OrdinalColorScaleConfigoptionaldefault:{"scheme":"nivo"}
Diverging: Spectral

Define chart's colors.

numberoptionaldefault:2
px

Line width.

booleanoptionaldefault:false
   

Enable/disable area below each line.

number | string | Dateoptionaldefault:0

Define the value to be used for area baseline.

numberoptionaldefault:0.2

Area opacity (0~1), depends on enableArea.

CssMixBlendModeoptionaldefault:'normal'

Define CSS mix-blend-mode for areas.

supportsvgcanvasapi
object[]optional

Define patterns and gradients.

supportsvgcanvasapi
object[]optional

Define rules to apply patterns and gradients

supportsvgcanvasapi
Customization
(string | Component)[]optionaldefault:['grid', 'markers', 'axes', 'areas', 'crosshair', 'lines', 'points', 'slices', 'mesh', 'legends']

Defines the order of layers and add custom layers.

Points
booleanoptionaldefault:true
   

Enable/disable points.

Functionoptional

Overrides default point circle. The function will receive size, color, borderWidth and borderColor props and must return a valid SVG element.

supportsvgcanvasapi
numberoptionaldefault:6
px

Size of the points.

string | object | Functionoptionaldefault:{"from":"color"}
inheritthemecustom
theme property
background

Method to compute points color.

numberoptionaldefault:0
px

Width of the points border.

string | object | Functionoptionaldefault:{"theme":"background"}
inheritthemecustom
inherited property
Select...
modifiers
No modifier.

Method to compute points border color.

booleanoptionaldefault:false

Enable/disable points label.

supportsvgcanvasapi
stringoptional

Property to use to determine point label. If a function is provided, it will receive current point data and should return the desired label.

supportsvgcanvasapi
numberoptionaldefault:-12

Label Y offset from point shape.

supportsvgcanvasapi
Grid & Axes
booleanoptionaldefault:true
   

Enable/disable x grid.

(number | string)[]optional

Specify values to use for vertical grid lines.

booleanoptionaldefault:true
   

Enable/disable y grid.

(number | string)[]optional

Specify values to use for horizontal grid lines.

objectoptional

Top axis configuration.

objectoptional

Right axis configuration.

objectoptional

Bottom axis configuration.

objectoptional

Left axis configuration.

Interactivity
booleanoptionaldefault:true
   

Enable/disable interactivity.

supportsvgcanvasapi
booleanoptionaldefault:false

Use a voronoi mesh to detect mouse interactions, enableSlices must be disabled

supportsvgcanvasapi
booleanoptionaldefault:false
   

Display mesh used to detect mouse interactions (voronoi cells).

supportsvgcanvasapi
(point, event) => voidoptional

onMouseEnter handler, doesn't work with slice tooltip.

supportsvgcanvasapi
(point, event) => voidoptional

onMouseMove handler, doesn't work with slice tooltip.

supportsvgcanvasapi
(point, event) => voidoptional

onMouseLeave handler, doesn't work with slice tooltip.

supportsvgcanvasapi
(point, event) => voidoptional

onClick handler, doesn't work with slice tooltip.

supportsvgcanvasapi
Functionoptional

Custom point tooltip

supportsvgcanvasapi
stringoptional
cursor

Tooltip position when hovering

supportsvgcanvasapi
'x' | 'y' | falseoptional

Enable/disable slices tooltip for x or y axis, automatically disable mesh.

supportsvgcanvasapi
booleanoptionaldefault:false

Display area used to detect mouse interactions for slices.

supportsvgcanvasapi
Functionoptional

Custom slice tooltip

supportsvgcanvasapi
booleanoptionaldefault:true

Enable/disable crosshair.

supportsvgcanvasapi
stringoptionaldefault:'bottom-left'

Crosshair type, forced to slices axis if enabled.

supportsvgcanvasapi
Legends
object[]optional

Optional chart's legends.

add legend
legend[0]: bottom-right, columnremove
stringoptional
bottom-right

Defines legend anchor relative to chart's viewport.

supportsvgcanvasapi
'column' | 'row'optional

Legend direction, must be one of 'column', 'row'.

supportsvgcanvasapi
booleanoptional
   

Justify symbol and label.

supportsvgcanvasapi
numberoptional
px

Legend block x translation.

supportsvgcanvasapi
numberoptional
px

Legend block y translation.

supportsvgcanvasapi
numberrequired
px

Legend item width.

supportsvgcanvasapi
numberrequired
px

Legend item height.

supportsvgcanvasapi
numberoptional
px

Spacing between each item.

supportsvgcanvasapi
numberoptional
px

Item symbol size.

supportsvgcanvasapi
stringoptional
left-to-right

Item layout direction.

supportsvgcanvasapi
Motion
booleanoptionaldefault:true

Enable/disable transitions.

supportsvgcanvasapi
string | objectoptionaldefault:'gentle'

Motion config for react-spring, either a preset or a custom configuration.

supportsvgcanvasapi
Recipes
holes in datadifferent serie lengths