distributionplot properties

distributionplot()

These are the properties used by Qlik Sense distribution plots.

Version history

Properties

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.

Properties

qDimension

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

qMeasures

Type: Array

Description: Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

• qDef
  

  Type: Object

  Description: Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

  qDef Properties

  Name	Type	Description
  autoSort	Boolean	Set to automatically sort the measure. Default: true
  cId	String	ID used by the client. Must be unique within the current chart.
  numFormatFromTemplate	Boolean	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	Boolean	Set to true to toggle off the default client formatting.
  othersLabel	StringExpressionContainer	String expression container.

• qAttributeExpressions
  

  Type: Array

  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.

dimensionAxis

Type: Object

Dimension axis settings.

measureAxis

Type: Object

Measure axis settings.

gridLine

Type: Object

Grid line settings.

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

refLine

Type: Object

Reference line settings.

presentation

Type: Object

Presentation settings for the distribution plot.

visibleComponents

Type: String

Sets which components of the plot that should be visible. Chose between points and box, only points, or only box. Can be:

• points_box
• points
• box

Default: points_box

dataPoint

Type: Object

color

Type: Object

Color settings for the distribution plot.

• box

  Type: Object

  Description: Color information structure. Holds actual color and index in palette.

  box properties

  Name	Type	Description
  index	Integer	Index in palette. Default: 6
  color	String	Color as HEX string. Default: #E6E6E6

• point

  Type: Object

  Description: Color information structure. Holds actual color and index in palette.

   

  point properties

  Name	Type	Description
  color	String	Color as HEX string. Default: #4477aa
  auto	Boolean	Use automatic coloring. Default: true
  mode	String	Sets the coloring mode for the chart. Can be one of: primary byDimension byExpression Default: primary byExpression can only be used in conjunction with an attribute expression on the first measure: qHyperCubeDef.qMeasures.0.qAttributeExpressions.0.qExpression
  paletteColor	Object	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.
  persistent	Boolean	Set to use persistent colors on data points between selections.
  useDimColVal	Boolean	Set to apply colors from the used library dimension. Only used together with "colorMode": "byDimension". Default: true
  dimensionScheme	String	Dimension color scheme. Can be one of: 12 100 Default: 12
  useBaseColors	String	Set to use colors encoded in master items. Can be one of: off dimension Default: off

sorting

Type: Object

Sorting properties that can be set on the outer dimension.

Example using Visualization API

In this example we want to create a basic distribution plot, containing one dimension and two measures, with a custom title and horizontal orientation.

app.visualization.create(
  'distributionplot',
  [
    {
      "qDef": {
        "qFieldDefs": [
          "=NetScoreName"
        ],
        "qFieldLabels": [
          "Net result"
        ]
      },
      "qNullSuppression": true
    },
    {
      "qDef": {
        "qLabel": "Occurancies",
        "qDef": "Count(HoID)",
        "qNumFormat": {
          "qType": "F",
          "qnDec": 2,
          "qUseThou": 0
        }
      }
    }
  ],
  {
    "showTitles": true,
    "title": "Net score result per hole"
  }
).then(function(vis){
  vis.show("QV01");
});