Bar chart properties

These are the properties used by Qlik Sense bar charts.

Properties

version

Type: String

Current version of this generic object definition.

Default: 1.0.0

showTitles

Type: Boolean

Show title for the visualization.

Default: true.

showDetails

Type: Boolean

Sets if visualization details should be shown.

Default: false

title

Type: String | qStringExpression

Visualization title shown if "showTitles": true.

subtitle

Type: String | qStringExpression

Visualization subtitle shown if "showTitles": true.

footnote

Type: String | qStringExpression

Visualization footnote shown if "showTitles": true.

disableNavMenu

Type: Boolean

Disables the hover menu in the visualization.

Default: false

showDisclaimer

Type: Boolean

Set to false to hide visualization disclaimers that appear at the bottom of the chart, such as limited data or the chart has negative values.

Default: true

qHyperCubeDef

Type: Object

The hypercube definition used by most visualizations.

A subset of the properties available in the qHyperCubeDef is presented here. For complete documentation of all available properties, see Engine API: HyperCubeDef.

qDimensions

Type: Array

Description: Extends NxDimension, see Engine API: NxDimension.

Additional properties:

qDef

Type: Object

Description: Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

qDef properties
Name	Type	Description
autoSort	Boolean	Set to automatically sort the dimension. Default: true
cId	String	ID used by the client. Must be unique within the current chart.
othersLabel	StringExpressionContainer	String expression container.

qAttributeDimensions

Type: Array

Description: Extends NxAttrDimDef, see Engine API: NxAttrDimDef.
- id
  
  Type: String
  
  One of:
  - colorByAlternative: colors the chart using different dimensions. Can be used together with color.mode="byDimension" for attribute dimensions.
  - colorByExpression: used together with color.mode="byExpression".
qAttributeExpressions

Type: Array

Description: Extends NxAttrExprDef, see Engine API: NxAttrExprDef.
- id
  
  Type: String
  
  Description: All qAttributeExpressions IDs are specifically for use with custom tooltips.
  - customTooltipExpression: An AttributeExpression with this ID sets the extra tooltip measure.
  - customTooltipTitle: An AttributeExpression with this ID sets the tooltip title.
  - customTooltipDescription: An AttributeExpression with this ID sets the tooltip description.
  - customTooltipImages: An AttributeExpression with this ID sets the tooltip image.

qMeasures

Type: Array

Description: Extends NxMeasure, see Engine API: NxMeasure.

The maximum number of measures that can be set for this chart type is 15.

Additional properties:

qDef

Type: Object

Description Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Additional properties:

autoSort

Type: Boolean

Description: Set to automatically sort the measure. Default: true.
cId

Type: String

Description: ID used by the client. Must be unique within the current chart.

modifiers

Type: Array

Description: Set to apply a modifier to a measure.

Available modifiers
Name	Type	Description
accumulation	Object	Only displayed when accumulation has been set as a modifier. It allows you to accumulate values of your measure over one or two dimensions. Properties: accumulationDimension: Type: Integer. Only displayed when there are two dimensions. Selects the dimension on which the accumulation will take place. If the accumulation is made across multiple dimensions, this will be the first dimension. crossAllDimensions: Type: Boolean. Only displayed when there are two dimensions. Continues accumulation across both dimensions. fullAccumulation: Type: Boolean. Select whether the accumulation will happen on the Full range or Custom range. steps: Type: Integer. Only displayed when Range is set to Custom. The number of steps in the dimensions which form an accumulation range. Only zero and positive integers are accepted. Note: Sorting order of dimension values (or step order) is important and affects results. outputExpression: Type: String. Shows the expression used by the modifier. showExcludedValues: Type: Boolean. Shows the excluded values (values not in the current selection) in the accumulation. disabled: Type: Boolean.
movingAverage	Object	Only displayed when movingAverage has been set as a modifier. Properties: primaryDimension: Type: Integer. Only displayed when there are two dimensions. Selects the dimension on which the moving average will take place. If the moving average is made across multiple dimensions, this will be the first dimension. crossAllDimensions: Type: Boolean. Only displayed when there are two dimensions. Continues the moving average across both dimensions. fullRange: Type: Boolean. Select whether the moving average will happen on the Full range or Custom range. steps: Type: Integer. Only displayed when Range is set to Custom. The number of steps in the dimension which form a moving average. Only zero and positive integers are accepted. Note: Sorting order of dimension values (or step order) is important and affects results. nullSuppression: Type: Boolean. Choose to have null values calculated by the moving average modifier. outputExpression: Type: String. Shows the expression used by the modifier. showExcludedValues: Type: Boolean. Shows the excluded values (values not in the current selection) in the moving average. disabled: Type: Boolean.
difference	Object	Only displayed when difference has been set as a modifier. Properties: primaryDimension: Type: Integer. Only displayed when there are two dimensions. Selects the dimension on which the difference will take place. If the difference is made across multiple dimensions, this will be the first dimension. crossAllDimensions: Type: Boolean. Only displayed when there are two dimensions. Continues the difference across both dimensions. outputExpression: Type: String. Shows the expression used by the modifier. showExcludedValues: Type: Boolean. Shows the excluded values (values not in the current selection) in the difference. disabled: Type: Boolean.
relativeNumber	Object	Only displayed when relativeNumber has been set as a modifier. Allows you to see relative percentages to see the impact of specific selections, relative to the selection, relative to the total, or relative to other fields. You can change the basis upon which the relative number is calculated. Properties: dimensionalScope: Type: Integer. Sets whether the relative numbers are calculated based on a dimension. You can choose to have the modifier respect all available dimensions, respect a specific dimension if there are two, or to disregard the dimensions. The dimension values can be one of: respectOneDimension: Value: 0. Available when more than one dimensions are available. Calculates the subtotal for that dimension. respectAllDimensions: Value: 1. Available when more than one dimensions are available. Uses all dimensions when calculating the modifier. The calculated number is relative to every dimensional value, for both dimensions. disregardDimension: Value: 2. Available when more than one dimensions are available. Uses the total when calculating the modifier. The calculated number is relative to the total. disregardAllDimensions: Value: 3. Available when more than one dimensions are available. Uses the total when calculating the modifier. The calculated number is relative to the total. selectionScope: Type: Integer. Sets whether the relative numbers are calculated based on the current selection or a specific field value. You can also disregard the current selection. The selection values can be one of: currentSelection: Value: 0. Uses current selection to calculate modifier. selectFieldValue: Value: 1. Uses a field to calculate the modifier. disregardSelection: Value: 2. Disregards any selections when calculating the modifier.

