distributionplot properties

Note: STABLE.
This API is reliable and breaking changes are unlikely.

distributionplot()

These are the properties used by Qlik Sense distribution plots.

Version history

Introduced Qlik Sense June 2017

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 | Expression

Visualization title shown if "showTitles": true.

subtitle

Type: String | Expression

Visualization subtitle shown if "showTitles": true.

footnote

Type: String | Expression

Visualization footnote shown if "showTitles": 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

Name Type Description
qDimensions Array

Extends NxDimension, see Engine API: NxDimension.

Additional properties

Name Type Description
qDef Object

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Additional 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
qAttributeDimensions Array

Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

Additional properties

Name Type Description
id 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 Array

Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

Name Type Description
qDef Object

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Additional 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
qAttributeExpressions Array

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Additional properties

Name Type Description
id 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 Object

 

customErrorMessage Object

Set to define custom error messages.

Name Type Description
calcCond String

Deprecated. Use qCalcCondition.qMsg instead.

Set to customize the calculation condition unfilled message.

dimensionAxis

Type: Object

Properties

Name Type Description
show String

Labels and title. Can be:

  • all
  • labels
  • title
  • none

Default: all

label String

Sets the label orientation. Can be:

  • auto
  • horizontal
  • tilted

Default: auto

dock String

Axis docking position. Can be:

  • near
  • far

Default: near

measureAxis

Type: Object

Properties

Name Type Description
showBounds Boolean

Set to show min and max on axis.

dock String

Axis docking position. Can be:

  • near
  • far

Default: near

spacing Number

Axis scale.

Default: 1

autoMinMax Boolean

Set to enable automatic max/min.

Default: true

minMax String

Set custom max/min.

One of:

  • min
  • max
  • minMax

Default: min

min ValueExpressionContainer
max ValueExpressionContainer

gridLine

Type: Object

Grid line settings.

Properties

Name Type Description
auto Boolean

Set to use automatic grid line spacing.

Default: true

spacing Integer

Grid line spacing. Used only when auto is set to false. One of:

  • 0: no lines
  • 1: wide
  • 2: medium
  • 3: narrow

Default: 2

orientation

Type: String

Sets the orientation. If vertical, the dimension axis can only be docked at the bottom or at the top, and the measure axis on the left or on the right. Can be:

  • vertical
  • horizontal

Default: vertical

refLine

Type: Object

Reference line settings.

Properties

Name Type Description
refLines Array

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

Color information structure. Holds the actual color and index in palette.

Properties

Name Type Description
index Integer

Index in the palette. If a custom color, not in the palette, is being used, set index ti -1.

Default: 6

color String

Color as HEX string.

Mandatory if "index": "-1".

presentation

Type: Object

Presentation settings for the distribution plot.

Name Type Description
visibleComponents 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 object

Properties

Name Type Description
bubbleScales Integer

Size parameter for points. Minimum value: 20, Maximum value: 100.

Default: 100

displacement String

Controls displacement of data points. Can be one of:

  • none
  • jitter

Default: none

color

Type: Object

Color settings for the distribution plot.

Name Type Description
box Object

Properties

Name Type Description
index Integer

Index in palette.

Default: -1

color String

Color as HEX string.

Default: #E6E6E6

point Object

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 actual color and index in palette.

Name Type Description
index Integer

Index in palette.

Default: 6

color String

Color as HEX string.

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.

Properties

Name Type Description
autoSort Boolean

Set to sort automatically.

Default: true

elementId String

Sorting preset. Can be one of:

  • distplot-exp-min
  • distplot-exp-max

Default: distplot-exp-min

expression ValueExpressionContainer  
sortCriteria Object

Properties

Name Type Description
sortByAscii Number

Use to sort alphabetically.

sortByExpression Number Use to sort by expression.
sortByNumeric Number Use to sort numerically.

Example using Visualization API

Tip: For more examples of how to create distribution plots on the fly, see Mashups: Creating distribution plots.

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");
});

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?