@nebula.js/sn-bullet-chart:properties

v1.9.0

Bullet chart 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.

dimensionAxis

Dimension axis settings.

footnote
optional
string | StringExpression

Visualization footnote.

gridLine

Grid lines settings. Used only when using commom axis.

measureAxis

Measure axis settings.

orientation
default='vertical'
'vertical' | 'horizontal'

Orientation setting. If vertical, the dimension axis can only be docked on bottom or top and measure axis on left or right.

qHyperCubeDef

Extends HyperCubeDef, see Engine API: HyperCubeDef.

scrollbar
default='bar'
'bar' | 'none'

Sets the style of the scroll bar

scrollStartPos
number

Scroll Alignment. If 0, then the scrollbar will start at the left/top of the chart, if 1 it starts at the right/bottom of the chart. Generally decides if the scroll starts at the beginning or end of the data

showDetails
optional
boolean

Show visualization details toggle

showTitles
optional, default=true
boolean

Show title for the visualization

subtitle
optional
string | StringExpression

Visualization subtitle.

title
optional
string | StringExpression

Visualization title.

tooltip

Custom tooltip properties

version
string

Current version of this generic object definition

AttributeExpressionProperties

AttributeExpressions

object
extendsNxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id
string

If set to "bullet-target" the expression will be interpreted as the target for the specific measure. If set to "bullet-segment" the expression will be interpreted as a segment limit.

```json
"qAttributeExpressions": [{
  "qExpression": "Avg(Sales)",
  "qLibraryId: "",
  "qAttribute: true,
  "id": "bullet-target"
},
{
  "qExpression: "Avg(Sales)/2",
  "qLibraryId: "",
  "qAttribute: true,
  "id: "bullet-segment"
}]
```

conditionalColoringProperties

object

Properties

segments

No description

```json
"segments": {
  "limits": [
    {
      "gradient": false
    }
  ],
  "paletteColors": [
    {
      "color": "#bfbfbf",
      "index": -1
    },
    {
      "color": "#a5a5a5",
      "index": -1
    }
  ]
}
```

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

qDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

ImageComponent

object

Image component information structure.

Properties

type
string

Input type as 'url' or 'media library'

size
string

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

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

InlineDimensionDef

object
extendsNxInlineDimensionDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Properties

autoSort
optional
boolean

Set to automatically sort the dimension.

cId
optional
string

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

othersLabel
string | StringExpression

No description

InlineMeasureDef

object
extendsNxInlineMeasureDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

autoSort
optional
boolean

Set to automatically sort the measure.

cId
optional
string

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

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

useSegments
boolean

Default false. Set to true to customize segment colors.

conditionalColoring

Information of how the segments

autoMinMax
boolean

Default false. Set to true to custmize the ranges of measure.

minMax
string

Set custom max/min. Default "min". Supported type are: 'min'|'max'|'minMax'.

min
number | ValueExpression

Set the min value of the range.

max
number | ValueExpression

Set the max value of the range.

limitsProperties

object

Properties

gradient
optional
boolean

Set gradient of the color.

MasterVisualizationChart

object

Chart component information structure.

Properties

style

Chart component information structure.

object

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

paletteColorsProperties

object

Properties

paletteColor

No description

properties.dataPoint.showLabels

boolean

Show labels on data points

properties.dataPoint.showSegmentLabels

boolean

Show segment labels

properties.dataPoint.showTotalLabels

boolean

Show total labels

qStaticContentUrlDef

object

Media Library structure that will be evaluated by the engine.

Properties

qUrl
string

Value of media library image

segmentsProperties

object

Properties

limits

No description

paletteColors

No description

Was this page helpful?