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

the combination of axis definition and rendering information needed to render this axis

Hierarchy

Index

Properties

Properties

alignment

alignment: Alignment

defines whether an axis is top/bottom/left/right

Optional api

api: object

Type declaration

  • Optional brush?: function

    fire a brush event for this element

    param

    any event to pass to the renderer

      • Parameters

        Returns void

  • Optional createImage?: function
      • (): void

      • Returns void

  • Optional cursorChange?: function

    fire a mouse/touch change event for this element

    param

    any event to pass to the renderer

      • Parameters

        Returns void

  • Optional focus?: function

    fire a focus event for this element

    param

    any event to pass to the renderer

      • Parameters

        Returns void

  • Optional getOptions?: function
  • Optional hover?: function
    deprecated

    ('Deprecated since 1.14.0 in favor of focus. Will be removed in 2.x') fire a hover event for this element

    param

    any event to pass to the renderer

      • Parameters

        Returns void

  • Optional pan?: function

    pan to a given event location

      • Parameters

        Returns void

  • Optional render?: function

    Render the element.

    param

    an IRenderer object that can render this element

    param

    any options to pass to the renderer

  • Optional saveImage?: function
      • (): void

      • Returns void

  • Optional select?: function

    fire a select event for this element

    param

    any event to pass to the renderer

      • Parameters

        Returns void

  • Optional zoom?: function

    fire a zoom event for this element

    param

    any event to pass to the renderer

      • Parameters

        Returns void

axisDesc

axisDesc: IAxisDescription

defines what data to represent in the axis

Optional css

css: ICss

any special CSS to hardcode for this axis

Optional enableDynamicRange

enableDynamicRange: boolean

used for Y axis if you want the range to autoscale as you zoom in and out

Optional getElements

getElements: function

get all elements associated with the render call of this UIElement

Type declaration

Optional getTooltip

getTooltip: function

get tooltip data for the element

param

any event to pass to the renderer

Type declaration

Optional handleUpdate

handleUpdate: function

Type declaration

Optional hidden

hidden: boolean

an axis may be hidden if it is just being used to scale the data

Optional manager

manager: UIElementManager

Optional onBrush

onBrush: function

callback when a brush action occurs in this element

param

the event related to this callback

Type declaration

    • Parameters

      Returns void

Optional onClick

onClick: function

callback when user clicks on an item

Type declaration

    • Parameters

      Returns void

Optional onCursorChanged

onCursorChanged: function

callback when the cursor change occurs in this element

param

the event related to this callback

Type declaration

    • Parameters

      Returns void

Optional onDoubleClick

onDoubleClick: function

the callback when an item in this data is double clicked

param

contains the data for the item that was clicked

Type declaration

    • Parameters

      Returns void

Optional onHover

onHover: function

callback when a hover occurs in this element

param

the event related to this callback

Type declaration

    • Parameters

      Returns void

Optional onRender

onRender: function

callback when a re-render occurs in this element

param

the options used when render was called

Type declaration

Optional onTooltip

onTooltip: function

callback when a tooltip occurs in this element

param

the event related to this callback

Type declaration

Optional onZoom

onZoom: function

callback when a zoom action occurs in this element

param

the event related to this callback

Type declaration

    • Parameters

      Returns void

Optional options

options: IAxisOptions

any misc options to configure the axis

Optional renderer

renderer: UIRenderer

Optional type

type: UIType

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