UI Widget Toolkit
Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides basic functionality (getters & setters) for an axis. This class should not be used directly Classes should be derived from this one to implement different types of axes.

Hierarchy

  • D3Axis

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • new D3Axis(svg: Selection<d3.BaseType, __type, d3.BaseType, any>, renderAxis: IAxis, rect: Rect): D3Axis

Properties

Protected _formatter

_formatter: function

Type declaration

    • (d: any): string

    • Parameters

      • d: any

      Returns string

Methods

appendDomain

  • appendDomain(newVals: any[], level?: number): D3Axis

commitRange

  • commitRange(pixels: number): D3Axis

  • Sets the range maximum (assumes that the range minimum is 0). Creates the d3 scale and axis, completing the axis' initialization. Assumes that the domain has been set.

    Parameters

    • pixels: number

      The max range for the axis.

    Returns D3Axis

    • The axis instance

getAxis

getDomain

  • getDomain(level?: number): any[]

getLevelCount

  • getLevelCount(): number

getPosition

  • getPosition(): Rect

getRangePixels

  • getRangePixels(): number

getRenderedRect

  • getRenderedRect(): Rect

getScale

  • getScale(level?: number): any

  • get the d3 scale for the given level of this axis

    Parameters

    • Default value level: number = 0

    Returns any

    the d3 scale helper

isBanded

  • isBanded(): boolean

  • Return whether axis is banded (for bar graphs) or not (for point graphs). Returns false for linear axes.

    Returns boolean

    • True if this is a banded ordinal axis

mapCoordinateToValue

  • mapCoordinateToValue(coordinate: number): any

  • Map a value in the range (pixels) to the domain

    Parameters

    • coordinate: number

      The value in the range to be mapped to the domain

    Returns any

    • The value in the domain

render

  • render(): void

saveState

  • saveState(): void

setBanded

  • setBanded(isBanded: boolean): void

setDomain

  • setDomain(domain: any[], level?: number): D3Axis

setKeysPerDomain

  • setKeysPerDomain(keyCount: number): void

  • if you have a banded range there may be multiple bars per domain entry

    Parameters

    • keyCount: number

    Returns void

setPosition

  • setPosition(pos: Rect): void

setRangePixels

  • setRangePixels(pixels: number): D3Axis

setScale

  • setScale(scale: AxisScale<any>, level?: number): any

  • get the d3 scale for the given level of this axis

    Parameters

    • scale: AxisScale<any>
    • Default value level: number = 0

    Returns any

    the d3 scale helper

Object literals

Protected cache

cache: object

domain

domain: any[] = new Array()

pixels

pixels: number = -1

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • 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