Skip to main content Skip to complementary content
Qlik Resources

boxplot properties

Information noteSTABLE.

This API is reliable and breaking changes are unlikely.

boxplot()

These are the properties used by Qlik Sense boxplots.

Version history

Version history
Version state Details
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 | 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

boxplotDef

Type: Object

Settings specific to the box plot.

Properties

elements

Type: Object

Description: Box plot element settings.

Additional properties:

  • boxStart

    Type: Object

    Description: Properties.

    • name: StringExpressionContainer
    • expression: ValueExpressionContainer

  • boxMiddle

    Type: Object

    Description: Properties.

    • name: StringExpressionContainer
    • expression: ValueExpressionContainer

  • boxEnd

    Type: Object

    Description: Properties.

    • name: StringExpressionContainer
    • expression: ValueExpressionContainer

  • firstWhisker

    Type: Object

    Description: Properties.

    • name: StringExpressionContainer
    • expression: ValueExpressionContainer

  • lastWhisker

    Type: Object

    Description: Properties.

    • name: StringExpressionContainer
    • expression: ValueExpressionContainer

  • outliers

    Type: Object

    Description: Properties.

    • name: StringExpressionContainer
    • expression: ValueExpressionContainer

calculations

Type: Object

Description: Box plot calculations settings.

  • auto

    Type: Boolean

    Description: Use automatic calculations.

    Default: true

  • mode

    Type: String

    Description: Auto calculation mode. Can be one of:

    • tukey
    • fractiles
    • stdDev

    Default: tukey

  • parameters

    Type: Object

    parameters properties
    Name Type Description
    fractiles Number

    A number representing the two whisker fractiles as N and 1-N.

    Default: 0.01
    stdDev Integer

    Standard deviation spread for whiskers.

    Default: 3
    tukey Number

    Number of inter-quartile ranges for whiskers.

    Default: 1.5

color

Type: Object

Description: Color settings for the box 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.

  • point

    Type: Object

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

    point properties
    Name Type Description
    index Integer

    Index in palette.

    Default: 6
    color String

    Color as HEX string.

presentation

Type: Object

Description: Presentation settings for the box plot.

  • whiskers

    Type: Object

    Description: Settings for the box plot whiskers.

    whiskers properties
    Name Type Description
    show Boolean

    Set to true to show whiskers.

    Default: false

qHyperCubeDef

Type: Object

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

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

dimensionAxis properties
NameTypeDescription
showString

Defines if titles and labels should be visible. Can be one of:

  • all
  • labels
  • title
  • none

Default: all

labelString

Defines the label orientation. Can be one of:

  • auto
  • horizontal
  • tilted

Default: auto

dockString

Axis docking position. Can be:

  • near
  • far

Default: near

gridLines

Type: Object

Grid line settings.

gridLines settings
NameTypeDescription
autoBoolean

Set to show grid lines.

Default: true

spacingInteger

Defines the grid line spacing. Used when "auto": false. Can be one of:

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

Default: 2

measureAxis

Type: Object

Measure axis settings.

measureAxis properties
NameTypeDescription
showString

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

  • all
  • labels
  • title
  • none

Default: all

dockString

Sets the axis docking position. Can be one of:

  • near
  • far

Default: near

spacingNumber

Set the axis scale:

Default: 1

autoMinMaxBoolean

Set to use automatic min/max for measure color.

Default: true

minMaxString

Set custom max/min. Can be one of:

  • min
  • max
  • minMax

Default: min

minValueExpressionContainerSet the min value for the range.
maxValueExpressionContainerSet the max value for the range.

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.

refLines

Type: Array

refLines properties
NameTypeDescription
showBoolean

Set to true to display this reference line.

Default: true

labelStringReference line label.
colorInteger

Deprecated. Use paletteColor instead.

Color.

Default: 3

paletteColorObject

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.

sorting

Type: Object

sorting properties
NameTypeDescription
autoSortBoolean

Set to sort automatically.

Default: true

elementIdString

Sorting preset. Can be one of:

  • firstWhisker
  • boxStart
  • boxMiddle
  • boxEnd
  • lastWhisker

Default: firstWhisker

expressionValueExpressionContainerValue expression container.
sortCriteriaObject

Sorting criteria. Can be one of the following Number values:

  • sortByAscii
  • sortByExpression
  • sortByNumeric

Example using Visualization API

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

In this example we want to create a basic box plot, containing one dimension and one measure, and with a custom title.

app.visualization.create(
  'boxplot',
  [
    {
      "qDef": {
        "qFieldDefs": [
          "Date.autoCalendar.Year"
        ],
        "qFieldLabels": [
          "Year"
        ]
      }
    },
    {
      "qDef": {
        "qLabel": "Driving average",
        "qDef": "Avg({<Par={'4','5'}>}DrDist)"
      }
    }
  ],
  {
    "showTitles": true,
    "title": "Driving average"
  }
).then(function(vis){
  vis.show("QV01");
});

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