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

Hierarchy

Index

Properties

Properties

Optional api

api: object

once the chart is rendered this API object is filled with callbacks to interact with the chart

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

    creates and image and loads it into memory

      • (): 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 hover?: function
    deprecated

    Deprecated in favor of focus 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 panLeft?: function

    pan left by one step

      • (): void

      • Returns void

  • Optional panRight?: function

    pan right by one step

      • (): void

      • Returns void

  • Optional rangeReset?: function

    reset the X range of the chart to default values, works only with 1 x axis

      • (): void

      • Returns void

  • Optional rangeUpdate?: function

    limit the X range of the chart, works only with 1 x axis

      • Parameters

        Returns void

  • Optional render?: function

    re-render the chart

  • Optional saveImage?: function

    createImage is triggered and prompts the user to save it via the browser save dialog

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

  • Optional zoomIn?: function

    zoom in by one step

      • (): void

      • Returns void

  • Optional zoomOut?: function

    zoom out by one step

      • (): void

      • Returns void

  • Optional zoomReset?: function

    reset the zoom for the chart to the original value

      • (): void

      • Returns void

Optional category

category: string

Optional contextMenuItems

contextMenuItems: IContextMenuItem[]

context menu items that will be added to the context menu

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 legend

legend: ILegend

the legend for this chart

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 arc

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

a callback that will be fired when the tooltip is triggered

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: IOptions

Optional renderer

renderer: UIRenderer

Optional title

title: string

a title for this chart that may be displayed

Optional type

type: UIType

Optional units

units: string

units string

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