0.0.161 • Published 6 years ago

@pqmcgill/curve v0.0.161

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

@vx/curve

npm install --save @vx/curve

Overview

A curve is a function that can be passed into other vx objects, mainly a LinePath to change the way the line is structured.

For example, checkout the difference between a Curve.natural:

natural curve

and a Curve.step:

step curve

The @vx/curve package is a wrapper over d3-shape curve functions.

Any function with the prefix curve in d3 can be used through vx like so:

import { curveCatmullRomOpen } from '@vx/curve';
let line = (<Shape.LinePath curve={curveCatmullRomOpen} />)

// or if you want namespace all Curves under the `Curve`
import * as Curve from `@vx/curve`;
let line = (<Shape.LinePath curve={Curve.curveCatmullRomOpen} />)

Functions

vxd3
curveBasiscurveBasis
curveBasisClosecurveBasisClosed
curveBasisOpencurveBasisOpen
curveStepcurveStep
curveStepAftercurveStepAfter
curveStepBeforecurveStepbefore
curveBundlecurveBundle
curveLinearcurveLinear
curveLinearClosedcurveLinearClosed
curveMonotoneXcurveMonotoneX
curveMonotoneYcurveMonotoneY
curveCardinalcurveCardinal
curveCardinalClosedcurveCardinalClosed
curveCardinalOpencurveCardinalOpen
curveCatmullRomcurveCatmullRom
curveCatmullRomClosedcurveCatmullRomClosed
curveCatmullRomOpencurveCatmullRomOpen
curveNaturalcurveNatural