Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • _ValueAxis
    • ValueAxis

Index

Constructors

constructor

  • Returns ValueAxis

Properties

autoGridCount

autoGridCount: boolean

Specifies whether number of gridCount is specified automatically, acoarding to the axis size.

default

true

axisAlpha

axisAlpha: number

Axis opacity. Value range is 0 - 1.

default

1

axisColor

axisColor: string

Axis color. #000000

axisThickness

axisThickness: number

Thickness of the axis.

default

1

axisTitleOffset

axisTitleOffset: number

Radar chart only. Specifies distance from axis to the axis title (category) 10

baseCoord

baseCoord: number

Read-only. Coordinate of the base value.

baseValue

baseValue: number

Specifies base value of the axis.

color

color: string

Color of axis value labels. Will use chart's color if not set.

dashLength

dashLength: number

Length of a dash. 0 means line is not dashed.

duration

duration: string

If your values represents time units, and you want value axis labels to be formatted as duration, you have to set the duration unit. Possible values are: "ss", "mm", "hh" and "DD".

durationUnits

durationUnits: { DD: string; hh: string; mm: string; ss: string }

If duration property is set, you can specify what string should be displayed next to day, hour, minute and second. {DD:"d. ", hh:":", mm:":",ss:""}

Type declaration

  • DD: string
  • hh: string
  • mm: string
  • ss: string

fillAlpha

fillAlpha: number

Fill opacity. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills.

fillColor

fillColor: string

Fill color. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills.

default

"#FFFFFF"

fontSize

fontSize: string

Size of value labels text. Will use chart's fontSize if not set.

gridAlpha

gridAlpha: number

Opacity of grid lines. 0.2

gridColor

gridColor: string

Color of grid lines. #000000

gridCount

gridCount: number

Number of grid lines. In case this is value axis, or your categoryAxis parses dates, the number is approximate. The default value is 5. If you set autoGridCount to true, this property is ignored.

default

5

gridThickness

gridThickness: number

Thickness of grid lines.

default

1

gridType

gridType: string

Radar chart only. Possible values are: "polygons" and "circles". Set "circles" for polar charts.

default

"polygons"

guides

guides: any[]

The array of guides belonging to this axis.

id

id: string

Unique id of value axis. It is not required to set it, unless you need to tell the graph which exact value axis it should use.

ignoreAxisWidth

ignoreAxisWidth: boolean

If autoMargins of a chart is set to true, but you want this axis not to be measured when calculating margin, set ignoreAxisWidth to true.

includeGuidesInMinMax

includeGuidesInMinMax: boolean

Specifies whether guide values should be included when calculating min and max of the axis.

includeHidden

includeHidden: boolean

If true, the axis will include hidden graphs when calculating min and max values.

inside

inside: boolean

Specifies whether values should be placed inside or outside plot area.

integersOnly

integersOnly: boolean

Specifies whether values on axis can only be integers or both integers and doubles.

labelFrequency

labelFrequency: number

Frequency at which labels should be placed. Doesn't work for CategoryAxis if parseDates is set to true.

default

1

labelRotation

labelRotation: number

Rotation angle of a label. Only horizontal axis' values can be rotated. If you set this for vertical axis, the setting will be ignored.

labelsEnabled

labelsEnabled: boolean

Specifies whether axis displays category axis' labels and value axis' values.

default

true

logarithmic

logarithmic: boolean

Specifies if this value axis' scale should be logarithmic.

max

max: number

Read-only. Maximum value of the axis.

maximum

maximum: number

If you don't want max value to be calculated by the chart, set it using this property. This value might still be adjusted so that it would be possible to draw grid at rounded intervals.

maximumData

maximumData: Date

If your value axis is date-based, you can specify maximum date of the axis. Can be set as date object, timestamp number or string if dataDateFormat is set.

min

min: number

Read-only. Minimum value of the axis.

minMaxMultiplier

minMaxMultiplier: number

If set value axis scale (min and max numbers) will be multiplied by it. I.e. if set to 1.2 the scope of values will increase by 20%.

minimum

minimum: number

If you don't want min value to be calculated by the chart, set it using this property. This value might still be adjusted so that it would be possible to draw grid at rounded intervals.

minimumDate

minimumDate: Date

If your value axis is date-based, you can specify minimum date of the axis. Can be set as date object, timestamp number or string if dataDateFormat is set.

offset

offset: number

The distance of the axis to the plot area, in pixels. Negative values can also be used.

pointPosition

pointPosition: string

Works with radar charts only. If you set it to “middle”, labels and data points will be placed in the middle between axes.

position

position: string

Possible values are: "top", "bottom", "left", "right". If axis is vertical, default position is "left". If axis is horizontal, default position is "bottom".

precision

precision: number

Precision (number of decimals) of values.

radarCategoriesEnabled

radarCategoriesEnabled: boolean

