Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SolidGauge

The Gauge Chart with a single solid colored slice.

Solid Gauge extends Radial Gauge. Use GaugeChart.setAngleInterval(start: number, end: number)** to set angular appearance of the Chart.

Before setting the data, request the slice using GaugeChart.getDefaultSlice() Set data range using GaugeChart.setInterval(start: number, end: number) Set data using GaugeChart.setValue(value: number)

Index

Properties

Methods

Properties

Readonly engine

engine : PublicEngine

Public, safe interface for Panels rendering engine.

pixelScale

pixelScale : LinearScaleXY

Scale for panel area in pixels.

uiScale

uiScale : LinearScaleXY

Scale for panel area in percentages (0-100).

Methods

addLegendBox

  • Add a legendbox.

    Legendbox is a type of UI element, that floats inside the chart/component it is created inside. It can be freely moved around with user interactions, as well as positioned in application code.

    The purpose of legendbox is to describe the series and other visual components of the chart, by displaying their names and colors. Hovering over a series' legendbox entry will highlight that series, and clicking on the entry will toggle that series' visibility.

    Legendbox alignment:

    Alignment of legendbox can be selected by supplying one of the available LegendBoxBuilders to addLegendBox:

     // Default (vertical) LegendBox.
     const legendBox = ChartXY.addLegendBox()
    
     // Horizontal LegendBox.
     const horizontalLegendBox = ChartXY.addLegendBox(LegendBoxBuilders.HorizontalLegendBox)
    

    Custom Legendbox positioning:

    By default LegendBoxes are placed on the right side, or bottom of the chart (depending on alignment).

    A custom location can be configured with UIElement API:

    Position coordinate system is specified when creating legendbox.

    1. LegendBox with default positioning coordinate system.
     addLegendBox( LegendBoxBuilders.VerticalLegendBox )
         // Position = [0, 100] as percentages.
         .setPosition({ x: 50, y: 50 })
    
    1. Position in pixel coordinate system.
     addLegendBox( LegendBoxBuilders.VerticalLegendBox, chart.pixelScale )
         // Position = pixels.
         .setPosition({ x: 300, y: 100 })
    
    1. Position on Axes.
     addLegendBox( LegendBoxBuilders.VerticalLegendBox, { x: chartXY.getDefaultAxisX(), y: chartXY.getDefaultAxisY() } )
         // Position = Axis values.
         .setPosition({ x: 5, y: 5 })
    

    Parameters

    • builder: UILegendBoxBuilder

      LegendBoxBuilder. If omitted, VerticalLegendBox will be selected. Use LegendBoxBuilders for selection.

    • scale: UserScaleDefinition

      Optional parameter for altering the coordinate system used for positioning the LegendBox. Defaults to whole Chart in percentages [0, 100].

    Returns LegendBox & UIElement

    Object with two interfaces: LegendBox and UIElement.

addUIElement

  • Add a stand-alone UIElement using a builder.

    Example usage:

    1. TextBox with default positioning coordinate system.
     addUIElement( UIElementBuilders.TextBox )
         // Position = [0, 100] as percentages.
         .setPosition({ x: 50, y: 50 })
    
    1. Position in pixel coordinate system.
     addUIElement( UIElementBuilders.TextBox, chart.pixelScale )
         // Position = pixels.
         .setPosition({ x: 300, y: 100 })
    
    1. Position on Axes.
     addUIElement( UIElementBuilders.TextBox, { x: chartXY.getDefaultAxisX(), y: chartXY.getDefaultAxisY() } )
         // Position = Axis values.
         .setPosition({ x: 5, y: 5 })
    

    Type parameters

    • UIElementType: UIPart = UITextBox

      Type of UIElement that is specified by 'builder'-parameter.

    Parameters

    • builder: UIElementBuilder<UIElementType>

      UIElementBuilder. If omitted, TextBoxBuilder will be selected. Use UIElementBuilders for selection.

    • scale: UserScaleDefinition

      Optional parameter for altering the coordinate system used for positioning the UIElement. Defaults to whole Chart in percentages [0, 100].

    Returns UIElementType & UIElement

    Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

  • disableAnimations(): this
  • Disable all animations for the chart.

    All animations have to be re-enabled individually if you wish to re-enable animations.

    deprecated

    Deprecated in v3.1.0. Will be removed in v4.0.0. Use setAnimationsEnabled instead.

    Returns this

    Chart itself for fluent interface.

dispose

  • dispose(): this
  • Permanently dispose the component.

    To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.

    let chart = ...Gauge()
    let slice = chart.getDefaultSlice()
    // Dispose Chart, and remove all references so that they can be garbage-collected.
    chart.dispose()
    chart = undefined
    slice = undefined
    

    Returns this

    Object itself for fluent interface

getAngleInterval

  • Get the angular interval of the gauge.

    Returns AngleInterval

    Angle interval object {min, max} in degrees.

