DocsGeomsGeomHLine
NPM Version

@graphique/geom-hline

For drawing horizontal lines in Graphique.

Install

npm install @graphique/geom-hline # @graphique/graphique is a peer dependency

Examples

Basics

Geom-level data

API

GeomHLine(props: GeomProps) => React.JSX.Element

GeomPropsinterface

namedescription
data?

data used by this Geom

This will overwrite top-level data passed to GG as it relates to mappings defined in aes.

Datum[]
aes?

functional mapping applied to data for this Geom

This extends the top-level aes passed to GG. Any repeated mappings defined here will take precedence within the Geom.

GeomAes
attr?

attributes passed to the underlying SVG elements

React.SVGAttributes
showTooltip?

should this Geom have a tooltip associated with it (default: true)

boolean
onDatumFocus?

callback called for mousemove events on the drawing area when focusing data

(data: Datum[], index: number[]) => void
onDatumSelection?

callback called for click events on the drawing area when selecting focused data

(data: Datum[], index: number[]) => void
onExit?

callback called for mouseleave events on the drawing area

() => void
isAnimated?

should elements enter/update/exit with animated transitions (default: true)

boolean
GeomHistogramGeomLabel