Components Interactions Examples Tutorials API FAQ
Options
Menu

Type parameters

  • D

Hierarchy

Index

Constructors

constructor

Properties

Protected _boundingBox

_boundingBox: Selection<void>

Protected _clipPathEnabled

_clipPathEnabled: boolean

Private _guideLine

_guideLine: any

Protected _isAnchored

_isAnchored: boolean

Protected _isSetup

_isSetup: boolean

Private _mode

_mode: any

Private _orientation

_orientation: any

Private _pixelPosition

_pixelPosition: any

Private _scale

_scale: any

Private _scaleUpdateCallback

_scaleUpdateCallback: any

Private _value

_value: any

Static ORIENTATION_HORIZONTAL

ORIENTATION_HORIZONTAL: string

Static ORIENTATION_VERTICAL

ORIENTATION_VERTICAL: string

Methods

Protected _isVertical

  • _isVertical(): boolean

Protected _setPixelPositionWithoutChangingMode

  • _setPixelPositionWithoutChangingMode(pixelPosition: number): void

Protected _setup

  • _setup(): void

Protected _sizeFromOffer

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

Private _syncPixelPositionAndValue

  • _syncPixelPositionAndValue(): any

addClass

  • addClass(cssClass: string)

anchor

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

destroy

  • destroy(): void

detach

  • detach()
  • Detaches a Component from the DOM. The Component can be reused.

    This should only be used if you plan on reusing the calling Component. Otherwise, use destroy().

fixedHeight

  • fixedHeight(): boolean

fixedWidth

  • fixedWidth(): 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

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

pixelPosition

  • pixelPosition(): number
  • pixelPosition(pixelPosition: number)
  • Gets the position of the guide line in pixel-space.

    Returns number

  • Sets the position of the guide line in pixel-space. If the GuideLineLayer has a scale, the value() will be updated now and whenever the scale updates.

    Parameters

    • pixelPosition: number

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)

render

  • render()

renderImmediately

  • renderImmediately()

renderTo

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

requestedSpace

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

scale

  • Gets the QuantitativeScale on the GuideLineLayer.

    Returns QuantitativeScale<D>

  • Sets the QuantitativeScale on the GuideLineLayer. If value() was the last property set, pixelPosition() will be updated according to the new scale. If pixelPosition() was the last property set, value() will be updated according to the new scale.

    Parameters

value

  • value(): D
  • value(value: D)
  • Gets the value of the guide line in data-space.

    Returns D

  • Sets the value of the guide line in data-space. If the GuideLineLayer has a scale, pixelPosition() will be updated now and whenever the scale updates.

    Parameters

    • value: D

width

  • width(): number

xAlignment

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

yAlignment

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

Generated using TypeDoc