# API Reference * [properties](#properties) : object * [.version](#properties.version) : string * [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ HyperCubeDef * [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [Array.<MeasureProperties>](#MeasureProperties) * [.color](#properties.color) : object * [.auto](#properties.color.auto) : boolean * [.positiveValue](#properties.color.positiveValue) : object * [.paletteColor](#properties.color.positiveValue.paletteColor) : [paletteColor](#paletteColor) * [.negativeValue](#properties.color.negativeValue) : object * [.paletteColor](#properties.color.negativeValue.paletteColor) : [paletteColor](#paletteColor) * [.subtotal](#properties.color.subtotal) : object * [.paletteColor](#properties.color.subtotal.paletteColor) : [paletteColor](#paletteColor) * [.dataPoint](#properties.dataPoint) : object * [.showLabels](#properties.dataPoint.showLabels) : boolean * [.dimensionAxis](#properties.dimensionAxis) : object * [.dock](#properties.dimensionAxis.dock) : 'near' \| 'far' * [.label](#properties.dimensionAxis.label) : 'auto' \| 'horizontal' \| 'tilted' * [.show](#properties.dimensionAxis.show) : 'labels' \| 'none' * [.gridlines](#properties.gridlines) : object * [.auto](#properties.gridlines.auto) : boolean * [.spacing](#properties.gridlines.spacing) : 0 \| 2 \| 3 * [.legend](#properties.legend) : object * [.dock](#properties.legend.dock) : 'auto' \| 'right' \| 'left' \| 'bottom' \| 'top' * [.show](#properties.legend.show) : boolean * [.measureAxis](#properties.measureAxis) : object * [.autoMinMax](#properties.measureAxis.autoMinMax) : boolean * [.dock](#properties.measureAxis.dock) : 'near' \| 'far' * [.max](#properties.measureAxis.max) : number \| ValueExpression * [.min](#properties.measureAxis.min) : number \| ValueExpression * [.minMax](#properties.measureAxis.minMax) : 'min' \| 'max' \| 'minMax' * [.show](#properties.measureAxis.show) : 'labels' \| 'none' * [.spacing](#properties.measureAxis.spacing) : number * [.refLine](#properties.refLine) : object * [.refLines](#properties.refLine.refLines) : [Array.<refLine>](#refLine) * [.showTitles](#properties.showTitles) : boolean * [.subtitle](#properties.subtitle) : string \| StringExpression * [.title](#properties.title) : string \| StringExpression * [.footnote](#properties.footnote) : string \| StringExpression --- ### properties.version : string Current version of this generic object definition. **Kind**: static property of [properties](#properties) ### properties.qHyperCubeDef ⇐ HyperCubeDef Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`. **Kind**: static property of [properties](#properties) **Extends**: HyperCubeDef #### qHyperCubeDef.qMeasures : [Array.<MeasureProperties>](#MeasureProperties) **Kind**: static property of [qHyperCubeDef](#properties.qHyperCubeDef) ### properties.color : object 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 [properties](#properties) * [.color](#properties.color) : object * [.auto](#properties.color.auto) : boolean * [.positiveValue](#properties.color.positiveValue) : object * [.paletteColor](#properties.color.positiveValue.paletteColor) : [paletteColor](#paletteColor) * [.negativeValue](#properties.color.negativeValue) : object * [.paletteColor](#properties.color.negativeValue.paletteColor) : [paletteColor](#paletteColor) * [.subtotal](#properties.color.subtotal) : object * [.paletteColor](#properties.color.subtotal.paletteColor) : [paletteColor](#paletteColor) #### color.auto : boolean 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 [color](#properties.color) **Default**: true #### color.positiveValue : object Positive value color. **Kind**: static property of [color](#properties.color) ##### positiveValue.paletteColor : [paletteColor](#paletteColor) paletteColor **Kind**: static property of [positiveValue](#properties.color.positiveValue) **Default**: { index: 6, color: null } #### color.negativeValue : object Negative value color. **Kind**: static property of [color](#properties.color) ##### negativeValue.paletteColor : [paletteColor](#paletteColor) paletteColor **Kind**: static property of [negativeValue](#properties.color.negativeValue) **Default**: { index: -1, color: '#cc6677' } #### color.subtotal : object Subtotal value color. **Kind**: static property of [color](#properties.color) ##### subtotal.paletteColor : [paletteColor](#paletteColor) paletteColor **Kind**: static property of [subtotal](#properties.color.subtotal) **Default**: { index: -1, color: '#c3c3c3' } ### properties.dataPoint : object Data point. **Kind**: static property of [properties](#properties) #### dataPoint.showLabels : boolean Show labels. **Kind**: static property of [dataPoint](#properties.dataPoint) **Default**: true ### properties.dimensionAxis : object Dimension axis settings. **Kind**: static property of [properties](#properties) * [.dimensionAxis](#properties.dimensionAxis) : object * [.dock](#properties.dimensionAxis.dock) : 'near' \| 'far' * [.label](#properties.dimensionAxis.label) : 'auto' \| 'horizontal' \| 'tilted' * [.show](#properties.dimensionAxis.show) : 'labels' \| 'none' #### dimensionAxis.dock : 'near' \| 'far' Axis docking position **Kind**: static property of [dimensionAxis](#properties.dimensionAxis) **Default**: "near" #### dimensionAxis.label : 'auto' \| 'horizontal' \| 'tilted' Label orientation **Kind**: static property of [dimensionAxis](#properties.dimensionAxis) #### dimensionAxis.show : 'labels' \| 'none' Labels and title **Kind**: static property of [dimensionAxis](#properties.dimensionAxis) **Default**: labels ### properties.gridlines : object Grid lines settings. **Kind**: static property of [properties](#properties) * [.gridlines](#properties.gridlines) : object * [.auto](#properties.gridlines.auto) : boolean * [.spacing](#properties.gridlines.spacing) : 0 \| 2 \| 3 #### gridlines.auto : boolean Automatic grid line spacing. **Kind**: static property of [gridlines](#properties.gridlines) **Default**: true #### gridlines.spacing : 0 \| 2 \| 3 Grid line spacing. Used only when auto is set to false. **Kind**: static property of [gridlines](#properties.gridlines) **Default**: 2 ### properties.legend : object Legend settings. **Kind**: static property of [properties](#properties) * [.legend](#properties.legend) : object * [.dock](#properties.legend.dock) : 'auto' \| 'right' \| 'left' \| 'bottom' \| 'top' * [.show](#properties.legend.show) : boolean #### legend.dock : 'auto' \| 'right' \| 'left' \| 'bottom' \| 'top' Sets the legend position. **Kind**: static property of [legend](#properties.legend) **Default**: 'auto' #### legend.show : boolean Set to show the legend. **Kind**: static property of [legend](#properties.legend) **Default**: true ### properties.measureAxis : object Measure axis settings. **Kind**: static property of [properties](#properties) * [.measureAxis](#properties.measureAxis) : object * [.autoMinMax](#properties.measureAxis.autoMinMax) : boolean * [.dock](#properties.measureAxis.dock) : 'near' \| 'far' * [.max](#properties.measureAxis.max) : number \| ValueExpression * [.min](#properties.measureAxis.min) : number \| ValueExpression * [.minMax](#properties.measureAxis.minMax) : 'min' \| 'max' \| 'minMax' * [.show](#properties.measureAxis.show) : 'labels' \| 'none' * [.spacing](#properties.measureAxis.spacing) : number #### measureAxis.autoMinMax : boolean Automatic max/min **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: true #### measureAxis.dock : 'near' \| 'far' Axis docking position **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: "near" #### measureAxis.max : number \| ValueExpression Axis max value. `"autoMinMax"` must be set to false and `"minMax"` must be set to `"max"` or `"minMax"` to use this property **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: 10 #### measureAxis.min : number \| ValueExpression Axis min value. `"autoMinMax"` must be set to false and `"minMax"` must be set to `"min"` or `"minMax"` to use this property **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: 0 #### measureAxis.minMax : 'min' \| 'max' \| 'minMax' Set custom max/min **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: "min" #### measureAxis.show : 'labels' \| 'none' Labels and title **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: "labels" #### measureAxis.spacing : number Axis scale **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: 1 ### properties.refLine : object Reference lines settings **Kind**: static property of [properties](#properties) #### refLine.refLines : [Array.<refLine>](#refLine) Array of measure based reference line definitions **Kind**: static property of [refLine](#properties.refLine) ### properties.showTitles : boolean Show title for the visualization. **Kind**: static property of [properties](#properties) **Default**: true ### properties.subtitle : string \| StringExpression Visualization subtitle. **Kind**: static property of [properties](#properties) **Default**: "" ### properties.title : string \| StringExpression Visualization title. **Kind**: static property of [properties](#properties) **Default**: "" ### properties.footnote : string \| StringExpression Visualization footnote. **Kind**: static property of [properties](#properties) **Default**: "" # Definitions