Nebula Bullet chart

Bullet chart generic object definition

Download specification

properties namespace

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.

    Show color properties
    • auto boolean
      Required

      Set to use automatic coloring. When "auto": true, color settings are based on the visualization used.

      default = true

    • bar paletteColor
      Required

      The paletteColor object is used to define the color of bar.

      default = "{ index: 6 }"

      Show bar properties
      • color string
        Required

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

      • index number
        Required

        Index in palette
    • mode primary
      Required

      primary: a single color (by default blue) for all bar items and (by default black) for all target items in the bullet chart.

    • target paletteColor
      Required

      The target object is used to define the color of target.

      default = "{ index: -1, color: '#000000' }"

  • dimensionAxis object
    Required

    Dimension axis settings.

    Show dimensionAxis properties
    • dock 'near'  |  'far'
      Required

      Axis docking position

      default = "near"

    • label 'auto'  |  'horizontal'  |  'tilted'
      Required

      Label orientation

      default = "auto"

    • show 'all'  |  'labels'  |  'title'  |  'none'
      Required

      Labels and title

      default = "all"

  • footnote string  |  StringExpression

    Visualization footnote.

    default = ""

  • gridLine object
    Required

    Grid lines settings. Used only when using commom axis.

    Show gridLine properties
    • auto boolean
      Required

      Automatic grid line spacing.

      default = true

    • spacing 0  |  1  |  2  |  3
      Required

      Grid line spacing. Used only when auto is set to false.

      default = 2

  • measureAxis object
    Required

    Measure axis settings.

    Show measureAxis properties
    • commonAxis boolean
      Required

      When set to true, use common axis.

      default = false

    • commonRange boolean
      Required

      When set to true, use common range.

      default = false

    • dock 'near'  |  'far'
      Required

      Axis docking position

      default = "near"

    • show 'all'  |  'labels'  |  'title'  |  'none'
      Required

      Labels and title

      default = "all"

    • spacing number
      Required

      Axis scale

      default = 1

  • orientation 'vertical'  |  'horizontal'
    Required

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

    default = "vertical"

  • qHyperCubeDef object
    Required

    Extends HyperCubeDef, see Engine API: HyperCubeDef.

    Show qHyperCubeDef properties
  • scrollbar 'bar'  |  'none'
    Required

    Sets the style of the scroll bar

    default = "bar"

  • scrollStartPos number
    Required

    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

    default = 0

  • showDetails boolean

    Show visualization details 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

AttributeExpressionProperties AttributeExpressions  |  CustomTooltipAttributes

AttributeExpressions object

extends NxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

  • id string
    Required

    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.

AttributeExpressions

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

conditionalColoringProperties object

Properties

conditionalColoringProperties

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

CustomTooltipAttributes object

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

DimensionProperties object

extends NxDimension

Extends NxDimension, see Engine API: NxDimension.

Properties

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

ImageComponent object

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'

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

  • autoMinMax boolean
    Required

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

  • conditionalColoring conditionalColoringProperties
    Required

    Information of how the segments

    Show conditionalColoring properties
  • isCustomFormatted boolean
    Required

    Set to true to toggle off the default client formatting.

  • max number  |  ValueExpression
    Required

    Set the max value of the range.

  • min string
    Required

    Set the min value of the range.

  • minMax string
    Required

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

  • 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
  • useSegments boolean
    Required

    Default false. Set to true to customize segment colors.

  • autoSort boolean

    Set to automatically sort the measure.

  • cId string

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

limitsProperties object

Properties

  • gradient boolean

    Set gradient of the color.

MasterVisualizationChart object

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'

MasterVisualizationChartObject object

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

MasterVisualizationChartStyle object

Chart component information structure.

Properties

  • size string
    Required

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

MeasureProperties object

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

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

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

    • conditionalColoring conditionalColoringProperties
      Required

      Information of how the segments

      Show conditionalColoring properties
    • isCustomFormatted boolean
      Required

      Set to true to toggle off the default client formatting.

    • max number  |  ValueExpression
      Required

      Set the max value of the range.

    • min string
      Required

      Set the min value of the range.

    • minMax string
      Required

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

    • 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
    • useSegments boolean
      Required

      Default false. Set to true to customize segment colors.

    • autoSort boolean

      Set to automatically sort the measure.

    • cId string

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

MediaLibraryRef object

Media Library Reference structure.

Properties

  • qStaticContentUrlDef object
    Required

    Media library structure

paletteColor object

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

paletteColorsProperties object

Properties

  • paletteColor paletteColor
    Required
    Show paletteColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

properties.dataPoint.showLabels boolean

Show labels on data points

default = false

properties.dataPoint.showSegmentLabels boolean

Show segment labels

default = false

properties.dataPoint.showTotalLabels boolean

Show total labels

default = true

qStaticContentUrlDef object

Media Library structure that will be evaluated by the engine.

Properties

  • qUrl string
    Required

    Value of media library image

segmentsProperties object

Properties