Components Interactions Examples Tutorials API FAQ
Options
Menu

Module Plottable

Index

Type aliases

AppliedProjector

AppliedProjector: function

A function that generates attribute values from the datum and index. Essentially a Projector with a particular Dataset rolled in.

Type declaration

    • (datum: any, index: number): any
    • Parameters

      • datum: any
      • index: number

      Returns any

AttributeToAppliedProjector

AttributeToAppliedProjector: object

A mapping from attributes to the AppliedProjectors used to generate them.

Type declaration

AttributeToProjector

AttributeToProjector: object

A mapping from attributes ("x", "fill", etc.) to the functions that get that information out of the data.

Type declaration

AxisOrientation

AxisOrientation: "bottom" | "left" | "right" | "top"

Bounds

Bounds: object

The corners of a box.

Type declaration

ClickCallback

ClickCallback: function

Type declaration

    • (point: Point, event: MouseEvent | TouchEvent): void
    • Parameters

      • point: Point
      • event: MouseEvent | TouchEvent

      Returns void

ComponentCallback

ComponentCallback: function

Type declaration

DatasetCallback

DatasetCallback: function

Type declaration

DragBoxCallback

DragBoxCallback: function

Type declaration

    • Parameters

      Returns void

DragCallback

DragCallback: function

Type declaration

Formatter

Formatter: function

Type declaration

    • (d: any): string
    • Parameters

      • d: any

      Returns string

IResizeHandler

IResizeHandler: function

Type declaration

    • (size: object): void
    • Parameters

      • size: object
        • height: number
        • width: number

      Returns void

KeyCallback

KeyCallback: function

Type declaration

    • (keyCode: number): void
    • Parameters

      • keyCode: number

      Returns void

Point

Point: object

A location in pixel-space.

Type declaration

  • x: number
  • y: number

PointerCallback

PointerCallback: function

Type declaration

    • Parameters

      Returns void

Projector

Projector: function

Retrieves a scaled datum property. Essentially passes the result of an Accessor through a Scale.

Type declaration

    • (datum: any, index: number, dataset: Dataset): any
    • Parameters

      • datum: any
      • index: number
      • dataset: Dataset

      Returns any

Range

Range: object

Min and max values for a particular property.

Type declaration

  • max: number
  • min: number

SpaceRequest

SpaceRequest: object

Space request used during layout negotiation.

member

{number} minWidth The minimum acceptable width given the offered space.

member

{number} minHeight the minimum acceptable height given the offered space.

Type declaration

  • minHeight: number
  • minWidth: number

SymbolFactory

SymbolFactory: function

A SymbolFactory is a function that takes in a symbolSize which is the edge length of the render area and returns a string representing the 'd' attribute of the resultant 'path' element

Type declaration

    • (symbolSize: number): string
    • Parameters

      • symbolSize: number

      Returns string

TransformableScale

TransformableScale: TransformableScale<D, R>

Variables

version

version: string

Generated using TypeDoc