getAnimationsEnabled

  • getAnimationsEnabled(): boolean
  • Gets if animations are enabled or not.

    Returns boolean

    Boolean state for animations enabled

getAutoScaling

  • getAutoScaling(): boolean
  • Get the current state of the Auto Scaling mode.

    Returns boolean

    True - autofit is enabled, otherwise - False.

getBackgroundFillStyle

  • Get fillstyle of chart background.

    Returns FillStyle

    FillStyle

getBackgroundStrokeStyle

  • Get stroke style of chart background.

    Returns LineStyle

    LineStyle

getDataLabelFillStyle

  • Get Fill Style of Gauge Data Label.

    Returns FillStyle

    FillStyle object

getDataLabelFont

  • Get font of Gauge Data Label.

    Returns FontSettings

    FontSettings object for gauge data label.

getDataLabelFormatter

  • getDataLabelFormatter(): NumberFormat
  • Get the formatter for the Data label.

    Returns NumberFormat

    Number formatter object.

getDefaultSlice

  • Get the slice of the gauge.

    Returns SolidGaugeSlice

    Solid Gauge Slice object for further modification.

getIntervalLabelFormatter

  • getIntervalLabelFormatter(): NumberFormat
  • Get the formatter for the scale labels.

    Returns NumberFormat

    Number formatter object.

getIntervalLabelPadding

  • getIntervalLabelPadding(): number
  • Get padding around Chart in pixels.

    Returns number

    Padding datastructure

getMinimumSize

  • getMinimumSize(): Point | undefined
  • Get the minimum size of the chart.

    Returns Point | undefined

    Size {x, y} or undefined

getPadding

  • Get padding around Chart in pixels.

    Returns Margin

    Padding datastructure

getTheme

  • Returns the Theme currently being used.

    Returns Theme

    An object containing the Theme.

getTitle

  • getTitle(): string
  • Get text of Chart title.

    Returns string

    Chart title as a string.

getTitleFillStyle

  • Get fill style of Chart Title.

    Returns FillStyle

    FillStyle object

getTitleFont

  • Get font of Chart title.

    Returns FontSettings

    FontSettings object

getTitleMarginBottom

  • getTitleMarginBottom(): number
  • Returns number

    Padding after Chart title

getTitleMarginTop

  • getTitleMarginTop(): number
  • Returns number

    Padding before Chart title

getTitleRotation

  • getTitleRotation(): number
  • Get rotation of Chart title.

    Returns number

    Rotation in degrees

offAngleIntervalChange

  • offAngleIntervalChange(token: Token): boolean
  • Remove listener with provided token.

    Parameters

    • token: Token

      Token of the listener.

    Returns boolean

    True if the listener is successfully removed and false if it is not found.

offBackgroundMouseClick

  • offBackgroundMouseClick(token: Token): boolean
  • Remove subscription from mouse-click event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseDoubleClick

  • offBackgroundMouseDoubleClick(token: Token): boolean
  • Remove subscription from mouse-doubleClick event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseDown

  • offBackgroundMouseDown(token: Token): boolean
  • Remove subscription from mouse-down event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseDrag

  • offBackgroundMouseDrag(token: Token): boolean
  • Remove subscription from mouse-drag event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseDragStart

  • offBackgroundMouseDragStart(token: Token): boolean
  • Remove subscription from mouse-dragStart event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseDragStop

  • offBackgroundMouseDragStop(token: Token): boolean
  • Remove subscription from mouse-dragStop event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseEnter

  • offBackgroundMouseEnter(token: Token): boolean
  • Remove subscription from mouse-enter event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseLeave

  • offBackgroundMouseLeave(token: Token): boolean
  • Remove subscription from mouse-leave event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseMove

  • offBackgroundMouseMove(token: Token): boolean
  • Remove subscription from mouse-move event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseTouchStart

  • offBackgroundMouseTouchStart(token: Token): boolean
  • Remove subscription from touch-start event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseUp

  • offBackgroundMouseUp(token: Token): boolean
  • Remove subscription from mouse-up event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundMouseWheel

  • offBackgroundMouseWheel(token: Token): boolean
  • Remove subscription from mouse-wheel event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundTouchEnd

  • offBackgroundTouchEnd(token: Token): boolean
  • Remove subscription from touch-end event on Panel background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offBackgroundTouchMove

  • offBackgroundTouchMove(token: Token): boolean
  • Remove subscription from touch-move event on Chart background

    Parameters

    • token: Token

      Event listener

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offResize

  • offResize(token: Token): boolean
  • Remove event listener from resize event.

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

    True if the listener is successfully removed and false if it is not found

onAngleIntervalChange