numFormatFromTemplate

Type: Boolean

Description: When enabled, the number format to use can be selected from multiple predefined formats based on the desired type: number or date. Default: true.
isCustomFormatted

Type: Boolean

Description: Set to true to toggle off the default client formatting.
othersLabel

Type: StringExpressionContainer

qAttributeExpressions

Type: Array

Description: Extends NxAttrExprDef, see Engine API: NxAttrExprDef.
- id
  
  Type: String
  
  One of:
  - colorByAlternative: colors the chart using different dimensions. Can be used together with color.mode="byDimension" for attribute dimensions.
  - colorByExpression: used together with color.mode="byExpression".

qLayoutExclude

Type: Object

customErrorMessage

Type: Object

Set to define custom error messages.

calcCondition

Type: String

Description: Deprecated. Use qCalcCondition.qMsg instead. Set to customize the calculation condition unfilled message.

tooltip

Type: Object

Description: Custom tooltip settings.

auto
Type: Boolean
Description: Determines if the custom tooltip is displayed or not.
If set to false, custom tooltip is displayed. Default: true
data
hideBasic
Type: Boolean
Description: Hides all the basic tooltip content except the dimension and the custom tooltip content.
If set to true, basic tooltip content is hidden. Default: false
chart
Type: Object
Description: The chart objects are used to define the chart that is displayed by the custom tooltip.
- object
  Type: MasterVisualizationChartObject
  Description: Contains the master visualizations available to add to the tooltip.
  - refId
    Type: String
    Description: Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization.
- style
  Type: MasterVisualizationChartStyle
  Description: Determines the styling available for the chart in the tooltip.
  - size
    Type: String
    Description: Size of the chart when it is displayed. One of:
    - small
    - medium
    - large
    The small, medium, and large settings yield fixed pixel sizes for the chart container. The chart is scaled to fit the tooltip.
imageComponents
Type: Array
Description: The imageComponents objects are used to define the images displayed by the custom tooltip.
- type
  Type: String
  Description: Type of the image for the current selection. One of:
  - media library
  - url
- size
  Type: String
  Description: Size of the image when it is displayed. One of:
  - small
  - medium
  - large
  - original
  The small, medium, and large settings yield fixed pixel sizes for the image container. Setting the value to original maintains the size unless it exceeds the limit of the tooltip max size. The image is scaled to fit the tooltip if it exceeds the limit.
- ref
  Type: String, StringExpression, or MediaLibraryRef
  Description: The reference value of the image.
  - MediaLibraryRef
    Type: Object
    Description: Media Library Reference structure.
    - qStaticContentUrlDef
      Object
      Description: Media Library structure that is evaluated by the engine.
      - qUrl

refLine

Type: Object

Reference line settings.

refLines

Type: Array

