Logo for jsDocs.io

@types/d3-ease

  • Version 3.0.2
  • Published
  • 13.4 kB
  • No dependencies
  • MIT license

Install

npm i @types/d3-ease
yarn add @types/d3-ease
pnpm add @types/d3-ease

Overview

TypeScript definitions for d3-ease

Index

Variables

Functions

Interfaces

Variables

variable easeBack

const easeBack: BackEasingFactory;

  • Symmetric anticipatory easing; scales backIn for t in [0, 0.5] and backOut for t in [0.5, 1]. The degree of overshoot is configurable; it not specified, it defaults to 1.70158.

variable easeBackIn

const easeBackIn: BackEasingFactory;

  • Anticipatory easing, like a dancer bending their knees before jumping off the floor. The degree of overshoot is configurable; it not specified, it defaults to 1.70158.

variable easeBackInOut

const easeBackInOut: BackEasingFactory;

  • Symmetric anticipatory easing; scales backIn for t in [0, 0.5] and backOut for t in [0.5, 1]. The degree of overshoot is configurable; it not specified, it defaults to 1.70158.

variable easeBackOut

const easeBackOut: BackEasingFactory;

  • Reverse anticipatory easing; equivalent to 1 - backIn(1 - t). The degree of overshoot is configurable; it not specified, it defaults to 1.70158.

variable easeElastic

const easeElastic: ElasticEasingFactory;

  • Reverse elastic easing; equivalent to 1 - elasticIn(1 - t). The amplitude and period of the oscillation are configurable; if not specified, they default to 1 and 0.3, respectively.

variable easeElasticIn

const easeElasticIn: ElasticEasingFactory;

  • Elastic easing, like a rubber band. The amplitude and period of the oscillation are configurable; if not specified, they default to 1 and 0.3, respectively.

variable easeElasticInOut

const easeElasticInOut: ElasticEasingFactory;

  • Symmetric elastic easing; scales elasticIn for t in [0, 0.5] and elasticOut for t in [0.5, 1]. The amplitude and period of the oscillation are configurable; if not specified, they default to 1 and 0.3, respectively.

variable easeElasticOut

const easeElasticOut: ElasticEasingFactory;

  • Reverse elastic easing; equivalent to 1 - elasticIn(1 - t). The amplitude and period of the oscillation are configurable; if not specified, they default to 1 and 0.3, respectively.

variable easePoly

const easePoly: PolynomialEasingFactory;

  • Symmetric polynomial easing/easing factory; scales polyIn for t in [0, 0.5] and polyOut for t in [0.5, 1]. If the exponent is not specified, it defaults to 3, equivalent to cubic.

variable easePolyIn

const easePolyIn: PolynomialEasingFactory;

  • Polynomial easing/easing factory; raises t to the specified exponent. If the exponent is not specified, it defaults to 3, equivalent to cubicIn.

variable easePolyInOut

const easePolyInOut: PolynomialEasingFactory;

  • Symmetric polynomial easing/easing factory; scales polyIn for t in [0, 0.5] and polyOut for t in [0.5, 1]. If the exponent is not specified, it defaults to 3, equivalent to cubic.

variable easePolyOut

const easePolyOut: PolynomialEasingFactory;

  • Reverse polynomial easing/easing factory; equivalent to 1 - polyIn(1 - t). If the exponent is not specified, it defaults to 3, equivalent to cubicOut.

Functions

function easeBounce

easeBounce: (normalizedTime: number) => number;

  • Reverse bounce easing; equivalent to 1 - bounceIn(1 - t).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeBounceIn

easeBounceIn: (normalizedTime: number) => number;

  • Bounce easing, like a rubber ball.

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeBounceInOut

easeBounceInOut: (normalizedTime: number) => number;

  • Symmetric bounce easing; scales bounceIn for t in [0, 0.5] and bounceOut for t in [0.5, 1].

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeBounceOut

easeBounceOut: (normalizedTime: number) => number;

  • Reverse bounce easing; equivalent to 1 - bounceIn(1 - t).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCircle

easeCircle: (normalizedTime: number) => number;

  • Symmetric circular easing; scales circleIn for t in [0, 0.5] and circleOut for t in [0.5, 1].

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCircleIn

easeCircleIn: (normalizedTime: number) => number;

  • Circular easing.

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCircleInOut

easeCircleInOut: (normalizedTime: number) => number;

  • Symmetric circular easing; scales circleIn for t in [0, 0.5] and circleOut for t in [0.5, 1].

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCircleOut

easeCircleOut: (normalizedTime: number) => number;

  • Reverse circular easing; equivalent to 1 - circleIn(1 - t).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCubic

