Nebula Treemap

Treemap generic object definition

Download specification

Properties

color object
Required
Color settings. Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting "auto": false which turns off auto-coloring. If "auto": true, no other properties need to be defined in the color object. Note: Some of the color properties are depending on which theme is currently being used.
Show color properties
- auto boolean
  Required
  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
- autoMinMax boolean
  Required
  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
- dimensionScheme '12' | '100'
  Required
  Color scheme when "mode": "byDimension" or "mode": "byMultiple" ("12" or "100" for most themes).
  default = "12"
- expressionIsColor boolean
  Required
  Set to define whether the result of the expression is a valid CSS3 color. Only applicable when "mode": "byExpression".
  default = true
- expressionLabel string
  Required
  Label to be defined on tool tips when using a coloring expression. Only used if 'expressionIsColor': false.
  default = ""
- formatting object
  Required
  Color by measure number formatting options
  
  Show formatting properties
  
  numFormatFromTemplate boolean
  When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
  default = true
- measureMax number | ValueExpression
  Required
  Set the max value for the color range. Only applicable if "autoMinMax": false.
  default = 10
- measureMin number | ValueExpression
  Required
  Set the min value for the color range. Only applicable if "autoMinMax": false.
  default = 0
- measureScheme 'sg' | 'sc' | 'dg' | 'dc'
  Required
  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"
- mode 'primary' | 'byDimension' | 'byExpression' | 'byMeasure' | 'byMultiple'
  Required
  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 "byDimDef" 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.
  
  default = "primary"
- paletteColor paletteColor
  Required
  The paletteColor object is used to define the color when you color by single color ("mode": "primary").
  default = "{ index: 6 }"
  
  Show paletteColor properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
- persistent boolean
  Required
  Set to use persistent colors on data points between selections. Only applicable when using one dimension and when "mode": "byDimension" or when "mode": "byMultiple".
  default = false
- reverseScheme boolean
  Required
  Set to reverse the color scheme.
  default = false
- useBaseColors 'off' | 'dimension' | 'measure'
  Required
  Use colors encoded in master items. Only applicable when "mode": "primary" or "mode": "byMultiple" has been defined.
  default = "off"
- useDimColVal boolean
  Required
  Set to true if you want to apply the colors defined for library dimensions when used. Only applicable if 'colorMode': 'byDimension'.
  default = true
- useMeasureGradient boolean
  Required
  Set to true if you want to apply the colors defined for library measures when used. Only applicable if "mode": "byMeasure".
  default = true
footnote string | StringExpression
Visualization footnote.
default = ""
labels object
Required
Label mode settings.
default = "{\"auto\":true,\"headers\":true,\"overlay\":true,\"leaves\":true,\"values\":false}"
Show labels properties
- auto boolean
  Required
  Automatic label handling.
  default = true
- headers boolean
  Required
  Show labels on headers.
  default = true
- leaves boolean
  Required
  Show labels on leafs.
  default = true
- overlay boolean
  Required
  Show overlay labels.
  default = true
- values boolean
  Required
  Show data point values.
  default = false
legend object
Required
Legend settings.
Show legend properties
- dock 'auto' | 'right' | 'left' | 'bottom' | 'top'
  Required
  Sets the legend position.
  default = "auto"
- show boolean
  Required
  Set to show the legend.
  default = false
- showTitle boolean
  Required
  Show the legend title.
  default = true
qHyperCubeDef object
Required
Extends HyperCubeDef, see Engine API: HyperCubeDef.
Show qHyperCubeDef properties
- qDimensions Array< DimensionProperties >
  Required
- qMeasures Array< MeasureProperties >
  Required
showDetails boolean
Show visualization details toggle
default = true
showDisclaimer boolean
Required
Show visualization disclaimer toggle
default = true
showTitles boolean
Show title for the visualization.
default = true
subtitle string | StringExpression
Visualization subtitle.
default = ""
title string | StringExpression
Visualization title.
default = ""
tooltip object
Required
Custom tooltip properties
Show tooltip properties
- auto boolean
  Required
  Toggle for using custom tooltip or regular tooltip
  default = true
- chart MasterVisualizationChart
  Required
  The chart object is used to define the chart displayed by the custom tooltip.
  default = "undefined"
  
  Show chart properties
  
  object MasterVisualizationChartObject
  Required
  Object containing the information fo the visualization, such as refId in case of master visualization
  
  Show object properties
  
  refId string
  Required
  Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization
  
  style MasterVisualizationChartStyle
  Required
  Object containing the styles of the chart such as 'size'
  
  Show style properties
  
  size string
  Required
  Input type as 'small' or 'medium' or 'large'
- description string | StringExpression
  Custom tooltip description.
  default = ""
- hideBasic boolean
  Required
  Toggle for hiding basic information from custom tooltip
  default = false
