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

Index

Type aliases

BrushSelection

BrushSelection: [[number, number], [number, number]] | [number, number]

Type alias for a BrushSelection. For a two-dimensional brush, it must be defined as [[x0, y0], [x1, y1]], where x0 is the minimum x-value, y0 is the minimum y-value, x1 is the maximum x-value, and y1 is the maximum y-value. For an x-brush, it must be defined as [x0, x1]; for a y-brush, it must be defined as [y0, y1].

Functions

brush

  • Create a new two-dimensional brush.

    The generic "Datum" refers to the type of the data of the selected svg:g element to which the returned BrushBEhavoir will be applied.

    Type parameters

    • Datum

    Returns BrushBehavior<Datum>

brushSelection

  • Return the current brush selection for the specified node. Internally, an element’s brush state is stored as element.__brush; however, you should use this method rather than accessing it directly. If the given node has no selection, returns null. Otherwise, the selection is defined as an array of numbers.

    Parameters

    • node: SVGGElement

      The node for which the brush selection should be returned.

    Returns BrushSelection | null

brushX

  • Creates a new one-dimensional brush along the x-dimension.

    The generic "Datum" refers to the type of the data of the selected svg:g element to which the returned BrushBEhavoir will be applied.

    Type parameters

    • Datum

    Returns BrushBehavior<Datum>

brushY

  • Creates a new one-dimensional brush along the y-dimension.

    The generic "Datum" refers to the type of the data of the selected svg:g element to which the returned BrushBEhavoir will be applied.

    Type parameters

    • Datum

    Returns BrushBehavior<Datum>

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