easeCubic: (normalizedTime: number) => number;

  • Symmetric cubic easing; scales cubicIn for t in [0, 0.5] and cubicOut for t in [0.5, 1]. Also equivalent to poly.exponent(3).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCubicIn

easeCubicIn: (normalizedTime: number) => number;

  • Cubic easing; equivalent to polyIn.exponent(3).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCubicInOut

easeCubicInOut: (normalizedTime: number) => number;

  • Symmetric cubic easing; scales cubicIn for t in [0, 0.5] and cubicOut for t in [0.5, 1]. Also equivalent to poly.exponent(3).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeCubicOut

easeCubicOut: (normalizedTime: number) => number;

  • Reverse cubic easing; equivalent to 1 - cubicIn(1 - t). Also equivalent to polyOut.exponent(3).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeExp

easeExp: (normalizedTime: number) => number;

  • Symmetric exponential easing; scales expIn for t in [0, 0.5] and expOut for t in [0.5, 1].

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeExpIn

easeExpIn: (normalizedTime: number) => number;

  • Exponential easing; raises 2 to the exponent 10 * (t - 1).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeExpInOut

easeExpInOut: (normalizedTime: number) => number;

  • Symmetric exponential easing; scales expIn for t in [0, 0.5] and expOut for t in [0.5, 1].

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeExpOut

easeExpOut: (normalizedTime: number) => number;

  • Reverse exponential easing; equivalent to 1 - expIn(1 - t).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeLinear

easeLinear: (normalizedTime: number) => number;

  • Linear easing; the identity function; linear(t) returns t.

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeQuad

easeQuad: (normalizedTime: number) => number;

  • Symmetric quadratic easing; scales quadIn for t in [0, 0.5] and quadOut for t in [0.5, 1]. Also equivalent to poly.exponent(2).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeQuadIn

easeQuadIn: (normalizedTime: number) => number;

  • Quadratic easing; equivalent to polyIn.exponent(2).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeQuadInOut

easeQuadInOut: (normalizedTime: number) => number;

  • Symmetric quadratic easing; scales quadIn for t in [0, 0.5] and quadOut for t in [0.5, 1]. Also equivalent to poly.exponent(2).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeQuadOut

easeQuadOut: (normalizedTime: number) => number;

  • Reverse quadratic easing; equivalent to 1 - quadIn(1 - t). Also equivalent to polyOut.exponent(2).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeSin

easeSin: (normalizedTime: number) => number;

  • Symmetric sinusoidal easing; scales sinIn for t in [0, 0.5] and sinOut for t in [0.5, 1].

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeSinIn

easeSinIn: (normalizedTime: number) => number;

  • Sinusoidal easing; returns sin(t).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeSinInOut

easeSinInOut: (normalizedTime: number) => number;

  • Symmetric sinusoidal easing; scales sinIn for t in [0, 0.5] and sinOut for t in [0.5, 1].

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

function easeSinOut

easeSinOut: (normalizedTime: number) => number;

  • Reverse sinusoidal easing; equivalent to 1 - sinIn(1 - t).

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

Interfaces

interface BackEasingFactory

interface BackEasingFactory {}

  • Anticipatory easing function factory

method overshoot

overshoot: (s: number) => BackEasingFactory;

  • Returns a new back easing with the specified overshoot s. The degree of overshoot is configurable; if not specified, it defaults to 1.70158.

    Parameter s

    Overshoot parameter

call signature

(normalizedTime: number): number;

  • Calculate eased time.

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

interface ElasticEasingFactory

interface ElasticEasingFactory {}

  • Elastic easing function factory

method amplitude

amplitude: (a: number) => ElasticEasingFactory;

  • Returns a new elastic easing with the specified amplitude a. Defaults to 1,if not specified.

    Parameter a

    Amplitude for elastic easing.

method period

period: (p: number) => ElasticEasingFactory;

  • Returns a new elastic easing with the specified amplitude a. Defaults to 0.3,if not specified.

    Parameter p

    Period for elastic easing.

call signature

(normalizedTime: number): number;

  • Calculate eased time.

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

interface PolynomialEasingFactory

interface PolynomialEasingFactory {}

  • Polynomial easing function factory

method exponent

exponent: (e: number) => PolynomialEasingFactory;

  • Returns a new polynomial easing with the specified exponent e. If the exponent is not specified, it defaults to 3, equivalent to cubic.

    Parameter e

    Exponent for polynomial easing.

call signature

(normalizedTime: number): number;

  • Calculate eased time.

    Parameter normalizedTime

    Normalized time typically in the range [0, 1]

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/d3-ease.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/d3-ease)
  • HTML
    <a href="https://www.jsdocs.io/package/@types/d3-ease"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>