- imageComponents Array< ImageComponent >
  Required
  The imageComponents objects are used to define the images displayed by the custom tooltip.
  default = "undefined"
- title string | StringExpression
  Custom tooltip title.
  default = ""
version string
Required
Current version of this generic object definition

extends NxAttrDimDef

Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

Properties

id string
Required
One of: colorByAlternative: colors the chart using different dimensions (can be used together with color.mode="byDimension") or colorByExpression together with color.mode="byExpression".

extends NxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id string
Required
One of: colorByAlternative: colors the chart using different dimensions (can be used together with color.mode="byDimension") or colorByExpression together with color.mode="byExpression".

extends NxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id 'customTooltipTitle' | 'customTooltipDescription' | 'customTooltipExpression'
Required
Indicates how the attribute expression will be interpreted by the chart. customTooltipTitle: additional title displayed on the custom tooltip customTooltipDescription: description displayed on the custom tooltip customTooltipExpression: measures displayed on the custom tooltip

CustomTooltipAttributes

```json
"qAttributeExpressions": [{
  "qExpression": "",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "U",
     "qnDec": 10,
     "qUseThou": 0,
     "qFmt": "",
     "qDec": "",
     "qThou": "",
   }
  "qLabel": "custom title",
  "qLabelExpression": "",
  "id": "customTooltipTitle"
},
{
  "qExpression": "avg(population)",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "U",
     "qnDec": 10,
     "qUseThou": 0,
     "qFmt": "",
     "qDec": "",
     "qThou": "",
   }
  "qLabel": "",
  "qLabelExpression": "",
  "id": "customTooltipDescription"
},
{
  "qExpression": "",
  "qLibraryId": "zpDNMcg",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "U",
     "qnDec": 10,
     "qUseThou": 0,
     "qFmt": "",
     "qDec": "",
     "qThou": "",
   }
  "qLabel": "",
  "qLabelExpression": "",
  "id": "customTooltipExpression"
},
{
  "qExpression": "sum(population)",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "M",
     "qnDec": 2,
     "qUseThou": 0,
     "qFmt": "$#,##0.00;-$#,##0.00",
     "qDec": ".",
     "qThou": ",",
   }
  "qLabel": "",
  "qLabelExpression": "=avg(population)",
  "id": "customTooltipExpression"
},
{
  "qExpression": "'https://my_url/'+sum(population)",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": null,
  "qLabel": "",
  "qLabelExpression": "",
  "cId": "generatedUniqueId",
  "id": "customTooltipImages"
}]
```

extends NxDimension

Extends NxDimension, see Engine API: NxDimension.

Properties

qAttributeDimensions Array< AttributeDimensionProperties >
Required
qDef InlineDimensionDef
Required
Show qDef 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.

Image component information structure.

Properties

cId string
Required
Identifier of the image component - used as a link with an attribute expression
ref string | StringExpression | MediaLibraryRef
Required
The reference value of the image
size string
Required
Size as 'small','medium','large' or 'original'
type string
Required
Input type as 'url' or 'media library'

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.

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
othersLabel string | StringExpression
Required
autoSort boolean
Set to automatically sort the measure.
cId string
ID used by the Qlik Sense. Must be unique within the current chart.

Chart component information structure.

Properties

object MasterVisualizationChartObject
Required
Object containing the information fo the visualization, such as refId in case of master visualization
Show object properties
- refId string
  Required
  Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization
style MasterVisualizationChartStyle
Required
Object containing the styles of the chart such as 'size'
Show style properties
- size string
  Required
  Input type as 'small' or 'medium' or 'large'

Chart component information structure.

Properties

refId string
Required
Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization

Chart component information structure.

Properties

size string
Required
Input type as 'small' or 'medium' or 'large'

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
- othersLabel string | StringExpression
  Required
- autoSort boolean
  Set to automatically sort the measure.
- cId string
  ID used by the Qlik Sense. Must be unique within the current chart.

Media Library Reference structure.

Properties

qStaticContentUrlDef object
Required
Media library structure

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

Properties

color string
Required
Color as hex string (mandatory if index: -1)
index number
Required
Index in palette

Media Library structure that will be evaluated by the engine.

Properties

qUrl string
Required
Value of media library image

Nebula Treemap

properties namespace

Properties

AttributeDimensionProperties object

Properties

AttributeExpressionProperties ColorAttributes | CustomTooltipAttributes

ColorAttributes object

Properties

CustomTooltipAttributes object

Properties

CustomTooltipAttributes

DimensionProperties object

Properties

ImageComponent object

Properties

InlineDimensionDef object

Properties

InlineMeasureDef object

Properties

MasterVisualizationChart object

Properties

MasterVisualizationChartObject object

Properties

MasterVisualizationChartStyle object

Properties

MeasureProperties object

Properties

MediaLibraryRef object

Properties

paletteColor object

Properties

qStaticContentUrlDef object

Properties