Components Interactions Examples Tutorials API FAQ
Options
Menu

Class SelectionBoxLayer

Hierarchy

Index

Constructors

constructor

Properties

Private _adjustBoundsCallback

_adjustBoundsCallback: any

Protected _boundingBox

_boundingBox: Selection<void>

Protected _box

_box: Selection<void>

Private _boxArea

_boxArea: any

Private _boxBounds

_boxBounds: any

Private _boxVisible

_boxVisible: any

Protected _clipPathEnabled

_clipPathEnabled: boolean

Protected _isAnchored

_isAnchored: boolean

Protected _isSetup

_isSetup: boolean

Protected _xBoundsMode

_xBoundsMode: PropertyMode

Private _xExtent

_xExtent: any

Private _xScale

_xScale: any

Protected _yBoundsMode

_yBoundsMode: PropertyMode

Private _yExtent

_yExtent: any

Private _yScale

_yScale: any

Methods

Private _getBounds

  • _getBounds(): any

Private _getXExtent

  • _getXExtent(): any

Private _getYExtent

  • _getYExtent(): any

Protected _setBounds

  • _setBounds(newBounds: Bounds): void

Protected _setXExtent

  • _setXExtent(xExtent: number | object): void

Protected _setYExtent

  • _setYExtent(yExtent: number | object): void

Protected _setup

  • _setup(): void

Protected _sizeFromOffer

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

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

boxVisible

  • boxVisible(): boolean
  • boxVisible(show: boolean)
  • Gets whether the box is being shown.

    Returns boolean

  • Shows or hides the selection box.

    Parameters

    • show: boolean

      Whether or not to show the box.

computeLayout

  • computeLayout(origin?: Point, availableWidth?: number, availableHeight?: number)
  • Computes and sets the size, position, and alignment of the Component from the specified values. If no parameters are supplied and the Component is a root node, they are inferred from the size of the Component's element.

    Parameters

    • Optional origin: Point
    • Optional availableWidth: number
    • Optional 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

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

width

  • width(): number

xAlignment

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

xExtent

  • xExtent(): number | object
  • xExtent(xExtent: number | object)
  • Gets the data values backing the left and right edges of the box.

    Returns an undefined array if the edges are not backed by a scale.

    Returns number | object

  • Sets the data values backing the left and right edges of the box.

    Parameters

    • xExtent: number | object

xScale

yAlignment

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

yExtent

  • yExtent(): number | object
  • yExtent(yExtent: number | object)
  • Gets the data values backing the top and bottom edges of the box.

    Returns an undefined array if the edges are not backed by a scale.

    Returns number | object

  • Sets the data values backing the top and bottom edges of the box.

    Parameters

    • yExtent: number | object

yScale

Generated using TypeDoc