refLines properties
Name	Type	Description
show	Boolean	Set to true to display this reference line. Default: true
label	String	Reference line label.
color	Integer	Deprecated. Use paletteColor instead. Color. Default: 3
paletteColor	Object	Description: Color information structure. Holds the actual color and index in palette. color: Type: String Description: Color as hex string (mandatory if index: -1) index: Type: Integer Description: Index in palette. If a custom color, not in the palette, is being used, set index to -1.

dimRefLines

Type: Array

dimRefLines properties
Name	Type	Description
show	String \| ValueExpression	Determines if the reference line is shown based on the result (of a ValueExpression) that is returned from the engine. If a condition is evaluated as true, the engine returns -1; if evaluated as false, the result is 0. Default: ""
label	String \| StringExpression	Reference line label.
showLabel	Boolean	Set to true to display the label of the reference line. Default: true
showValue	Boolean	Set to true to display the value of the reference line. Default: true
paletteColor	Object	Description: Color information structure. Holds the actual color and index in palette. color: Type: String Description: Color as hex string (mandatory if index: -1) Default: #333333 index: Type: Integer Description: Index in palette. If a custom color, not in the palette, is being used, set index to -1. Default: -1
style	Object	Description: Style settings for the reference line. lineThickness: Type: Integer Description: Sets the thickness of the reference line. Default: 2 lineType: Type: String Description: Sets the dash style of the reference line. Can be a pattern of dashes and gaps to paint a line. For example, "8 4" specifies that the length for the dash is 8 and the length for the empty space is 4. An empty string means the line is solid. Default: ""
refLineExpr	Object	Description: Defines the value of the reference line to be displayed with an optional label. value: Type: Integer \| ValueExpression Description: Used when the dimensional axis is continuous. This can either be a “static” numerical value, like 5.5 or it can be a ValueExpression. Default: 0 label: Type: String \| StringExpression Description: A text representation of the value that can be displayed and attached to the reference line. For example, if the value is 4490, the label could be “4.49k”. Default: "0" stringValue Type: String \| StringExpression Description: Used when the dimensional axis has discrete values. This can either be static text or a StringExpression. Default: ""
align	String	Sets the alignment of the reference line. One of: start center end Default: center
coloredBackground	Boolean	Set to true to fill the label and/or value of this reference line with the specified color. Default: false

barGrouping

Type: Object

Bar grouping settings.

Bar grouping can be one of:

grouped
stacked

Default: grouped

nullMode

Type: String

Sets the null value presentation mode. Can be one of:

gap
connect
zero

Default: gap

orientation

Type: String

Orientation settings. Can be:

horizontal
vertical

If vertical, the dimension axis can only be docked on bottom or top and measure axis on left or right.

Default: vertical

scrollStartPos

Type: Number

Scroll Alignment. Generally decides if the scroll starts at the beginning or end of the data.

0: the scroll bar starts at the left/top of the chart
1: the scroll bar starts at the right/bottom of the chart

gridLine

Type: Object

Grid line settings.

gridLine properties
Name	Type	Description
auto	Boolean	Set to use automatic grid line spacing. Default: true
spacing	Integer	Grid line spacing. Used only when "auto": false. One of: 0: no lines 1: wide 2: medium 3: narrow Default: 2

dataPoint

Type: Object

Data point settings.

dataPoint properties
Name	Type	Description
showLabels	Boolean	Set to show labels on data points. Default: false
showSegmentLabels	Boolean	Set to show labels on segments (only for stacked bar charts). Only applicable if showLabels is set to true.
showTotalLabels	Boolean	Set to show total labels (only for stacked bar charts). Only applicable if showLabels is set to true.

scrollbar

Type: String

Scroll bar style settings.

Set the styling of the scroll bar. Can be one of:

miniChart
bar
none

Default: miniChart

color

Type: Object

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.

The following parameters can be set in the color object:

auto

Type: 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.

Default: true

mode

Type: String

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 byDimensionDef property.

Information notebyDimension can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below.