onBackgroundMouseClick

  • Subscribe to mouse-click event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDoubleClick

  • Subscribe to mouse-doubleClick event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDown

  • Subscribe to mouse-down event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDrag

  • Subscribe to mouse-drag event on Chart background

    Parameters

    Returns Token

onBackgroundMouseDragStart

onBackgroundMouseDragStop

onBackgroundMouseEnter

  • Subscribe to mouse-enter event on Chart background

    Parameters

    Returns Token

onBackgroundMouseLeave

  • Subscribe to mouse-leave event on Chart background

    Parameters

    Returns Token

onBackgroundMouseMove

  • Subscribe to mouse-move event on Chart background

    Parameters

    Returns Token

onBackgroundMouseUp

  • Subscribe to mouse-up event on Chart background

    Parameters

    Returns Token

onBackgroundMouseWheel

  • Subscribe to mouse-wheel event on Chart background

    Parameters

    Returns Token

onBackgroundTouchEnd

  • Subscribe to touch-end event on Chart background

    Parameters

    Returns Token

onBackgroundTouchMove

  • Subscribe to touch-move event on Chart background

    Parameters

    Returns Token

onBackgroundTouchStart

  • Subscribe to touch-start event on Chart background

    Parameters

    Returns Token

onResize

  • onResize(handler: function): Token
  • Subscribe to resize event. This event is triggered whenever the area of chart changes (due to document or dashboard resizing).

     // Example usage,
     ChartXY.onResize((chart, width, height, engineWidth, engineHeight) => {
         console.log('Chart resized', 'width', width, 'height', height, 'engineWidth', engineWidth, 'engineHeight', engineHeight)
     })
    

    Parameters

    • handler: function

      Handler function for event

        • Parameters

          • obj: this
          • width: pixel
          • height: pixel
          • engineWidth: pixel
          • engineHeight: pixel

          Returns void

    Returns Token

    Token of subscription

saveToFile

  • saveToFile(fileName: string, type?: undefined | string, encoderOptions?: undefined | number): this
  • Capture rendered state in an image file. Prompts the browser to download the created file.

    NOTE: The download might be blocked by browser/plugins as harmful. To prevent this, only call the method in events tied to user-interactions. From mouse-event handlers, for example.

    Has two optional parameters which directly reference JavaScript API HTMLCanvasElement.toDataURL. For supported image formats, compression quality, Etc. refer to:

    https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL

    Example usage:

    // Download 'screenshot.png'
    Panel.saveToFile('screenshot')
    // Attempt download 'maybeNotSupported.bmp'
    Panel.saveToFile('maybeNotSupported', 'image/bmp')
    // Attempt download jpeg.file with specified compression quality
    Panel.saveToFile('fileName', 'image/jpeg', 0.50)
    
    sideeffect

    If 'type' is not supported by browser, an Error will be thrown.

    Parameters

    • fileName: string

      Name of prompted download file as string. File extension shouldn't be included as it is automatically detected from 'type'-argument.

    • type: undefined | string

      A DOMString indicating the image format. The default format type is image/png.

    • encoderOptions: undefined | number

      A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If this argument is anything else, the default value for image quality is used. The default value is 0.92.

    Returns this

setAngleInterval

  • setAngleInterval(start: number, end: number): this
  • Set angular interval of the gauge in degrees.

    Parameters

    • start: number

      Start angle of the gauge in degrees.

    • end: number

      End angle of the gauge in degrees.

    Returns this

    Gauge itself for fluent interface.

setAnimationsEnabled

  • setAnimationsEnabled(animationsEnabled: boolean): this
  • Sets if animations are enabled or not.

    Parameters

    • animationsEnabled: boolean

      Boolean state for animations enabled

    Returns this

    Gauge itself for fluent interface.

setAutoScaling

  • setAutoScaling(state: boolean): this
  • Set the Auto Scaling mode enabled or disabled.

    Parameters

    • state: boolean

      True - autofit is enabled, otherwise - False.

    Returns this

    Gauge itself for fluent interface.

setBackgroundFillStyle

  • Set FillStyle of chart background.

     // Example usage,
     ChartXY.setBackgroundFillStyle(new SolidFill({ color: ColorRGBA( 80, 0, 0 ) }))
    

    Related API:

    • Use SolidFill to describe a solid fill color.
    • Use ColorRGBA to create a color from Red, Green, Blue (and optionally) Alpha values in range [0, 255].

    Parameters

    Returns this

    Object itself

setBackgroundStrokeStyle

  • Set LineStyle of chart background border stroke.

     // Example usage,
     ChartXY.setBackgroundStrokeStyle(new SolidLine({
         thickness: 2,
         fillStyle: new SolidFill({ color: ColorRGBA( 0, 255, 0 ) })
     }))
    

    Related API:

    • Use SolidLine to describe a solid line style.
    • Use SolidFill to describe a solid fill color.
    • Use ColorRGBA to create a color from Red, Green, Blue (and optionally) Alpha values in range [0, 255].

    Parameters

    Returns this

    Object itself

setDataLabelFillStyle

  • Apply new fill style to Gauge Data label.

    Parameters

    Returns this

    Gauge itself for a fluent interface.

setDataLabelFont

  • Set font of Gauge Data Label.

    Example usage:

    // Specified FontSettings
    SolidGauge.setDataLabelFont(new FontSettings({ size: 24, style: 'italic' }))
    // Set to bold
    SolidGauge.setDataLabelFont((fontSettings) => fontSettings.setWeight('bold'))
    

    Parameters

    Returns this

    Gauge itself for fluent interface.

setDataLabelFormatter

  • setDataLabelFormatter(formatter: NumberFormat): this
  • Set a new number formatter for the Data label.

    Parameters

    • formatter: NumberFormat

      Number formatter

    Returns this

    Gauge itself for fluent interface.

setGaugeFillStyle

  • Apply new fill style to slice arc.

    Parameters

    Returns this

    Gauge itself for fluent interface.

setGaugeStrokeStyle

  • Set stroke of gauge background

    Parameters

    Returns this

    Gauge itself for fluent interface.

setIntervalLabelFormatter

  • setIntervalLabelFormatter(formatter: NumberFormat): this
  • Set a new number formatter for the scale labels.

    Parameters

    • formatter: NumberFormat

      Number formatter

    Returns this

    Gauge itself for fluent interface.

setIntervalLabelPadding

  • setIntervalLabelPadding(padding: number): this
  • Set padding between Gauge and interval labels in pixels.

    Parameters

    • padding: number

      Number with pixel margin

    Returns this

    Gauge itself for fluent interface.

setLUT

  • setLUT(lut?: LUT): this
  • Set lookup table.

    Example usage:

    // Gauge slice color depending on value
    SolidGauge.setLUT(new LUT ( { steps: [ { value: 0, color: ColorRGBA( 0, 0, 0 ) },
     { value: 500, color: ColorRGBA( 12, 213, 87 ) } ],
     interpolate: true })
    

    Parameters

    • lut: LUT

      Lookup table |

    Returns this

    Gauge itself for fluent interface

setPadding

  • setPadding(padding: Partial<Margin> | number): this
  • Set padding around Chart in pixels.

     // Example 1, specify complete padding (four sides).
     ChartXY.setPadding({ left: 16, right: 16, top: 32, bottom: 8 })
    
     // Example 2, specify only single padding.
     ChartXY.setPadding({ right: 64 })
    

    Parameters

    • padding: Partial<Margin> | number

      Number with pixel margins for all sides or datastructure with individual pixel paddings for each side. Any side can be omitted, only passed values will be overridden.

    Returns this

    Object itself

setThickness

  • setThickness(thickness: number): this
  • Set thickness of the gauge.

    Parameters

    • thickness: number

    Returns this

    Gauge itself for fluent interface.

setTitle

  • setTitle(title: string): this
  • Set text of Chart title.

    Parameters

    • title: string

      Chart title as a string.

    Returns this

    Object itself for fluent interface.

setTitleFillStyle

  • Set fill style of Chart Title.

    Example usage:

    // Create a new style
    Chart.setTitleFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
    // Change transparency
    Chart.setTitleFillStyle((solidFill) => solidFill.setA(80))
    // Set hidden
    Chart.setTitleFillStyle(emptyFill)
    

    Parameters

    Returns this

    Chart itself

setTitleFont

  • Set font of Chart Title.

    Example usage:

    // Create a new FontSettings
    Chart.setTitleFont(new FontSettings({ size: 24, style: 'italic' }))
    // Change existing settings
    Chart.setTitleFont((fontSettings) => fontSettings.setWeight('bold'))
    

    Parameters

    Returns this

    Chart itself

setTitleMarginBottom

  • setTitleMarginBottom(marginPixels: pixel): this
  • Specifies padding after chart title.

    This does not have an effect if title is hidden (empty FillStyle).

     // Example usage,
     // Add empty space between title and series.
     ChartXY.setTitleMarginBottom(32)
    

    Parameters

    • marginPixels: pixel

      Gap after the chart title in pixels.

    Returns this

    Chart itself for fluent interface

setTitleMarginTop

  • setTitleMarginTop(marginPixels: pixel): this
  • Specifies padding before chart title.

    This does not have an effect if title is hidden (empty FillStyle).

     // Example usage,
     // Add empty space at top of chart, before title.
     ChartXY.setTitleMarginTop(32)
    

    Parameters

    • marginPixels: pixel

      Gap between the top of chart and its title in pixels.

    Returns this

    Chart itself for fluent interface

setTitleRotation

  • setTitleRotation(value: number): this
  • Set rotation of Chart title.

    Parameters

    • value: number

      Rotation in degrees

    Returns this

    Object itself