Bar chart properties

Extends NxDimension, see Engine API: NxDimension.

Additional properties

Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

Set to use automatic grid line spacing.

Default: true

Set to show labels on data points.

Set to show labels on segments (only for stacked bar charts).

Only applicable if showLabels is set to true.

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

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.

  Note: byDimension 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.

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

Deprecated. Use paletteColor instead.

Set to use single color.

Default: 3

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

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

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

Only applicable when "mode": "byExpression".

Default: true

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

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

Supported formats:

• RGB
• ARGB
• HSL

Example:  

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

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

Default: true

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

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

Default: true

Set to true to reverse the color scheme.

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

Set the min value for the color range.

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

Set to show the legend.

Default: true

Sets the legend position. Can be one of:

• auto
• right
• left
• bottom
• top

Default: auto

Set to display the labels and titles. Can be one of:

• all
• labels
• title
• none

Default: all

Set the label orientation. Can be one of:

• auto
• horizontal
• tilted

Default: auto

Sets the axis docking position. Can be one of:

• near
• far

Default: near

Continuous setting used for toggling between auto and custom setting.

Default: true

Set to specify axis display mode (number of bars). Can be one of:

• auto
• max
• custom

Default: auto

Set to display the labels and titles. Can be one of:

• all
• labels
• title
• none

Default: all

Sets the axis docking position. Can be one of:

• near
• far

Default: near

Set the axis scale:

Default: 1

Set to use automatic min/max for measure color.

Default: true

Set custom max/min. Can be one of:

• min
• max
• minMax

Default: min

Determines which component the settings apply to.

Possible values:

'bar'