Radar chart only. Specifies if categories (axes' titles) should be displayed near axes)

default

true

recalculateToPercents

recalculateToPercents: boolean

pecifies if graphs's values should be recalculated to percents.

reversed

reversed: boolean

Specifies if value axis should be reversed (smaller values on top).

showFirstLabel

showFirstLabel: boolean

Whether to show first axis label or not.

default

true

showLastLabel

showLastLabel: boolean

Whether to show last axis label or not.

default

true

stackType

stackType: string

Stacking mode of the axis. Possible values are: "none", "regular", "100%", "3d". Note, only graphs of one type will be stacked.

default

"none"

step

step: number

Read-only. Value difference between two grid lines.

strictMinMax

strictMinMax: boolean

If you set minimum and maximum for your axis, chart adjusts them so that grid would start and end on the beginning and end of plot area and grid would be at equal intervals. If you set strictMinMax to true, the chart will not adjust minimum and maximum of value axis.

synchronizationMultiplier

synchronizationMultiplier: number

In case you synchronize one value axis with another, you need to set the synchronization multiplier. Use synchronizeWithAxis method to set with which axis it should be synced.

synchronizeWith

synchronizeWith: default

One value axis can be synchronized with another value axis. You can use both reference to your axis or id of the axis here. You should set synchronizationMultiplyer in order for this to work.

tickLength

tickLength: number

Length of the tick marks.

default

5

title

title: string

Title of the axis.

titleBold

titleBold: boolean

Specifies if title should be bold or not.

default

true

titleColor

titleColor: string

Color of axis title. Will use text color of chart if not set any.

titlefontSize

titlefontSize: string

Font size of axis title. Will use font size of chart plus two pixels if not set any.

totalText

totalText: string

If this value axis is stacked and has columns, setting valueAxis.totalText = "[[total]]" will make it to display total value above the most-top column.

totalTextColor

totalTextColor: string

Color of total text.

totalTextOffset

totalTextOffset: number

Distance from data point to total text.

treatZeroAs

treatZeroAs: number

This allows you to have logarithmic value axis and have zero values in the data. You must set it to >0 value in order to work.

type

type: string

Type of value axis. If your values in data provider are dates and you want this axis to show dates instead of numbers, set it to "date".

unit

unit: string

Unit which will be added to the value label.

unitPosition

unitPosition: string

Position of the unit. Possible values are "left" and "right". right

usePrefixes

usePrefixes: boolean

If true, prefixes will be used for big and small numbers. You can set arrays of prefixes directly to the chart object via prefixesOfSmallNumbers and prefixesOfBigNumbers.

useScientificNotation

useScientificNotation: boolean

If true, values will always be formatted using scientific notation (5e+8, 5e-8...) Otherwise only values bigger then 1e+21 and smaller then 1e-7 will be displayed in scientific notation.

Methods

addGuide

  • addGuide(guide: default): void
  • Adds guide to the axis.

    Parameters

    • guide: default

    Returns void

addListener

  • addListener(type: string, handler: (e: { chart: default; endValue?: Date; startValue?: Date; type: string }) => void): void
  • Adds event listener.

    Parameters

    • type: string

      One of "axisChanged", "axisZoomed", "logarithmicAxisFailed".

    • handler: (e: { chart: default; endValue?: Date; startValue?: Date; type: string }) => void

      The event handler.

        • (e: { chart: default; endValue?: Date; startValue?: Date; type: string }): void
        • Parameters

          • e: { chart: default; endValue?: Date; startValue?: Date; type: string }
            • chart: default
            • Optional endValue?: Date
            • Optional startValue?: Date
            • type: string

          Returns void

    Returns void

coordinateToValue

  • coordinateToValue(coordinate: number): void
  • Number, - value of coordinate. Returns value of the coordinate. coordinate - y or x coordinate, in pixels.

    Parameters

    • coordinate: number

    Returns void

getCoordinate

  • getCoordinate(value: number): void
  • Number - coordinate Returns coordinate of the value in pixels. value - Number

    Parameters

    • value: number

    Returns void

labelFunction

  • labelFunction(value: number, valueText: string, valueAxis: default): string
  • labelFunction(valueText: string, data: Date, valueAxis: default): string
  • You can use this function to format Value axis labels. This function is called and these parameters are passed: labelFunction(value, valueText, valueAxis); Where value is numeric value, valueText is formatted string and valueAxis is a reference to valueAxis object. If axis type is "date", labelFunction will pass different arguments: labelFunction(valueText, date, valueAxis) Your function should return string.

    Parameters

    • value: number
    • valueText: string
    • valueAxis: default

    Returns string

  • Parameters

    • valueText: string
    • data: Date
    • valueAxis: default

    Returns string

removeGuide

  • removeGuide(guide: default): void
  • Removes guide from the axis.

    Parameters

    • guide: default

    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

synchronizeWithAxis

  • synchronizeWithAxis(axis: default): void
  • One value axis can be synchronized with another value axis. You should set synchronizationMultiplyer in order for this to work.

    Parameters

    • axis: default

    Returns void

zoomToValues

  • zoomToValues(startValue: number, endValue: number): void
  • XY Chart only. Zooms-in the axis to the provided values.

    Parameters

    • startValue: number
    • endValue: number

    Returns void

Generated using TypeDoc