Components Interactions Examples Tutorials API FAQ
Options
Menu

Type parameters

  • X

Hierarchy

Index

Constructors

constructor

Properties

Protected _boundingBox

_boundingBox: Selection<void>

Protected _clipPathEnabled

_clipPathEnabled: boolean

Private _constantBaselineValueProvider

_constantBaselineValueProvider: any

Protected _isAnchored

_isAnchored: boolean

Protected _isSetup

_isSetup: boolean

Private _lineDrawers

_lineDrawers: any

Protected _propertyBindings

_propertyBindings: Map<AccessorScaleBinding<any, any>>

Protected _propertyExtents

_propertyExtents: Map<any[]>

Protected _renderArea

_renderArea: Selection<void>

Protected _renderCallback

_renderCallback: ScaleCallback<Scale<any, any>>

Static Protected _ANIMATION_MAX_DURATION

_ANIMATION_MAX_DURATION: number

Static Protected _X_KEY

_X_KEY: string

Static Private _Y0_KEY

_Y0_KEY: any

Static Protected _Y_KEY

_Y_KEY: string

Methods

Protected _addDataset

Protected _additionalPaint

  • _additionalPaint(): void

Protected _animateOnNextRender

  • _animateOnNextRender(): boolean

Protected _bindProperty

  • _bindProperty(property: string, value: any, scale: Scale<any, any>): void

Protected _buildLightweightPlotEntities

Protected _constructAreaProjector

Protected _constructLineProjector

Protected _createDrawer

Protected _createNodesForDataset

Protected _entityVisibleOnPlot

Protected _extentsForProperty

  • _extentsForProperty(property: string): any[]

Protected _filterForProperty

  • _filterForProperty(property: string): function

Protected _generateAttrToProjector

  • _generateAttrToProjector(): object

Protected _generateDrawSteps

Private _generateLineAttrToProjector

  • _generateLineAttrToProjector(): any

Private _generateLineDrawSteps

  • _generateLineDrawSteps(): any

Protected _getAnimator

Protected _getDataToDraw

Protected _getDrawersInOrder

  • _getDrawersInOrder(): Drawer[]

Protected _getResetYFunction

Protected _installScaleForKey

  • _installScaleForKey(scale: Scale<any, any>, key: string): void

Protected _invertPixelPoint

  • _invertPixelPoint converts a point in pixel coordinates to a point in data coordinates

    Parameters

    • point: Point

      Representation of the point in pixel coordinates

    Returns Point

    Returns the point represented in data coordinates

Protected _onDatasetUpdate

  • _onDatasetUpdate(): void

Protected _pixelPoint

  • _pixelPoint(datum: any, index: number, dataset: Dataset): Point

Protected _projectorsReady

  • _projectorsReady(): boolean

Protected _propertyProjectors

Protected _removeDataset

Protected _removeDatasetNodes

  • _removeDatasetNodes(dataset: Dataset): void

Protected _setup

  • _setup(): void

Protected _sizeFromOffer

  • _sizeFromOffer(availableWidth: number, availableHeight: number): object

Protected _uninstallScaleForKey

  • _uninstallScaleForKey(scale: Scale<any, any>, key: string): void

Protected _updateExtents

  • _updateExtents(): void

Protected _updateExtentsForProperty

  • _updateExtentsForProperty(property: string): void

Protected _updateYScale

  • _updateYScale(): void

addClass

  • addClass(cssClass: string)

addDataset

anchor

animated

  • animated(): boolean
  • animated(willAnimate: boolean)

animator

  • animator(animatorKey: string): Animator
  • animator(animatorKey: string, animator: Animator)

attr

  • Gets the AccessorScaleBinding for a particular attribute.

    Type parameters

    • A

    Parameters

    • attr: string

    Returns AccessorScaleBinding<A, number | string>

  • Sets a particular attribute to a constant value or the result of an Accessor.

    Parameters

  • Sets a particular attribute to a scaled constant value or scaled result of an Accessor. The provided Scale will account for the attribute values when autoDomain()-ing.

    Type parameters

    • A

    Parameters

    • attr: string
    • attrValue: A | Accessor<A>
    • scale: Scale<A, number | string>

      The Scale used to scale the attrValue.

autorangeMode

  • autorangeMode(): string
  • autorangeMode(autorangeMode: string)

autorangeSmooth

  • autorangeSmooth(): boolean
  • autorangeSmooth(autorangeSmooth: boolean)
  • Gets whether or not the autoranging is done smoothly.

    Returns boolean

  • Sets whether or not the autorange is done smoothly.

    Smooth autoranging is done by making sure lines always exit on the left / right side of the plot and deactivating the nice domain feature on the scales

    Parameters

    • autorangeSmooth: boolean

