axis - APEXlang Reference

`axis`

Parent: region

Applies whentype = chart and type in (area)type = chart and type in (bar)type = chart and type in (boxPlot)type = chart and type in (bubble)type = chart and type in (combination)type = chart and type in (gantt)type = chart and type in (line)type = chart and type in (lineWithArea)type = chart and type in (polar)type = chart and type in (radar)type = chart and type in (range)type = chart and type in (scatter)type = chart and type in (stock)

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `x` `y` `y2` `major` `minor`
`showAxis`	`boolean`	Yes	`on`	data type=`boolean` Applies when`name in (x)name in (y)name in (y2)name in (major)`
`title`	`string`	No		data type=`string`; maxLen=255 Enter a title for the axis. This title describes the information being represented on the axis of your chart.

Property Groups:

timeScale

Property	Type	Required	Default Value	Details
`scale`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `seconds` `minutes` `hours` `days` `weeks` `months` `quarters` `years` Applies when`name in (major)name in (minor)`

timeScale {
  scale: seconds
}

zoomScale

Property	Type	Required	Default Value	Details
`seconds`	`boolean`	Yes	`false`	data type=`boolean` Applies when`name in (major)name in (minor)`
`minutes`	`boolean`	Yes	`false`	data type=`boolean` Applies when`name in (major)name in (minor)`
`hours`	`boolean`	Yes	`false`	data type=`boolean` Applies when`name in (major)name in (minor)`
`days`	`boolean`	Yes	`true`	data type=`boolean` Applies when`name in (major)name in (minor)`
`weeks`	`boolean`	Yes	`true`	data type=`boolean` Applies when`name in (major)name in (minor)`
`months`	`boolean`	Yes	`true`	data type=`boolean` Applies when`name in (major)name in (minor)`
`quarters`	`boolean`	Yes	`true`	data type=`boolean` Applies when`name in (major)name in (minor)`
`years`	`boolean`	Yes	`false`	data type=`boolean` Applies when`name in (major)name in (minor)`

zoomScale {
  seconds: false
  minutes: false
  hours: false
  days: false
  weeks: false
  months: false
  quarters: false
  years: false
}

title

Property	Type	Required	Details
`fontFamily`	`enum`	No	data type=`string`; lov=`STATIC` Valid values: `arial` `arialBlack` `bookman` `comicSansMs` `courier` `courierNew` `garamond` `georgia` `helvetica` `impact` `palatino` `times` `timesNewRoman` `trebuchetMs` `verdana` Applies when`name in (x)name in (y)name in (y2)`
`fontStyle`	`enum`	No	data type=`string`; lov=`STATIC` Valid values: `normal` `italic` `oblique` Applies when`name in (x)name in (y)name in (y2)`
`fontSize`	`enum`	No	data type=`string`; lov=`STATIC` Valid values: `8` `10` `12` `14` `16` `18` `20` `22` Applies when`name in (x)name in (y)name in (y2)`
`fontColor`	`string`	No	data type=`string`; maxLen=255 Applies when`name in (x)name in (y)name in (y2)`

title {
  fontFamily: arial
  fontStyle: normal
  fontSize: "8"
  fontColor: value
}

value

Property	Type	Required	Default Value	Details
`min`	`number`	No		data type=`number`; maxLen=22 Applies when`name in (x)name in (y)name in (y2)`
`max`	`number`	No		data type=`number`; maxLen=22 Applies when`name in (x)name in (y)name in (y2)`
`format`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `dateShort` `dateMedium` `dateLong` `dateFull` `timeShort` `timeMedium` `timeLong` `timeFull` `datetimeShort` `datetimeMedium` `datetimeLong` `datetimeFull` `decimal` `currency` `percent`
`decimalPlaces`	`integer`	No		data type=`integer`; maxLen=32767 Applies when`format in (decimal) and name in (x)format in (decimal) and name in (y)format in (decimal) and name in (y2)format in (currency) and name in (x)format in (currency) and name in (y)format in (currency) and name in (y2)format in (percent) and name in (x)format in (percent) and name in (y)format in (percent) and name in (y2)`
`currency`	`string`	No		data type=`string`; maxLen=128 Applies when`format = currency and name in (x)format = currency and name in (y)format = currency and name in (y2)`
`pattern`	`string`	No		data type=`string`; maxLen=30 Applies when`format is set and name in (x)format is set and name in (y)format is set and name in (y2)format is set and name in (major)format is set and name in (minor)`
`formatScaling`	`enum`	Yes	`auto`	data type=`string`; lov=`STATIC` Valid values: `none` `auto` `thousand` `million` `billion` `trillion` `quadrillion` Applies when`name in (x)name in (y)name in (y2)`
`baselineScaling`	`enum`	Yes	`zero`	data type=`string`; lov=`STATIC` Valid values: `min` `zero` Applies when`name in (x)name in (y)name in (y2)`
`scale`	`enum`	Yes	`linear`	data type=`string`; lov=`STATIC` Valid values: `linear` `log` Applies when`name in (x)name in (y)name in (y2)`
`step`	`number`	No		data type=`number`; maxLen=22 Applies when`name in (x)name in (y)name in (y2)`

value {
  min: 42
  max: 42
  format: dateShort
  decimalPlaces: 42
  currency: value
  pattern: value
  formatScaling: none
  baselineScaling: min
  scale: linear
  step: 42
}

