/**
* Copyright (c) 2017 ~ present NAVER Corp.
* billboard.js project is licensed under the MIT license
*/
/**
* x Axis config options
*/
export default {
/**
* Set clip-path attribute for x axis element
* @name axis․x․clipPath
* @memberof Options
* @type {boolean}
* @default true
* @see [Demo]()
* @example
* // don't set 'clip-path' attribute
* clipPath: false
*/
axis_x_clipPath: true,
/**
* Show or hide x axis.
* @name axis․x․show
* @memberof Options
* @type {boolean}
* @default true
* @example
* axis: {
* x: {
* show: false
* }
* }
*/
axis_x_show: true,
/**
* Set type of x axis.<br><br>
* **Available Values:**
* - category
* - indexed
* - log
* - timeseries
*
* **NOTE:**<br>
* - **log** type:
* - the x values specified by [`data.x`](#.data%25E2%2580%25A4x)(or by any equivalent option), must be exclusively-positive.
* - x axis min value should be >= 0.
* - for 'category' type, `data.xs` option isn't supported.
*
* @name axis․x․type
* @memberof Options
* @type {string}
* @default indexed
* @see [Demo: indexed](https://naver.github.io/billboard.js/demo/#Chart.AreaChart)
* @see [Demo: timeseries](https://naver.github.io/billboard.js/demo/#Chart.TimeseriesChart)
* @see [Demo: category](https://naver.github.io/billboard.js/demo/#Data.CategoryData)
* @see [Demo: log](https://naver.github.io/billboard.js/demo/#Axis.LogScales)
* @example
* axis: {
* x: {
* type: "timeseries"
* }
* }
*/
axis_x_type: <"category"|"indexed"|"log"|"timeseries"> "indexed",
/**
* Set how to treat the timezone of x values.<br>
* If true, treat x value as localtime. If false, convert to UTC internally.
* @name axis․x․localtime
* @memberof Options
* @type {boolean}
* @default true
* @example
* axis: {
* x: {
* localtime: false
* }
* }
*/
axis_x_localtime: true,
/**
* Set category names on category axis.
* This must be an array that includes category names in string. If category names are included in the date by data.x option, this is not required.
* @name axis․x․categories
* @memberof Options
* @type {Array}
* @default []
* @example
* axis: {
* x: {
* categories: ["Category 1", "Category 2", ...]
* }
* }
*/
axis_x_categories: <string[]> [],
/**
* centerize ticks on category axis.
* @name axis․x․tick․centered
* @memberof Options
* @type {boolean}
* @default false
* @example
* axis: {
* x: {
* tick: {
* centered: true
* }
* }
* }
*/
axis_x_tick_centered: false,
/**
* A function to format tick value. Format string is also available for timeseries data.
* @name axis․x․tick․format
* @memberof Options
* @type {Function|string}
* @default undefined
* @see [D3's time specifier](https://d3js.org/d3-time-format#locale_format)
* @example
* axis: {
* x: {
* tick: {
* // for timeseries, a 'datetime' object is given as parameter
* format: function(x) {
* return x.getFullYear();
* }
*
* // for category, index(Number) and categoryName(String) are given as parameter
* format: function(index, categoryName) {
* return categoryName.substr(0, 10);
* },
*
* // for timeseries format specifier
* format: "%Y-%m-%d %H:%M:%S"
* }
* }
* }
*/
axis_x_tick_format: <Function|string|undefined> undefined,
/**
* Setting for culling ticks.
* - `true`: the ticks will be culled, then only limited tick text will be shown.<br>
* This option does not hide the tick lines by default, if want to hide tick lines, set `axis.x.tick.culling.lines=false`.
* - `false`: all of ticks will be shown.<br><br>
* The number of ticks to be shown can be chaned by `axis.x.tick.culling.max`.
* @name axis․x․tick․culling
* @memberof Options
* @type {boolean}
* @default
* `true` for indexed axis and timeseries axis, `false` for category axis
* @example
* axis: {
* x: {
* tick: {
* culling: false
* }
* }
* }
*/
axis_x_tick_culling: {},
/**
* The number of tick texts will be adjusted to less than this value.
* @name axis․x․tick․culling․max
* @memberof Options
* @type {number}
* @default 10
* @example
* axis: {
* x: {
* tick: {
* culling: {
* max: 5
* }
* }
* }
* }
*/
axis_x_tick_culling_max: 10,
/**
* Control visibility of tick lines within culling option, along with tick text.
* @name axis․x․tick․culling․lines
* @memberof Options
* @type {boolean}
* @default true
* @example
* axis: {
* x: {
* tick: {
* culling: {
* lines: false,
* }
* }
* }
* }
*/
axis_x_tick_culling_lines: true,
/**
* The number of x axis ticks to show.<br><br>
* This option hides tick lines together with tick text. If this option is used on timeseries axis, the ticks position will be determined precisely and not nicely positioned (e.g. it will have rough second value).
* @name axis․x․tick․count
* @memberof Options
* @type {number}
* @default undefined
* @example
* axis: {
* x: {
* tick: {
* count: 5
* }
* }
* }
*/
axis_x_tick_count: <number|undefined>undefined,
/**
* Show or hide x axis tick line.
* @name axis․x․tick․show
* @memberof Options
* @type {boolean}
* @default true
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.HideTickLineText)
* @example
* axis: {
* x: {
* tick: {
* show: false
* }
* }
* }
*/
axis_x_tick_show: true,
/**
* Show or hide x axis tick text.
* @name axis․x․tick․text․show
* @memberof Options
* @type {boolean}
* @default true
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.HideTickLineText)
* @example
* axis: {
* x: {
* tick: {
* text: {
* show: false
* }
* }
* }
* }
*/
axis_x_tick_text_show: true,
/**
* Set the first/last axis tick text to be positioned inside of the chart on non-rotated axis.
* @name axis․x․tick․text․inner
* @memberof Options
* @type {boolean|object}
* @default false
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.XAxisTickInner)
* @example
* axis: {
* x: {
* tick: {
* text: {
* inner: true,
*
* // or specify each position of the first and last tick text
* inner: {
* first: true,
* last: true
* }
* }
* }
* }
* }
*/
axis_x_tick_text_inner: <{first?: boolean, last?: boolean}|boolean> false,
/**
* Set the x Axis tick text's position relatively its original position
* @name axis․x․tick․text․position
* @memberof Options
* @type {object}
* @default {x: 0, y:0}
* @example
* axis: {
* x: {
* tick: {
* text: {
* position: {
* x: 10,
* y: 10
* }
* }
* }
* }
* }
*/
axis_x_tick_text_position: {x: 0, y: 0},
/**
* Fit x axis ticks.
* - **true**: ticks will be shown according to x value of the data points.
* - **false**: ticks will be shown as to have same intervals.
* @name axis․x․tick․fit
* @memberof Options
* @type {boolean}
* @default true
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.XAxisTickFitting)
* @see [Demo: for timeseries zoom](https://naver.github.io/billboard.js/demo/#Axis.XAxisTickTimeseries)
* @example
* axis: {
* x: {
* tick: {
* fit: false
* }
* }
* }
*/
axis_x_tick_fit: true,
/**
* Set the x values of ticks manually.<br><br>
* If this option is provided, the position of the ticks will be determined based on those values.<br>
* This option works with `timeseries` data and the x values will be parsed accoding to the type of the value and data.xFormat option.
* @name axis․x․tick․values
* @memberof Options
* @type {Array|Function}
* @default null
* @example
* axis: {
* x: {
* tick: {
* values: [1, 2, 4, 8, 16, 32, ...],
*
* // an Array value should be returned
* values: function() {
* return [ ... ];
* }
* }
* }
* }
*/
axis_x_tick_values: <(string|Date|number)[]|(()=> number[])|null> null,
/**
* Rotate x axis tick text if there is not enough space for 'category' and 'timeseries' type axis.
* - **NOTE:** The conditions where `autorotate` is enabled are:
* - axis.x.type='category' or 'timeseries
* - axis.x.tick.multiline=false
* - axis.x.tick.culling=false
* - axis.x.tick.fit=true
* - **NOTE:** axis.x.tick.clippath=false is necessary for calculating the overflow padding between the end of x axis and the width of the SVG
* @name axis․x․tick․autorotate
* @memberof Options
* @type {boolean}
* @default false
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.XAxisTickAutorotate)
* @example
* axis: {
* x: {
* tick: {
* rotate: 15,
* autorotate: true,
* multiline: false,
* culling: false,
* fit: true
* },
* clipPath: false
* }
* }
*/
axis_x_tick_autorotate: false,
/**
* Rotate x axis tick text.
* - If you set negative value, it will rotate to opposite direction.
* - Applied when [`axis.rotated`](#.axis%25E2%2580%25A4rotated) option is `false`.
* - As long as `axis_x_tick_fit` is set to `true` it will calculate an overflow for the y2 axis and add this value to the right padding.
* @name axis․x․tick․rotate
* @memberof Options
* @type {number}
* @default 0
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.RotateXAxisTickText)
* @example
* axis: {
* x: {
* tick: {
* rotate: 60
* }
* }
* }
*/
axis_x_tick_rotate: 0,
/**
* Show x axis outer tick.
* @name axis․x․tick․outer
* @memberof Options
* @type {boolean}
* @default true
* @example
* axis: {
* x: {
* tick: {
* outer: false
* }
* }
* }
*/
axis_x_tick_outer: true,
/**
* Set tick text to be multiline
* - **NOTE:**
* > When x tick text contains `\n`, it's used as line break and 'axis.x.tick.width' option is ignored.
* @name axis․x․tick․multiline
* @memberof Options
* @type {boolean}
* @default true
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.XAxisTickMultiline)
* @example
* axis: {
* x: {
* tick: {
* multiline: false
* }
* }
* }
* @example
* // example of line break with '\n'
* // In this case, 'axis.x.tick.width' is ignored
* data: {
* x: "x",
* columns: [
* ["x", "long\ntext", "Another\nLong\nText"],
* ...
* ],
* }
*/
axis_x_tick_multiline: true,
/**
* Set tick width
* - **NOTE:**
* > When x tick text contains `\n`, this option is ignored.
* @name axis․x․tick․width
* @memberof Options
* @type {number}
* @default null
* @example
* axis: {
* x: {
* tick: {
* width: 50
* }
* }
* }
*/
axis_x_tick_width: <number|null> null,
/**
* Set to display system tooltip(via `<title>` element) for tick text
* - **NOTE:** Only available for category axis type (`axis.x.type='category'`)
* @name axis․x․tick․tooltip
* @memberof Options
* @type {boolean}
* @default false
* @example
* axis: {
* x: {
* tick: {
* tooltip: true
* }
* }
* }
*/
axis_x_tick_tooltip: false,
/**
* Set max value of x axis range.
* @name axis․x․max
* @memberof Options
* @property {number} max Set the max value
* @property {boolean} [max.fit=false] When specified `max.value` is greater than the bound data value, setting `true` will make x axis max to be fitted to the bound data max value.
* - **NOTE:** If the bound data max value is greater than the `max.value`, the x axis max will be limited as the given `max.value`.
* @property {number} [max.value] Set the max value
* @example
* axis: {
* x: {
* max: 100,
*
* max: {
* // 'fit=true' will make x axis max to be limited as the bound data value max when 'max.value' is greater.
* // - when bound data max is '10' and max.value: '100' ==> x axis max will be '10'
* // - when bound data max is '1000' and max.value: '100' ==> x axis max will be '100'
* fit: true,
* value: 100
* }
* }
* }
*/
axis_x_max: <number|undefined> undefined,
/**
* Set min value of x axis range.
* @name axis․x․min
* @memberof Options
* @property {number} min Set the min value
* @property {boolean} [min.fit=false] When specified `min.value` is lower than the bound data value, setting `true` will make x axis min to be fitted to the bound data min value.
* - **NOTE:** If the bound data min value is lower than the `min.value`, the x axis min will be limited as the given `min.value`.
* @property {number} [min.value] Set the min value
* @example
* axis: {
* x: {
* min: -100,
*
* min: {
* // 'fit=true' will make x axis min to be limited as the bound data value min when 'min.value' is lower.
* // - when bound data min is '-10' and min.value: '-100' ==> x axis min will be '-10'
* // - when bound data min is '-1000' and min.value: '-100' ==> x axis min will be '-100'
* fit: true,
* value: -100
* }
* }
* }
*/
axis_x_min: <number|undefined> undefined,
/**
* Change the direction of x axis.<br><br>
* If true set, the direction will be `right -> left`.
* @name axis․x․inverted
* @memberof Options
* @type {boolean}
* @default false
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.InvertedAxis)
* @example
* axis: {
* x: {
* inverted: true
* }
* }
*/
axis_x_inverted: false,
/**
* Set padding for x axis.<br><br>
* If this option is set, the range of x axis will increase/decrease according to the values.
* If no padding is needed in the rage of x axis, 0 should be set.
* By default, left/right padding are set depending on x axis type or chart types.
* - **NOTE:**
* - The meaning of padding values, differs according axis types:<br>
* - **category/indexed:** The unit of tick value
* ex. the given value `1`, is same as the width of 1 tick width
* - **timeseries:** Numeric time value
* ex. the given value `1000*60*60*24`, which is numeric time equivalent of a day, is same as the width of 1 tick width
* - If want values to be treated as pixels, specify `unit:"px"`.
* - The pixel value will be convered based on the scale values. Hence can not reflect accurate padding result.
* @name axis․x․padding
* @memberof Options
* @type {object|number}
* @default {}
* @example
* axis: {
* x: {
* padding: {
* // when axis type is 'category'
* left: 1, // set left padding width of equivalent value of a tick's width
* right: 0.5 // set right padding width as half of equivalent value of tick's width
*
* // when axis type is 'timeseries'
* left: 1000*60*60*24, // set left padding width of equivalent value of a day tick's width
* right: 1000*60*60*12 // set right padding width as half of equivalent value of a day tick's width
* },
*
* // or set both values at once.
* padding: 10,
*
* // or set padding values as pixel unit.
* padding: {
* left: 100,
* right: 50,
* unit: "px"
* },
* }
* }
*/
axis_x_padding: <number|{left?: number; right?: number;}> {},
/**
* Set height of x axis.<br><br>
* The height of x axis can be set manually by this option. If you need more space for x axis, please use this option for that. The unit is pixel.
* @name axis․x․height
* @memberof Options
* @type {number}
* @default undefined
* @example
* axis: {
* x: {
* height: 20
* }
* }
*/
axis_x_height: <number|undefined> undefined,
/**
* Set default extent for subchart and zoom. This can be an array or function that returns an array.
* @name axis․x․extent
* @memberof Options
* @type {Array|Function}
* @default undefined
* @example
* axis: {
* x: {
* // extent range as a pixel value
* extent: [0, 200],
*
* // when axis is 'timeseries', parsable datetime string
* extent: ["2019-03-01", "2019-03-05"],
*
* // return extent value
* extent: function(domain, scale) {
* var extent = domain.map(function(v) {
* return scale(v);
* });
*
* // it should return a format of array
* // ex) [0, 584]
* return extent;
* }
* }
* }
*/
axis_x_extent: <(number|string)[]|Function|undefined> undefined,
/**
* Set label on x axis.<br><br>
* You can set x axis label and change its position by this option.
* `string` and `object` can be passed and we can change the poisiton by passing object that has position key.<br>
* Available position differs according to the axis direction (vertical or horizontal).
* If string set, the position will be the default.
*
* - **If it's horizontal axis:**
* - inner-right [default]
* - inner-center
* - inner-left
* - outer-right
* - outer-center
* - outer-left
* - **If it's vertical axis:**
* - inner-top [default]
* - inner-middle
* - inner-bottom
* - outer-top
* - outer-middle
* - outer-bottom
* @name axis․x․label
* @memberof Options
* @type {string|object}
* @default undefined
* @example
* axis: {
* x: {
* label: "Your X Axis"
* }
* }
*
* axis: {
* x: {
* label: {
* text: "Your X Axis",
* position: "outer-center"
* }
* }
* }
*/
axis_x_label: {},
/**
* Set additional axes for x Axis.
* - **NOTE:** Axis' scale is based on x Axis value if domain option isn't set.
*
* Each axis object should consist with following options:
*
* | Name | Type | Default | Description |
* | --- | --- | --- | --- |
* | domain | Array | - | Set the domain value |
* | tick.outer | boolean | true | Show outer tick |
* | tick.format | Function | - | Set formatter for tick text |
* | tick.count | Number | - | Set the number of y axis ticks |
* | tick.values | Array | - | Set tick values manually |
* @name axis․x․axes
* @memberof Options
* @type {Array}
* @see [Demo](https://naver.github.io/billboard.js/demo/#Axis.MultiAxes)
* @see [Demo: Domain](https://naver.github.io/billboard.js/demo/#Axis.MultiAxesDomain)
* @example
* x: {
* axes: [
* {
* // if set, will not be correlated with the main x Axis domain value
* domain: [0, 1000],
* tick: {
* outer: false,
* format: function(x) {
* return x + "%";
* },
* count: 2,
* values: [10, 20, 30]
* }
* },
* ...
* ]
* }
*/
axis_x_axes: <object[]>[]
};