background

  • Gets the Selection containing the behind the visual elements of the Component.

    Will return undefined if the Component has not been anchored.

    Returns Selection<void>

    background selection for the Component

bounds

  • Returns Bounds

    for the component in pixel space, where the topLeft represents the component's minimum x and y values and the bottomRight represents the component's maximum x and y values.

computeLayout

  • computeLayout(origin?: Point, availableWidth?: number, availableHeight?: number)

content

  • Gets a Selection containing a that holds the visual elements of the Component.

    Will return undefined if the Component has not been anchored.

    Returns Selection<void>

    content selection for the Component

croppedRenderingEnabled

  • croppedRenderingEnabled(): boolean
  • croppedRenderingEnabled(croppedRendering: boolean)

datasets

deferredRendering

  • deferredRendering(): boolean
  • deferredRendering(deferredRendering: boolean)
  • Returns the whether or not the rendering is deferred for performance boost.

    Returns boolean

    The deferred rendering option

  • Sets / unsets the deferred rendering option Activating this option improves the performance of plot interaction (pan / zoom) by performing lazy renders, only after the interaction has stopped. Because re-rendering is no longer performed during the interaction, the zooming might experience a small resolution degradation, before the lazy re-render is performed.

    This option is intended for cases where performance is an issue.

    Parameters

    • deferredRendering: boolean

destroy

  • destroy()

detach

  • detach()

downsamplingEnabled

  • downsamplingEnabled(): boolean
  • downsamplingEnabled(downsampling: boolean)

entities

  • Gets the Entities associated with the specified Datasets.

    Parameters

    • Optional datasets: Dataset[]

      The Datasets to retrieve the Entities for. If not provided, returns defaults to all Datasets on the Plot.

    Returns PlotEntity[]

entitiesAt

entitiesIn

entityNearest

entityNearestByXThenY

  • Returns the PlotEntity nearest to the query point by X then by Y, or undefined if no PlotEntity can be found.

    Parameters

    Returns PlotEntity

    The nearest PlotEntity, or undefined if no PlotEntity can be found.

fixedHeight

  • fixedHeight(): boolean
  • Checks if the Component has a fixed height or if it grows to fill available space. Returns false by default on the base Component class.

    Returns boolean

fixedWidth

  • fixedWidth(): boolean
  • Checks if the Component has a fixed width or if it grows to fill available space. Returns false by default on the base Component class.

    Returns boolean

foreground

  • Gets the Selection containing the in front of the visual elements of the Component.

    Will return undefined if the Component has not been anchored.

    Returns Selection<void>

hasClass

  • hasClass(cssClass: string): boolean
  • Checks if the Component has a given CSS class.

    Parameters

    • cssClass: string

      The CSS class to check for.

    Returns boolean

height

  • height(): number

interpolator

  • interpolator(): string | function
  • interpolator(interpolator: string | function)
  • interpolator(interpolator: "linear")
  • interpolator(interpolator: "linear-closed")
  • interpolator(interpolator: "step")
  • interpolator(interpolator: "step-before")
  • interpolator(interpolator: "step-after")
  • interpolator(interpolator: "basis")
  • interpolator(interpolator: "basis-open")
  • interpolator(interpolator: "basis-closed")
  • interpolator(interpolator: "bundle")
  • interpolator(interpolator: "cardinal")
  • interpolator(interpolator: "cardinal-open")
  • interpolator(interpolator: "cardinal-closed")
  • interpolator(interpolator: "monotone")

offAnchor

offDetach

onAnchor

onDetach

onResize

  • Sets a callback that gets called when the component resizes. The size change is not guaranteed to be reflected by the DOM at the time the callback is fired.

    Parameters

origin

originToSVG

parent

redraw

  • redraw()
  • Causes the Component to re-layout and render.

    This function should be called when a CSS change has occured that could influence the layout of the Component, such as changing the font size.

removeClass

  • removeClass(cssClass: string)

removeDataset

render

  • render()

renderImmediately

  • renderImmediately()

renderTo

  • renderTo(element: String | Element | Selection<void>)

requestedSpace

  • requestedSpace(availableWidth: number, availableHeight: number): SpaceRequest

selections

showAllData

  • showAllData()
  • Adjusts the domains of both X and Y scales to show all data. This call does not override the autorange() behavior.

width

  • width(): number

x

xAlignment

  • xAlignment(): string
  • xAlignment(xAlignment: string)

y

y0

yAlignment

  • yAlignment(): string
  • yAlignment(yAlignment: string)

Static Protected _scaledAccessor

Generated using TypeDoc