{ "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.

useBaseColors

Type: String

Only applicable when "mode": "primary" or "mode": "byMultiple" has been defined.

Use colors encoded in master items. Should only be defined when a master dimension or master measure used in the visualization has a color assigned to it.

One of:

off
measure: use colors encoded in master measure.
dimension: use colors encoded in master dimension.

Default: off

singleColor

Type: Integer

Deprecated. Use paletteColor instead.

Set to use single color.

Default: 3

paletteColor

Type: Object

The paletteColor object is used to define the color when you color by single color ("mode": "primary"). It has the following properties:

paletteColor properties
Name	Type	Description
index	Integer	Index in the palette. The default Qlik Sense color palette: -1: set to use custom color that is not in the palette. 0: No color 1: White, HEX: #ffffff 2: Light green, HEX: #46c646 3: Green, HEX: #276e27 4: Light blue, HEX: #b6d7ea 5: Blue, HEX: #7db8da 6: Dark blue, HEX: #4477aa 7: Purple, HEX: #8e477d 8: Yellow, HEX: #ffcf02 9: Orange, HEX: #f8981d 10: Red, HEX: #f93f17 11: Brown, HEX: #633d0c 12: Light gray, HEX: #b0afae 13: Gray, HEX: #7b7a78 14: Dark gray, HEX: #545352 15: Black, HEX: #000000 Default: 6
color	String	Color as HEX string. Mandatory if "index": "-1".

persistent

Type: Boolean

Set to true to use persistent colors on data points between selection states. Only applicable when using one dimension and when "mode": "byDimension" or when "mode": "byMultiple".

Default: false

expressionIsColor

Type: Boolean

Set to true to define whether the result of the expression is a valid CSS3 color.

Only applicable when "mode": "byExpression".

Default: true

expressionLabel

Type: String

Defines the label on tool tips when using a coloring expression. Only applicable when "mode": "byExpression" and only used if "expressionIsColor": false

colorExpression

Type: Value Expression Container

Sets the color expression to be used when "mode": "byExpression" is defined.

Supported formats:

RGB
ARGB
HSL

Example:

"colorExpression": "=if(sum(Sales)<avg(Total aggr(sum(Sales),Product)),rgb(255,0,0),RGB(0,255,0))"

measureScheme

Type: String

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.

Default: sg

useMeasureGradient

Type: Boolean

Set to true if you want to apply the colors defined for library measures when used. Only applicable if "mode": "byMeasure".

Default: true

dimensionScheme

Type: String

Color scheme when "mode": "byDimension" or "mode": "byMultiple". Can be one of:

12: 12 colors where all can be distinguished by people with vision deficiency.
100: 100 colors where not all can be distinguished by people with vision deficiency

Default: 12

useDimColVal

Type: Boolean

Set to true if you want to apply the colors defined for library dimensions when used. Only applicable if "mode": "byDimension".

Default: true

reverseScheme

Type: Boolean

Set to true to reverse the color scheme.

autoMinMax

Type: Boolean

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.

Default: true

measureMin

Type: Value Expression Container

Set the min value for the color range.

Only applicable if autoMinMax: false. Can be used in conjunction with measureMax or by its own.

measureMax

Type: Value Expression Container

Set the max value for the color range.

Only applicable if autoMinMax: false. Can be used in conjunction with measureMin or by its own.

formatting

Type: Object

Number formatting options for color by measure .

isCustomFormatted
Type: Boolean

Set to true to toggle off the client formatting.

Default: false
numFormatFromTemplate
Type: Boolean

When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).

Default: true

legend

Type: Object

Legend settings.

legend properties
Name	Type	Description
show	Boolean	Set to show the legend. Default: true
dock	String	Sets the legend position. Can be one of: auto right left bottom top Default: auto
showTitle	Boolean	Show the legend title. Default: true

dimensionAxis

Type: Object

Dimension axis settings.

dimensionAxis properties
Name	Type	Description
show	String	Set to display the labels and titles. Can be one of: all labels title none Default: all
label	String	Set the label orientation. Can be one of: auto horizontal tilted Default: auto
dock	String	Sets the axis docking position. Can be one of: near far Default: near
continuousAuto	Boolean	Continuous setting used for toggling between auto and custom setting. Default: true
axisDisplayMode	String	Set to specify axis display mode (number of bars). Can be one of: auto max custom Default: auto
maxVisibleItems	Expression	Only visible when axisDisplayMode is custom. Accepts integers or expressions. Max = 10000 / (numDims+numMeasures)

measureAxis

Type: Object

Measure axis settings.

measureAxis properties
Name	Type	Description
show	String	Set to display the labels and titles. Can be one of: all labels title none Default: all
dock	String	Sets the axis docking position. Can be one of: near far Default: near
spacing	Number	Set the axis scale: Default: 1
autoMinMax	Boolean	Set to use automatic min/max for measure color. Default: true
minMax	String	Set custom max/min. Can be one of: min max minMax Default: min
min	ValueExpressionContainer	Set the min value for the range.
max	ValueExpressionContainer	Set the max value for the range.

preferContinuousAxis

Type: Boolean

Chart axis setting to control preference of scale on a dimensional axis.

If true, the scale along the dimensional axis is continuous if supported by the data, otherwise discreet.

Default: true

showMiniChartForContinuousAxis

Type: Boolean

Chart axis setting to turn mini charts on for continuous axis.

Default: true

components

Type: Array

Component settings.

key

Type: String

Description: Determines which component the settings apply to.

Default: bar

style

Type: Object

style properties
Name	Type	Description
strokeWidth	String	Set to specify stroke width. Can be one of: none small medium large Default: none
strokeColor	Object	Same as paletteColor used in color. Default: {index: -1, color: '#205891'};
width	Number	A number greater than 0 and less than or equal to 1.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here