@nebula.js/sn-grid-chart
Version:
A grid from two dimensions with symbols of varying size based on a measure.
535 lines (371 loc) • 26.2 kB
Markdown
# API Reference
- [properties](#properties) : <code>object</code>
- [.version](#properties.version) : <code>string</code>
- [.dataPoint](#properties.dataPoint) : <code>object</code>
- [.rangeBubbleSizes](#properties.dataPoint.rangeBubbleSizes) : <code>array</code>
- [.symbol](#properties.dataPoint.symbol) : <code>'circle'</code> \| <code>'cross'</code> \| <code>'diamond'</code> \| <code>'line'</code> \| <code>'saltire'</code> \| <code>'square'</code> \| <code>'star'</code> \| <code>'triangle'</code>
- [.showLabels](#properties.dataPoint.showLabels) : <code>'auto'</code> \| <code>'off'</code>
- [.color](#properties.color) : <code>object</code>
- [.auto](#properties.color.auto) : <code>boolean</code>
- [.autoMinMax](#properties.color.autoMinMax) : <code>boolean</code>
- [.byDimDef](#properties.color.byDimDef) : [<code>byDimDef</code>](#byDimDef)
- [.byMeasureDef](#properties.color.byMeasureDef) : [<code>byMeasureDef</code>](#byMeasureDef)
- [.colorExpression](#properties.color.colorExpression) : <code>string</code>
- [.dimensionScheme](#properties.color.dimensionScheme) : <code>string</code>
- [.expressionIsColor](#properties.color.expressionIsColor) : <code>boolean</code>
- [.expressionLabel](#properties.color.expressionLabel) : <code>string</code>
- [.measureMin](#properties.color.measureMin) : <code>ValueExpression</code>
- [.measureMax](#properties.color.measureMax) : <code>ValueExpression</code>
- [.measureScheme](#properties.color.measureScheme) : <code>'sg'</code> \| <code>'sc'</code> \| <code>'dg'</code> \| <code>'dc'</code>
- [.mode](#properties.color.mode) : <code>'primary'</code> \| <code>'byDimension'</code> \| <code>'byExpression'</code> \| <code>'byMeasure'</code> \| <code>'byMultiple'</code>
- [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
- [.reverseScheme](#properties.color.reverseScheme) : <code>boolean</code>
- ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
- [.useBaseColors](#properties.color.useBaseColors) : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
- [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
- [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
- [.footnote](#properties.footnote) : <code>string</code> \| <code>StringExpression</code>
- [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ <code>HyperCubeDef</code>
- [.qDimensions](#properties.qHyperCubeDef.qDimensions) : <code>Array.<NxDimension></code>
- [.qMeasures](#properties.qHyperCubeDef.qMeasures) : <code>Array.<NxMeasure></code>
- [.qAlwaysFullyExpanded](#properties.qHyperCubeDef.qAlwaysFullyExpanded) : <code>boolean</code>
- [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : <code>boolean</code>
- [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : <code>boolean</code>
- [.qMode](#properties.qHyperCubeDef.qMode) : <code>string</code>
- [.showTitles](#properties.showTitles) : <code>boolean</code>
- [.title](#properties.title) : <code>string</code> \| <code>StringExpression</code>
- [.subtitle](#properties.subtitle) : <code>string</code> \| <code>StringExpression</code>
- [.showDetails](#properties.showDetails) : <code>boolean</code>
- [.xAxis](#properties.xAxis) : <code>object</code>
- [.axisDisplayMode](#properties.xAxis.axisDisplayMode) : <code>'auto'</code> \| <code>'custom'</code> \| <code>'max'</code>
- [.dock](#properties.xAxis.dock) : <code>'near'</code> \| <code>'far'</code>
- [.show](#properties.xAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
- [.label](#properties.xAxis.label) : <code>'auto'</code> \| <code>'horizontal'</code> \| <code>'tilted'</code>
- [.maxVisibleItems](#properties.xAxis.maxVisibleItems) : <code>number</code> \| <code>ValueExpression</code>
- [.gridLines](#properties.xAxis.gridLines) : <code>boolean</code>
- [.yAxis](#properties.yAxis) : <code>object</code>
- [.axisDisplayMode](#properties.yAxis.axisDisplayMode) : <code>'auto'</code> \| <code>'custom'</code> \| <code>'max'</code>
- [.show](#properties.yAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
- [.dock](#properties.yAxis.dock) : <code>'near'</code> \| <code>'far'</code>
- [.maxVisibleItems](#properties.yAxis.maxVisibleItems) : <code>number</code> \| <code>ValueExpression</code>
- [.gridLines](#properties.yAxis.gridLines) : <code>boolean</code>
- [.mode](#properties.mode) : <code>'default'</code> \| <code>'heatmap'</code>
---
<a name="properties.version"></a>
### properties.version : <code>string</code>
Current version of this generic object definition
**Kind**: static property of [<code>properties</code>](#properties)
<a name="properties.dataPoint"></a>
### properties.dataPoint : <code>object</code>
Data point settings.
**Kind**: static property of [<code>properties</code>](#properties)
- [.dataPoint](#properties.dataPoint) : <code>object</code>
- [.rangeBubbleSizes](#properties.dataPoint.rangeBubbleSizes) : <code>array</code>
- [.symbol](#properties.dataPoint.symbol) : <code>'circle'</code> \| <code>'cross'</code> \| <code>'diamond'</code> \| <code>'line'</code> \| <code>'saltire'</code> \| <code>'square'</code> \| <code>'star'</code> \| <code>'triangle'</code>
- [.showLabels](#properties.dataPoint.showLabels) : <code>'auto'</code> \| <code>'off'</code>
<a name="properties.dataPoint.rangeBubbleSizes"></a>
#### dataPoint.rangeBubbleSizes : <code>array</code>
Symbol size setting.
Can be a value between 0.1 and 1.
**Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
**Default**: <code>[0.1, 0.4]</code>
<a name="properties.dataPoint.symbol"></a>
#### dataPoint.symbol : <code>'circle'</code> \| <code>'cross'</code> \| <code>'diamond'</code> \| <code>'line'</code> \| <code>'saltire'</code> \| <code>'square'</code> \| <code>'star'</code> \| <code>'triangle'</code>
Symbol used for representation in grid.
**Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
**Default**: <code>"circle"</code>
<a name="properties.dataPoint.showLabels"></a>
#### dataPoint.showLabels : <code>'auto'</code> \| <code>'off'</code>
Show labels for data points.
**Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
**Default**: <code>"off"</code>
<a name="properties.color"></a>
### properties.color : <code>object</code>
Color settings.
Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting `"auto": false` which turns off auto-coloring.
If `"auto": true`, no other properties need to be defined in the color object.
Note: Some of the color properties are depending on which theme is currently being used.
**Kind**: static property of [<code>properties</code>](#properties)
- [.color](#properties.color) : <code>object</code>
- [.auto](#properties.color.auto) : <code>boolean</code>
- [.autoMinMax](#properties.color.autoMinMax) : <code>boolean</code>
- [.byDimDef](#properties.color.byDimDef) : [<code>byDimDef</code>](#byDimDef)
- [.byMeasureDef](#properties.color.byMeasureDef) : [<code>byMeasureDef</code>](#byMeasureDef)
- [.colorExpression](#properties.color.colorExpression) : <code>string</code>
- [.dimensionScheme](#properties.color.dimensionScheme) : <code>string</code>
- [.expressionIsColor](#properties.color.expressionIsColor) : <code>boolean</code>
- [.expressionLabel](#properties.color.expressionLabel) : <code>string</code>
- [.measureMin](#properties.color.measureMin) : <code>ValueExpression</code>
- [.measureMax](#properties.color.measureMax) : <code>ValueExpression</code>
- [.measureScheme](#properties.color.measureScheme) : <code>'sg'</code> \| <code>'sc'</code> \| <code>'dg'</code> \| <code>'dc'</code>
- [.mode](#properties.color.mode) : <code>'primary'</code> \| <code>'byDimension'</code> \| <code>'byExpression'</code> \| <code>'byMeasure'</code> \| <code>'byMultiple'</code>
- [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
- [.reverseScheme](#properties.color.reverseScheme) : <code>boolean</code>
- ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
- [.useBaseColors](#properties.color.useBaseColors) : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
- [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
- [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
<a name="properties.color.auto"></a>
#### color.auto : <code>boolean</code>
Set to use automatic coloring.
When `"auto": true`, color settings are based on the visualization used and the number of dimensions
and measures, that is, the settings are not fixed, but are dependent on the data input.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>true</code>
<a name="properties.color.autoMinMax"></a>
#### color.autoMinMax : <code>boolean</code>
Set to false to define custom color range. Custom color range is only applicable when coloring is by measure (`"mode": "byMeasure"`) or by expression (`"mode": "byExpression"`).
When coloring is by expression, `"expressionIsColor": "false"` must be set for custom color range to work.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>true</code>
<a name="properties.color.byDimDef"></a>
#### color.byDimDef : [<code>byDimDef</code>](#byDimDef)
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>undefined</code>
<a name="properties.color.byMeasureDef"></a>
#### color.byMeasureDef : [<code>byMeasureDef</code>](#byMeasureDef)
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>undefined</code>
<a name="properties.color.colorExpression"></a>
#### color.colorExpression : <code>string</code>
Sets the color expression to be used when `"mode": "byExpression"` is defined.
Expression can evaluate either to a numerical value or a color code if `"expressionIsColor": true`.
Supported formats are: `RGB`, `ARGB` and `HSL`
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>"undefined"</code>
**Example**
```js
"colorExpression": "=if(sum(Sales)<avg(Total aggr(sum(Sales),Product)),rgb(255,0,0),RGB(0,255,0))"
```
<a name="properties.color.dimensionScheme"></a>
#### color.dimensionScheme : <code>string</code>
Color scheme when `"mode": "byDimension"` or `"mode": "byMultiple"` (`"12"` or `"100"` for most themes).
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>"12"</code>
<a name="properties.color.expressionIsColor"></a>
#### color.expressionIsColor : <code>boolean</code>
Set to define whether the result of the expression is a valid CSS3 color.
Only applicable when `"mode": "byExpression"`.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>true</code>
<a name="properties.color.expressionLabel"></a>
#### color.expressionLabel : <code>string</code>
Label to be defined on tool tips when using a coloring expression.
Only used if `"expressionIsColor": false`.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>""</code>
<a name="properties.color.measureMin"></a>
#### color.measureMin : <code>ValueExpression</code>
Set the min value for the color range.
Only applicable if `"autoMinMax": false`.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>undefined</code>
<a name="properties.color.measureMax"></a>
#### color.measureMax : <code>ValueExpression</code>
Set the max value for the color range.
Only applicable if `"autoMinMax": false`.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>undefined</code>
<a name="properties.color.measureScheme"></a>
#### color.measureScheme : <code>'sg'</code> \| <code>'sc'</code> \| <code>'dg'</code> \| <code>'dc'</code>
Color scheme when `"mode": "byMeasure"`. Can be one of:
- `sg`: (sequential gradient) the transition between the different color groups is made using different shades of colors. High measure values have darker hues
- `sc`: (sequential classes) the transition between the different color groups is made using distinctly different colors.
- `dg`: (diverging gradient) used when working with data that is ordered from low to high, for instance, to show the relationship between different areas on a map. Low and high values have dark colors, mid-range colors are light.
- `dc`: (diverging classes) can be seen as two sequential classes combined, with the mid-range shared. The two extremes, high and low, are emphasized with dark colors with contrasting hues, and the mid-range critical values are emphasized with light colors.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>"sg"</code>
<a name="properties.color.mode"></a>
#### color.mode : <code>'primary'</code> \| <code>'byDimension'</code> \| <code>'byExpression'</code> \| <code>'byMeasure'</code> \| <code>'byMultiple'</code>
Sets the coloring mode for the visualization when auto-coloring has been switched off (`"auto": false`). Can be one of:
- `primary`: a single color (by default blue) is used for all items in the chart. In visualizations that do not benefit from multiple colors (bar charts with one dimension and scatter plots), single color is the default setting.
- `byDimension`: coloring is based upon the amount of dimension values. Details are set in the `"byDimDef"` property.
!Note: `byDimension` can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below.
```json
{
"qDef": {
"qFieldDefs": ["NetScoreName"]
},
"qAttributeDimensions": [
{
"qDef": "NetScoreName",
"id": "colorByAlternative",
"label": "Year"
}
]
}
```
- `byExpression`: coloring is based on an expression, which in most cases is a color code. Details are set in the `"expressionIsColor"`, `"expressionLabel`" and `"colorExpression"` properties.
- `byMeasure`: coloring is based on the measure value. Details are set in the `"byMeasureDef"` property.
- `byMultiple`: can be used when more than one measure is used. By default, 12 colors are used for the dimensions. The colors are reused when there are more than 12 dimension values.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>"primary"</code>
<a name="properties.color.paletteColor"></a>
#### color.paletteColor : [<code>paletteColor</code>](#paletteColor)
The paletteColor object is used to define the color when you color by single color `("mode": "primary")`.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>{ index: 6 }</code>
<a name="properties.color.reverseScheme"></a>
#### color.reverseScheme : <code>boolean</code>
Set to reverse the color scheme.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>false</code>
<a name="properties.color.singleColor"></a>
#### ~~color.singleColor : <code>number</code>~~
**_Use `paletteColor` instead._**
**Kind**: static property of [<code>color</code>](#properties.color)
<a name="properties.color.useBaseColors"></a>
#### color.useBaseColors : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
Use colors encoded in master items.
Only applicable when `"mode": "primary"` or `"mode": "byMultiple"` has been defined.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>"off"</code>
<a name="properties.color.useDimColVal"></a>
#### color.useDimColVal : <code>boolean</code>
Set to true if you want to apply the colors defined for library dimensions when used.
Only applicable if `'colorMode': 'byDimension'`.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>true</code>
<a name="properties.color.useMeasureGradient"></a>
#### color.useMeasureGradient : <code>boolean</code>
Set to true if you want to apply the colors defined for library measures when used. Only applicable if `"mode": "byMeasure"`.
**Kind**: static property of [<code>color</code>](#properties.color)
**Default**: <code>true</code>
<a name="properties.footnote"></a>
### properties.footnote : <code>string</code> \| <code>StringExpression</code>
Visualization footnote.
**Kind**: static property of [<code>properties</code>](#properties)
<a name="properties.qHyperCubeDef"></a>
### properties.qHyperCubeDef ⇐ <code>HyperCubeDef</code>
Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
**Kind**: static property of [<code>properties</code>](#properties)
**Extends**: <code>HyperCubeDef</code>
- [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ <code>HyperCubeDef</code>
- [.qDimensions](#properties.qHyperCubeDef.qDimensions) : <code>Array.<NxDimension></code>
- [.qMeasures](#properties.qHyperCubeDef.qMeasures) : <code>Array.<NxMeasure></code>
- [.qAlwaysFullyExpanded](#properties.qHyperCubeDef.qAlwaysFullyExpanded) : <code>boolean</code>
- [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : <code>boolean</code>
- [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : <code>boolean</code>
- [.qMode](#properties.qHyperCubeDef.qMode) : <code>string</code>
<a name="properties.qHyperCubeDef.qDimensions"></a>
#### qHyperCubeDef.qDimensions : <code>Array.<NxDimension></code>
**Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
<a name="properties.qHyperCubeDef.qMeasures"></a>
#### qHyperCubeDef.qMeasures : <code>Array.<NxMeasure></code>
**Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
<a name="properties.qHyperCubeDef.qAlwaysFullyExpanded"></a>
#### qHyperCubeDef.qAlwaysFullyExpanded : <code>boolean</code>
**Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
**Default**: <code>true</code>
<a name="properties.qHyperCubeDef.qSuppressZero"></a>
#### qHyperCubeDef.qSuppressZero : <code>boolean</code>
**Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
**Default**: <code>false</code>
<a name="properties.qHyperCubeDef.qSuppressMissing"></a>
#### qHyperCubeDef.qSuppressMissing : <code>boolean</code>
**Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
**Default**: <code>true</code>
<a name="properties.qHyperCubeDef.qMode"></a>
#### qHyperCubeDef.qMode : <code>string</code>
Needs to be "T" in order for grid-chart to work properly
**Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
**Default**: <code>"\"T\""</code>
<a name="properties.showTitles"></a>
### properties.showTitles : <code>boolean</code>
Show title for the visualization
**Kind**: static property of [<code>properties</code>](#properties)
**Default**: <code>true</code>
<a name="properties.title"></a>
### properties.title : <code>string</code> \| <code>StringExpression</code>
Visualization title.
**Kind**: static property of [<code>properties</code>](#properties)
<a name="properties.subtitle"></a>
### properties.subtitle : <code>string</code> \| <code>StringExpression</code>
Visualization subtitle.
**Kind**: static property of [<code>properties</code>](#properties)
<a name="properties.showDetails"></a>
### properties.showDetails : <code>boolean</code>
Show visualization details toggle
**Kind**: static property of [<code>properties</code>](#properties)
<a name="properties.xAxis"></a>
### properties.xAxis : <code>object</code>
X-axis settings.
**Kind**: static property of [<code>properties</code>](#properties)
- [.xAxis](#properties.xAxis) : <code>object</code>
- [.axisDisplayMode](#properties.xAxis.axisDisplayMode) : <code>'auto'</code> \| <code>'custom'</code> \| <code>'max'</code>
- [.dock](#properties.xAxis.dock) : <code>'near'</code> \| <code>'far'</code>
- [.show](#properties.xAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
- [.label](#properties.xAxis.label) : <code>'auto'</code> \| <code>'horizontal'</code> \| <code>'tilted'</code>
- [.maxVisibleItems](#properties.xAxis.maxVisibleItems) : <code>number</code> \| <code>ValueExpression</code>
- [.gridLines](#properties.xAxis.gridLines) : <code>boolean</code>
<a name="properties.xAxis.axisDisplayMode"></a>
#### xAxis.axisDisplayMode : <code>'auto'</code> \| <code>'custom'</code> \| <code>'max'</code>
Set to specify axis display mode (number of items).
**Kind**: static property of [<code>xAxis</code>](#properties.xAxis)
**Default**: <code>"auto"</code>
<a name="properties.xAxis.dock"></a>
#### xAxis.dock : <code>'near'</code> \| <code>'far'</code>
Axis docking position
**Kind**: static property of [<code>xAxis</code>](#properties.xAxis)
**Default**: <code>"far"</code>
<a name="properties.xAxis.show"></a>
#### xAxis.show : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
Labels and title
**Kind**: static property of [<code>xAxis</code>](#properties.xAxis)
**Default**: <code>"all"</code>
<a name="properties.xAxis.label"></a>
#### xAxis.label : <code>'auto'</code> \| <code>'horizontal'</code> \| <code>'tilted'</code>
Label orientation
**Kind**: static property of [<code>xAxis</code>](#properties.xAxis)
**Default**: <code>"auto"</code>
<a name="properties.xAxis.maxVisibleItems"></a>
#### xAxis.maxVisibleItems : <code>number</code> \| <code>ValueExpression</code>
Only applied when axisDisplayMode is custom.
Max is 55 for performance reasons.
**Kind**: static property of [<code>xAxis</code>](#properties.xAxis)
**Default**: <code>10</code>
<a name="properties.xAxis.gridLines"></a>
#### xAxis.gridLines : <code>boolean</code>
Vertical grid lines
**Kind**: static property of [<code>xAxis</code>](#properties.xAxis)
<a name="properties.yAxis"></a>
### properties.yAxis : <code>object</code>
Y-axis settings.
**Kind**: static property of [<code>properties</code>](#properties)
- [.yAxis](#properties.yAxis) : <code>object</code>
- [.axisDisplayMode](#properties.yAxis.axisDisplayMode) : <code>'auto'</code> \| <code>'custom'</code> \| <code>'max'</code>
- [.show](#properties.yAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
- [.dock](#properties.yAxis.dock) : <code>'near'</code> \| <code>'far'</code>
- [.maxVisibleItems](#properties.yAxis.maxVisibleItems) : <code>number</code> \| <code>ValueExpression</code>
- [.gridLines](#properties.yAxis.gridLines) : <code>boolean</code>
<a name="properties.yAxis.axisDisplayMode"></a>
#### yAxis.axisDisplayMode : <code>'auto'</code> \| <code>'custom'</code> \| <code>'max'</code>
Set to specify axis display mode (number of items).
**Kind**: static property of [<code>yAxis</code>](#properties.yAxis)
**Default**: <code>"auto"</code>
<a name="properties.yAxis.show"></a>
#### yAxis.show : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
Labels and title
**Kind**: static property of [<code>yAxis</code>](#properties.yAxis)
**Default**: <code>"all"</code>
<a name="properties.yAxis.dock"></a>
#### yAxis.dock : <code>'near'</code> \| <code>'far'</code>
Axis docking position
**Kind**: static property of [<code>yAxis</code>](#properties.yAxis)
**Default**: <code>"far"</code>
<a name="properties.yAxis.maxVisibleItems"></a>
#### yAxis.maxVisibleItems : <code>number</code> \| <code>ValueExpression</code>
Only applied when axisDisplayMode is custom.
Max is 55 for performance reasons.
**Kind**: static property of [<code>yAxis</code>](#properties.yAxis)
**Default**: <code>10</code>
<a name="properties.yAxis.gridLines"></a>
#### yAxis.gridLines : <code>boolean</code>
Horizontal grid lines
**Kind**: static property of [<code>yAxis</code>](#properties.yAxis)
<a name="properties.mode"></a>
### properties.mode : <code>'default'</code> \| <code>'heatmap'</code>
Chart mode.
**Kind**: static property of [<code>properties</code>](#properties)
**Default**: <code>"default"</code>
# Definitions