appearance

Property	Type	Required	Default Value	Details
`position`	`enum`	Yes	`auto`	data type=`string`; lov=`STATIC` Valid values: `auto` `start` `end` `top` `bottom`

appearance {
  position: auto
}

majorTicks

Property	Type	Required	Default Value	Details
`show`	`enum`	Yes	`true`	data type=`string`; lov=`STATIC` Valid values: `auto` `true` `false` Applies when`name in (x)name in (y)name in (y2)`
`minStep`	`number`	No		data type=`number`; maxLen=22 Applies when`name in (x)name in (y)name in (y2)`

majorTicks {
  show: auto
  minStep: 42
}

minorTicks

Property	Type	Required	Default Value	Details
`show`	`enum`	Yes	`auto`	data type=`string`; lov=`STATIC` Valid values: `auto` `true` `false` Applies when`name in (x)name in (y)name in (y2)`
`step`	`number`	No		data type=`number`; maxLen=22 Applies when`name in (x)name in (y)name in (y2)`

minorTicks {
  show: auto
  step: 42
}

tickLabel

Property	Type	Required	Default Value	Details
`show`	`boolean`	Yes	`on`	data type=`boolean` Applies when`name in (x)name in (y)name in (y2)`
`rotation`	`boolean`	Yes	`auto`	data type=`boolean` Applies when`name in (x) and show = on and name = xname in (y) and show = on and name = xname in (y2) and show = on and name = x`
`position`	`enum`	Yes	`outside`	data type=`string`; lov=`STATIC` Valid values: `outside` `inside` Applies when`name in (x) and show = on and name = xname in (y) and show = on and name = xname in (y2) and show = on and name = x`
`fontFamily`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `arial` `arialBlack` `bookman` `comicSansMs` `courier` `courierNew` `garamond` `georgia` `helvetica` `impact` `palatino` `times` `timesNewRoman` `trebuchetMs` `verdana` Applies when`name in (x) and show = onname in (x) and name in (y) and show = onname in (x) and name in (y2) and show = onname in (y) and name in (x) and show = onname in (y) and show = onname in (y) and name in (y2) and show = onname in (y2) and name in (x) and show = onname in (y2) and name in (y) and show = onname in (y2) and show = on`
`fontStyle`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `normal` `italic` `oblique` Applies when`name in (x) and show = onname in (x) and name in (y) and show = onname in (x) and name in (y2) and show = onname in (y) and name in (x) and show = onname in (y) and show = onname in (y) and name in (y2) and show = onname in (y2) and name in (x) and show = onname in (y2) and name in (y) and show = onname in (y2) and show = on`
`fontSize`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `8` `10` `12` `14` `16` `18` `20` `22` Applies when`name in (x) and show = onname in (x) and name in (y) and show = onname in (x) and name in (y2) and show = onname in (y) and name in (x) and show = onname in (y) and show = onname in (y) and name in (y2) and show = onname in (y2) and name in (x) and show = onname in (y2) and name in (y) and show = onname in (y2) and show = on`
`fontColor`	`string`	No		data type=`string`; maxLen=255 Applies when`name in (x) and show = onname in (x) and name in (y) and show = onname in (x) and name in (y2) and show = onname in (y) and name in (x) and show = onname in (y) and show = onname in (y) and name in (y2) and show = onname in (y2) and name in (x) and show = onname in (y2) and name in (y) and show = onname in (y2) and show = on`

tickLabel {
  show: false
  rotation: false
  position: outside
  fontFamily: arial
  fontStyle: normal
  fontSize: "8"
  fontColor: value
}

dualYAxes

Property	Type	Required	Default Value	Details
`show`	`enum`	Yes	`auto`	data type=`string`; lov=`STATIC` Valid values: `auto` `true` `false` Applies when`name = y2`
`splitterPosition`	`number`	No		data type=`number`; maxLen=22 Applies when`name = y2`

dualYAxes {
  show: auto
  splitterPosition: 42
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	No		data type=`string`; maxLen=255 Enter a unique Static ID for the chart axis. The Static ID can be useful when developing custom JavaScript behavior for the chart axis or to refer it in application export files. Be cautious when changing it after creation.

advanced {
  staticId: value
}

APEXlang Example

axis sample (
    name: x
    showAxis: false
    title: value
    timeScale {
        scale: seconds
    }
    zoomScale {
        seconds: false
        minutes: false
        hours: false
        days: false
        weeks: false
        months: false
        quarters: false
        years: false
    }
    title {
        fontFamily: arial
        fontStyle: normal
        fontSize: "8"
        fontColor: value
    }
    value {
        min: 42
        max: 42
        format: dateShort
        decimalPlaces: 42
        currency: value
        pattern: value
        formatScaling: none
        baselineScaling: min
        scale: linear
        step: 42
    }
    appearance {
        position: auto
    }
    majorTicks {
        show: auto
        minStep: 42
    }
    minorTicks {
        show: auto
        step: 42
    }
    tickLabel {
        show: false
        rotation: false
        position: outside
        fontFamily: arial
        fontStyle: normal
        fontSize: "8"
        fontColor: value
    }
    dualYAxes {
        show: auto
        splitterPosition: 42
    }
    advanced {
        staticId: value
    }
)