AxisDef

(esrith/amos/chart/AxisDef)

AxisDef is a class to define configurations for bar chart, line chart and mix chart.

Description
new AxisDef()

Create a new AxisDef object.

Type Description
dropLabels Boolean

True is avoid overlap label, False is allow overlap label.

fixed Boolean

Forces all ticks to be fixed the precision on labels.

fixLower String

When set will force the end bounds to align to the corresponding tick division. If none is chosen, the end bounds will be the highest and lowest values in your data set.

fixUpper String

When set will force the end bounds to align to the corresponding tick division. If none is chosen, the end bounds will be the highest and lowest values in your data set.

font String

Specifies the style of text. example:"normal normal bold 14pt Tahoma"

fontColor String

Specifies the color of text.

includeZero Boolean

Which will make your lower bound be zero. If your lowest data value is negative the includeZero option has no effect.

labels Object

custom labels to any axis. Array of {value:value,text:text}

labelSizeChange Boolean

Size of label change by zooming in or out.

leftBottom Boolean

Along with the vertical option determines the side of the chart the axis is placed.

majorLabels Boolean

Turn labels on and off for the major levels.

majorTick Object

Major tick style.

maxLabelCharCount Number

When dropLabels is false, define the max count of characters in label.

maxLabelSize Number

When dropLabels is false, define the max length of label in pixel.

microTicks Boolean

Turn on and off the tick marks at the micro level.

minorTick Object

Minor tick style.

minorTicks Boolean

Turn on and off the tick marks at the minor level.

natural Boolean

Forces all ticks to be on natural numbers.

stroke String

An optional stroke to use for axis.

title String

Axis title text.

titleFontColor String

Axis title font color.

titleGap Number

The spacing between title and corresponding axis, measured by pixel.

titleOrientation String

Determine the title orientation to the axis, facing to the axis by "axis", or facing away from the axis by "away".

trailingSymbol String

When dropLabels is false, define the symbol replacing the omitted part of label.

Return type Description
Constructors Detail
new AxisDef()

Create a new AxisDef object.

Properties Detail
<Boolean>
dropLabels

True is avoid overlap label, False is allow overlap label.

Default value: true

<Boolean>
fixed

Forces all ticks to be fixed the precision on labels.

Default value: true

<String>
fixLower

When set will force the end bounds to align to the corresponding tick division. If none is chosen, the end bounds will be the highest and lowest values in your data set.

Default value: `None`

<String>
fixUpper

When set will force the end bounds to align to the corresponding tick division. If none is chosen, the end bounds will be the highest and lowest values in your data set.

Default value: `None`

<String>
font

Specifies the style of text. example:"normal normal bold 14pt Tahoma"

<String>
fontColor

Specifies the color of text.

<Boolean>
includeZero

Which will make your lower bound be zero. If your lowest data value is negative the includeZero option has no effect.

Default value: true

<Object>
labels

custom labels to any axis. Array of {value:value,text:text}

<Boolean>
labelSizeChange

Size of label change by zooming in or out.

Default value: true

<Boolean>
leftBottom

Along with the vertical option determines the side of the chart the axis is placed.

Default value: true

<Boolean>
majorLabels

Turn labels on and off for the major levels.

Default value: true

<Object>
majorTick

Major tick style.

<Number>
maxLabelCharCount

When dropLabels is false, define the max count of characters in label.

Default value: 0

<Number>
maxLabelSize

When dropLabels is false, define the max length of label in pixel.

Default value: 0

<Boolean>
microTicks

Turn on and off the tick marks at the micro level.

Default value: false

<Object>
minorTick

Minor tick style.

<Boolean>
minorTicks

Turn on and off the tick marks at the minor level.

Default value: true

<Boolean>
natural

Forces all ticks to be on natural numbers.

Default value: false

<String>
stroke

An optional stroke to use for axis.

Default value: "black"

<String>
title

Axis title text.

Default value: null

<String>
titleFontColor

Axis title font color.

Default value: "black"

<Number>
titleGap

The spacing between title and corresponding axis, measured by pixel.

Default value: 15

<String>
titleOrientation

Determine the title orientation to the axis, facing to the axis by "axis", or facing away from the axis by "away".

Default value: "axis"

<String>
trailingSymbol

When dropLabels is false, define the symbol replacing the omitted part of label.

Default value: null

Methods Detail