Skip to content

@nebula.js/sn treemap:properties

v1.6.1

Treemap generic object definition

properties

namespace

Properties

color

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.

footnote
string | StringExpression

Visualization footnote.

labels
default={"auto":true,"headers":true,"overlay":true,"leaves":true,"values":false}

Label mode settings.

legend

Legend settings.

qHyperCubeDef

Extends HyperCubeDef, see Engine API: HyperCubeDef.

showDetails
default=true
boolean

Show visualization details toggle

showDisclaimer
default=true
boolean

Show visualization disclaimer toggle

showTitles
default=true
boolean

Show title for the visualization.

subtitle
string | StringExpression

Visualization subtitle.

title
string | StringExpression

Visualization title.

tooltip

Custom tooltip properties

version
string

Current version of this generic object definition

AttributeDimensionProperties

object
extendsNxAttrDimDef

Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

Properties

id
string

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

type AttributeExpressionProperties

ColorAttributes | CustomTooltipAttributes

ColorAttributes

object
extendsNxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id
string

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

CustomTooltipAttributes

object
extendsNxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id
'customTooltipTitle' | 'customTooltipDescription' | 'customTooltipExpression'

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

```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"
}]
```

DimensionProperties

object
extendsNxDimension

Extends NxDimension, see Engine API: NxDimension.

Properties

qAttributeDimensions

No description

qDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

ImageComponent

object

Image component information structure.

Properties

cId
string

Identifier of the image component - used as a link with an attribute expression

ref
string | StringExpression | MediaLibraryRef

The reference value of the image

size
string

Size as 'small','medium','large' or 'original'

type
string

Input type as 'url' or 'media library'

InlineDimensionDef

object
extendsNxInlineDimensionDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Properties

othersLabel
string | StringExpression

No description

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
extendsNxInlineMeasureDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

isCustomFormatted
boolean

Set to true to toggle off the default client formatting.

numFormatFromTemplate
default=true
boolean

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

othersLabel
string | StringExpression

No description

autoSort
boolean

Set to automatically sort the measure.

cId
string

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

MasterVisualizationChart

object

Chart component information structure.

Properties

object

Chart component information structure.

style

Chart component information structure.

MasterVisualizationChartObject

object

Chart component information structure.

Properties

refId
string

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

MasterVisualizationChartStyle

object

Chart component information structure.

Properties

size
string

Input type as 'small' or 'medium' or 'large'

MeasureProperties

object
extendsNxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

qAttributeExpressions

No description

qDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

MediaLibraryRef

object

Media Library Reference structure.

Properties

qStaticContentUrlDef
object

Media library structure

paletteColor

object

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

Properties

color
string

Color as hex string (mandatory if index: -1)

index
number

Index in palette

qStaticContentUrlDef

object

Media Library structure that will be evaluated by the engine.

Properties

qUrl
string

Value of media library image

Was this page helpful?