WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Modules

Interfaces

Functions

Functions

active

  • active<GElement, Datum, PElement, PDatum>(node: GElement, name?: string): Transition<GElement, Datum, PElement, PDatum> | null
  • Return the active transition on the specified node with the specified name, if any. If no name is specified, null is used. Returns null if there is no such active transition on the specified node. This method is useful for creating chained transitions.

    The first generic "GElement" refers to the type of element on which the returned active transition was defined. The second generic "Datum" refers to the type of the datum, of a selected element on which the transition is defined. The third generic refers to the type of the parent elements in the returned Transition. The fourth generic refers to the type of the datum defined on the parent elements in the returned Transition.

    Type parameters

    Parameters

    • node: GElement

      Element for which the active transition should be returned.

    • Optional name: string

      Name of the transition.

    Returns Transition<GElement, Datum, PElement, PDatum> | null

interrupt

  • interrupt(node: BaseType, name?: string): void
  • Interrupts the active transition of the specified name on the specified node, and cancels any pending transitions with the specified name, if any. If a name is not specified, null is used.

    Parameters

    • node: BaseType

      Element for which the transition should be interrupted.

    • Optional name: string

      Name of the transition to be interrupted. If a name is not specified, null is used.

    Returns void

transition

  • Returns a new transition with the specified name. If a name is not specified, null is used. The new transition is only exclusive with other transitions of the same name.

    The generic "OldDatum" refers to the type of a previously-set datum of the selected HTML element in the Transition.

    Type parameters

    • OldDatum

    Parameters

    • name: string

      Name of the transition.

    Returns Transition<HTMLElement, OldDatum, null, undefined>

  • Returns a new transition from an existing transition.

    When using a transition instance, the returned transition has the same id and name as the specified transition.

    The generic "OldDatum" refers to the type of a previously-set datum of the selected HTML element in the Transition.

    Type parameters

    • OldDatum

    Parameters

    Returns Transition<HTMLElement, OldDatum, null, undefined>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc