Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • _GaugeAxis
    • GaugeAxis

Index

Constructors

constructor

  • Returns GaugeAxis

Properties

axisAlpha

axisAlpha: number

Axis opacity.

default

1

axisColor

axisColor: string

Axis color.

default

#000000

axisThickness

axisThickness: number

Thickness of the axis outline.

default

1

bandAlpha

bandAlpha: number

Opacity of band fills.

default

1

bandGradientRatio

bandGradientRatio: [number]

Example: [-0.2, 0, -0.2]. Will make bands to be filled with color gradients. Negative value means the color will be darker than the original, and positive number means the color will be lighter.

default

[]

bandOutlineAlpha

bandOutlineAlpha: number

Opacity of band outlines.

default

0

bandOutlineColor

bandOutlineColor: string

Color of band outlines.

default

#000000

bandOutlineThickness

bandOutlineThickness: number

Thickness of band outlines.

default

0

bands

bands: [default]

Array of bands - GaugeBand objects. Bands are used to draw color fills between specified values.

bottomText

bottomText: string

Text displayed below the axis center.

bottomTextBold

bottomTextBold: boolean

Specifies if text should be bold.

default

true

bottomTextColor

bottomTextColor: string

Bottom text color.

bottomTextFontSize

bottomTextFontSize: number

Font size of bottom text.

bottomTextYOffset

bottomTextYOffset: number

Y offset of bottom text.

default

0

centerX

centerX: any

X position of the axis, relative to the center of the gauge.

default

'0%'

centerY

centerY: any

Y position of the axis, relative to the center of the gauge.

default

'0%'

color

color: string

Specifies labels color of the axis.

endAngle

endAngle: number

Axis end angle. Valid values are from - 180 to 180.

default

120

endValue

endValue: number

Axis end (max) value

fontSize

fontSize: number

Font size for axis labels.

gridCount

gridCount: number

Number of grid lines. Note, GaugeAxis doesn't adjust gridCount, so you should check your values and choose a proper gridCount which would result grids at round numbers.

default

5

gridInside

gridInside: boolean

Specifies if grid should be drawn inside or outside the axis.

default

true

id

id: any

Unique id of an axis.

inside

inside: boolean

Specifies if labels should be placed inside or outside the axis.

default

true

labelFrequency

labelFrequency: number

Frequency of labels.

default

1

labelFunction

labelFunction: (value: number) => string

You can use this function to format axis labels. This function is called and value is passed as a attribute: labelFunction(value);

Type declaration

    • (value: number): string
    • You can use this function to format axis labels. This function is called and value is passed as a attribute: labelFunction(value);

      Parameters

      • value: number

      Returns string

labelOffset

labelOffset: number

Distance from axis to the labels.

default

15

labelsEnabled

labelsEnabled: boolean

Specifies if labels on the axis should be shown.

default

true

listeners

listeners: object[]

You can add listeners of events using this property. Example: listeners = [{"event":"clickBand", "method":handleClick}];

minorTickInterval

minorTickInterval: number

Interval, at which minor ticks should be placed.

minorTickLength

minorTickLength: number

Length of a minor tick.

default

5

radius

radius: any

Axis radius.

default

'95%'

showFirstLabel

showFirstLabel: boolean

Specifies if the first label should be shown.

default

true

showLastLabel

showLastLabel: boolean

Specifies if the last label should be shown.

default

true

startAngle

startAngle: number

Axis start angle. Valid values are from - 180 to 180.

default

-120

startValue

startValue: number

Axis start (min) value.

default

0

tickAlpha

tickAlpha: number

Opacity of axis ticks.

default

1

tickColor

tickColor: string

Color of axis ticks.

default

#555555

tickLength

tickLength: number

Length of a major tick.

default

10

tickThickness

tickThickness: number

Tick thickness.

default

1

topText

topText: string

Text displayed above the axis center.

topTextBold

topTextBold: boolean

Specifies if text should be bold.

default

true

topTextColor

topTextColor: string

Color of top text.

topTextFontSize

topTextFontSize: number

Font size of top text.

topTextYOffset

topTextYOffset: number

Y offset of top text.

default

0

unit

unit: string

A string which can be placed next to axis labels.

unitPosition

unitPosition: string

Position of the unit.

default

right

usePrefixes

usePrefixes: boolean

Specifies if small and big numbers should use prefixes to make them more readable.

default

false

valueInterval

valueInterval: number

Interval, at which ticks with values should be placed.

Methods

addListener

  • addListener(type: string, handler: any): void
  • Adds event listener to the object.

    Parameters

    • type: string
    • handler: any

    Returns void

removeListener

  • removeListener(chart: default, type: string, handler: any): void
  • Removes event listener from chart object.

    Parameters

    • chart: default
    • type: string
    • handler: any

    Returns void

setBottomText

  • setBottomText(text: string): void
  • Sets bottom text.

    Parameters

    • text: string

    Returns void

setTopText

  • setTopText(textstring: string): void
  • Sets top text.

    Parameters

    • textstring: string

    Returns void

value2angle

  • value2angle(value: number): void
  • Returns angle of the value.

    Parameters

    • value: number

    Returns void

Generated using TypeDoc