Nebula Sankey chart

Sankey chart generic object definition

Download specification

properties namespace

Properties

  • footnote string  |  StringExpression

    Visualization footnote.

    default = ""

  • link object
    Required

    Link style settings.

    Show link properties
    • opacity number
      Required

      Opacity of the links in the chart. Between 0 and 1.

      default = 0.5

  • node object
    Required

    Node settings.

    Show node properties
    • padding number
      Required

      Padding between the nodes. Between 0 and 1.

      default = 0.2

    • sort 'valueA'  |  'valueD'  |  'data'

      Sorting mode for nodes.

      • undefined - Prioritize sorting for optimal layout.
      • 'valueA' - Sort according to value of each node, in ascending order.
      • 'valueD' - Sort according to value of each node, in descending order.
      • 'data - Sort according to the order of the data.
    • width number
      Required

      Width of the nodes. Can be a value between 0 and 1.

      default = 0.2

  • qHyperCubeDef object
    Required

    Extends HyperCubeDef, see Engine API: HyperCubeDef.

    Show qHyperCubeDef properties
  • showTitles boolean

    Show title for the visualization.

    default = true

  • subtitle string  |  StringExpression

    Visualization subtitle.

    default = ""

  • title string  |  StringExpression

    Visualization title.

    default = ""

  • version string
    Required

    Current version of this generic object definition

AttributeExpressionProperties interface

extends NxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef. Can be used to color nodes (specified under dimension) or a links (specified under measure) (CSS color). See example below on how to specify custom color for links in the chart.

AttributeExpressionProperties

Set color of links to be "green"

```json
"qAttributeExpressions": [
    {
      "qExpression": "'green'",
      "qLibraryId": "",
      "qAttribute": true
    }
]
```

DimensionProperties object

extends NxDimension

Extends NxDimension, see Engine API: NxDimension.

Properties

InlineDimensionDef object

extends NxInlineDimensionDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Properties

  • othersLabel string  |  StringExpression
    Required
  • autoSort boolean

    Set to automatically sort the dimension.

  • cId string

    ID used by the Qlik Sense. Must be unique within the current chart.

InlineMeasureDef object

extends NxInlineMeasureDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

  • isCustomFormatted boolean
    Required

    Set to true to toggle off the default client formatting.

  • numFormatFromTemplate boolean
    Required

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

    default = true

  • autoSort boolean

    Set to automatically sort the measure.

  • cId string

    ID used by the Qlik Sense. Must be unique within the current chart.

MeasureProperties object

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

  • qAttributeExpressions Array< AttributeExpressionProperties >
    Required
  • qDef InlineMeasureDef
    Required
    Show qDef properties
    • isCustomFormatted boolean
      Required

      Set to true to toggle off the default client formatting.

    • numFormatFromTemplate boolean
      Required

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

      default = true

    • autoSort boolean

      Set to automatically sort the measure.

    • cId string

      ID used by the Qlik Sense. Must be unique within the current chart.