# API Reference - [properties](#properties) : object - [.version](#properties.version) : string - [.color](#properties.color) : object - [.auto](#properties.color.auto) : boolean - [.mode](#properties.color.mode) - [.bar](#properties.color.bar) : [paletteColor](#paletteColor) - [.target](#properties.color.target) : [paletteColor](#paletteColor) - [.dimensionAxis](#properties.dimensionAxis) : object - [.dock](#properties.dimensionAxis.dock) : 'near' \| 'far' - [.label](#properties.dimensionAxis.label) : 'auto' \| 'horizontal' \| 'tilted' - [.show](#properties.dimensionAxis.show) : 'all' \| 'labels' \| 'title' \| 'none' - [.footnote](#properties.footnote) : string \| StringExpression - [.gridLine](#properties.gridLine) : object - [.auto](#properties.gridLine.auto) : boolean - [.spacing](#properties.gridLine.spacing) : 0 \| 1 \| 2 \| 3 - [.measureAxis](#properties.measureAxis) : object - [.commonAxis](#properties.measureAxis.commonAxis) : boolean - [.commonRange](#properties.measureAxis.commonRange) : boolean - [.dock](#properties.measureAxis.dock) : 'near' \| 'far' - [.show](#properties.measureAxis.show) : 'all' \| 'labels' \| 'title' \| 'none' - [.spacing](#properties.measureAxis.spacing) : number - [.orientation](#properties.orientation) : 'vertical' \| 'horizontal' - [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ HyperCubeDef - [.qDimensions](#properties.qHyperCubeDef.qDimensions) : [Array.<DimensionProperties>](#DimensionProperties) - [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [Array.<MeasureProperties>](#MeasureProperties) - [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : boolean - [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : boolean - [.scrollbar](#properties.scrollbar) : 'bar' \| 'none' - [.scrollStartPos](#properties.scrollStartPos) : number - [.showDetails](#properties.showDetails) : boolean - [.showTitles](#properties.showTitles) : boolean - [.subtitle](#properties.subtitle) : string \| StringExpression - [.title](#properties.title) : string \| StringExpression - [.tooltip](#properties.tooltip) : object - [.auto](#properties.tooltip.auto) : boolean - [.hideBasic](#properties.tooltip.hideBasic) : boolean - [.title](#properties.tooltip.title) : string \| StringExpression - [.description](#properties.tooltip.description) : string \| StringExpression - [.chart](#properties.tooltip.chart) : [MasterVisualizationChart](#MasterVisualizationChart) - [.imageComponents](#properties.tooltip.imageComponents) : [Array.<ImageComponent>](#ImageComponent) --- ### properties.version : string Current version of this generic object definition **Kind**: static property of [properties](#properties) ### 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. **Kind**: static property of [properties](#properties) - [.color](#properties.color) : object - [.auto](#properties.color.auto) : boolean - [.mode](#properties.color.mode) - [.bar](#properties.color.bar) : [paletteColor](#paletteColor) - [.target](#properties.color.target) : [paletteColor](#paletteColor) #### color.auto : boolean Set to use automatic coloring. When `"auto": true`, color settings are based on the visualization used. **Kind**: static property of [color](#properties.color) **Default**: true #### color.mode `primary`: a single color (by default blue) for all bar items and (by default black) for all target items in the bullet chart. **Kind**: static property of [color](#properties.color) **Default**: primary #### color.bar : [paletteColor](#paletteColor) The paletteColor object is used to define the color of bar. **Kind**: static property of [color](#properties.color) **Default**: { index: 6 } #### color.target : [paletteColor](#paletteColor) The target object is used to define the color of target. **Kind**: static property of [color](#properties.color) **Default**: { index: -1, color: '#000000' } ### 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) : 'all' \| 'labels' \| 'title' \| '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) **Default**: "auto" #### dimensionAxis.show : 'all' \| 'labels' \| 'title' \| 'none' Labels and title **Kind**: static property of [dimensionAxis](#properties.dimensionAxis) **Default**: "all" ### properties.footnote : string \| StringExpression Visualization footnote. **Kind**: static property of [properties](#properties) **Default**: "" ### properties.gridLine : object Grid lines settings. Used only when using commom axis. **Kind**: static property of [properties](#properties) - [.gridLine](#properties.gridLine) : object - [.auto](#properties.gridLine.auto) : boolean - [.spacing](#properties.gridLine.spacing) : 0 \| 1 \| 2 \| 3 #### gridLine.auto : boolean Automatic grid line spacing. **Kind**: static property of [gridLine](#properties.gridLine) **Default**: true #### gridLine.spacing : 0 \| 1 \| 2 \| 3 Grid line spacing. Used only when auto is set to false. **Kind**: static property of [gridLine](#properties.gridLine) **Default**: 2 ### properties.measureAxis : object Measure axis settings. **Kind**: static property of [properties](#properties) - [.measureAxis](#properties.measureAxis) : object - [.commonAxis](#properties.measureAxis.commonAxis) : boolean - [.commonRange](#properties.measureAxis.commonRange) : boolean - [.dock](#properties.measureAxis.dock) : 'near' \| 'far' - [.show](#properties.measureAxis.show) : 'all' \| 'labels' \| 'title' \| 'none' - [.spacing](#properties.measureAxis.spacing) : number #### measureAxis.commonAxis : boolean When set to true, use common axis. **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: false #### measureAxis.commonRange : boolean When set to true, use common range. **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: false #### measureAxis.dock : 'near' \| 'far' Axis docking position **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: "near" #### measureAxis.show : 'all' \| 'labels' \| 'title' \| 'none' Labels and title **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: "all" #### measureAxis.spacing : number Axis scale **Kind**: static property of [measureAxis](#properties.measureAxis) **Default**: 1 ### properties.orientation : 'vertical' \| 'horizontal' Orientation setting. If vertical, the dimension axis can only be docked on bottom or top and measure axis on left or right. **Kind**: static property of [properties](#properties) **Default**: "vertical" ### properties.qHyperCubeDef ⇐ HyperCubeDef Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`. **Kind**: static property of [properties](#properties) **Extends**: HyperCubeDef - [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ HyperCubeDef - [.qDimensions](#properties.qHyperCubeDef.qDimensions) : [Array.<DimensionProperties>](#DimensionProperties) - [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [Array.<MeasureProperties>](#MeasureProperties) - [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : boolean - [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : boolean #### qHyperCubeDef.qDimensions : [Array.<DimensionProperties>](#DimensionProperties) **Kind**: static property of [qHyperCubeDef](#properties.qHyperCubeDef) #### qHyperCubeDef.qMeasures : [Array.<MeasureProperties>](#MeasureProperties) **Kind**: static property of [qHyperCubeDef](#properties.qHyperCubeDef) #### qHyperCubeDef.qSuppressZero : boolean **Kind**: static property of [qHyperCubeDef](#properties.qHyperCubeDef) **Default**: false #### qHyperCubeDef.qSuppressMissing : boolean **Kind**: static property of [qHyperCubeDef](#properties.qHyperCubeDef) **Default**: true ### properties.scrollbar : 'bar' \| 'none' Sets the style of the scroll bar **Kind**: static property of [properties](#properties) **Default**: "bar" ### properties.scrollStartPos : number Scroll Alignment. If 0, then the scrollbar will start at the left/top of the chart, if 1 it starts at the right/bottom of the chart. Generally decides if the scroll starts at the beginning or end of the data **Kind**: static property of [properties](#properties) **Default**: 0 ### properties.showDetails : boolean Show visualization details toggle **Kind**: static property of [properties](#properties) **Default**: true ### 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.tooltip : object Custom tooltip properties **Kind**: static property of [properties](#properties) - [.tooltip](#properties.tooltip) : object - [.auto](#properties.tooltip.auto) : boolean - [.hideBasic](#properties.tooltip.hideBasic) : boolean - [.title](#properties.tooltip.title) : string \| StringExpression - [.description](#properties.tooltip.description) : string \| StringExpression - [.chart](#properties.tooltip.chart) : [MasterVisualizationChart](#MasterVisualizationChart) - [.imageComponents](#properties.tooltip.imageComponents) : [Array.<ImageComponent>](#ImageComponent) #### tooltip.auto : boolean Toggle for using custom tooltip or regular tooltip **Kind**: static property of [tooltip](#properties.tooltip) **Default**: true #### tooltip.hideBasic : boolean Toggle for hiding basic information from custom tooltip **Kind**: static property of [tooltip](#properties.tooltip) **Default**: false #### tooltip.title : string \| StringExpression Custom tooltip title. **Kind**: static property of [tooltip](#properties.tooltip) **Default**: "" #### tooltip.description : string \| StringExpression Custom tooltip description. **Kind**: static property of [tooltip](#properties.tooltip) **Default**: "" #### tooltip.chart : [MasterVisualizationChart](#MasterVisualizationChart) The chart object is used to define the chart displayed by the custom tooltip. **Kind**: static property of [tooltip](#properties.tooltip) **Default**: undefined #### tooltip.imageComponents : [Array.<ImageComponent>](#ImageComponent) The imageComponents objects are used to define the images displayed by the custom tooltip. **Kind**: static property of [tooltip](#properties.tooltip) **Default**: undefined # Definitions ## AttributeExpressionProperties : [AttributeExpressions](#AttributeExpressions) \| [CustomTooltipAttributes](#CustomTooltipAttributes) **Kind**: global typedef