@datalith/spiral
TypeScript icon, indicating that this package has built-in type declarations

0.12.1 • Public • Published

@datalith/spiral

yarn add @datalith/spiral

Docs

<Spiral className="spiral" data={data} />
Name Default Type Description
className string Custom css classes to apply to the SVG
style React.CSSProperties Custom style object to apply to the SVG
additionalElements JSX.Element Optional elements to add to the SVG
size { width: number; height: number } Width and Height of the SVG. Default is parent node size.
data* Array<Datum> or Array<number> Array of data
value (Datum) => Datum (Datum) => number or number Value accessor
valueInactive 1 number Value Inactive accessor
fill (Datum) => string or string Fill color accessor
fillInactive #000 string Fill Inactive accessor
fillOpacity (Datum) => number or number Fill Opacity accessor
fillOpacityInactive 0.3 number Fill Opacity Inactive accessor
fillInactive #000 string Fill Inactive accessor
stroke (Datum) => string or string Stroke color accessor
strokeInactive transparent string Stroke Inactive accessor
strokeOpacity (Datum) => number or number Stroke Opacity accessor
strokeOpacityInactive 0.3 number Stroke Opacity Inactive accessor
strokeInactive transparent string Stroke Inactive accessor
spacing Math.min(Math.min(width, height), 2000) * 0.015 number Spacing between points
getSpiralCoords (size: { width: number; height: number; }) => Array<{x: number, y: number}> Optional function to manually compute data points position
center {x: width / 2, y: height / 2} {x: number, y: number} Center of the dataviz
tooltip (Datum) => string Return HTML or text as a string to show on element mouseover

Package Sidebar

Install

npm i @datalith/spiral

Weekly Downloads

0

Version

0.12.1

License

MIT

Unpacked Size

14.6 kB

Total Files

5

Last publish

Collaborators

  • lucafalasco