Nebula Pie chart

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

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

    • byDimDef byDimDef
      Show byDimDef properties
      • key string
        Required

        libraryId if "type": "libraryItem", dimension expression if "type": "expression"

      • label string
        Required

        Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.

      • type 'expression'  |  'libraryItem'
        Required
    • byMeasureDef byMeasureDef
      Show byMeasureDef properties
      • key string
        Required

        libraryId if "type": "libraryItem", measure expression if "type": "expression"

      • label string
        Required

        Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.

      • type 'expression'  |  'libraryItem'
        Required
    • colorExpression string

      Sets the color expression to be used when "mode": "byExpression" is defined. Expression can evaluate either to a numerical value or a color code if "expressionIsColor": true. Supported formats are: RGB, ARGB and HSL

    • dimensionScheme string
      Required

      Color scheme when "mode": "byDimension" or "mode": "byMultiple" ("12" or "100" for most themes).

    • expressionIsColor boolean
      Required

      Set to define whether the result of the expression is a valid CSS3 color. Only applicable when "mode": "byExpression".

    • expressionLabel string
      Required

      Label to be defined on tool tips when using a coloring expression. Only used if "expressionIsColor": false.

    • formatting object
      Required

      Color by measure number formatting options

      Show formatting properties
      • isCustomFormatted boolean

        If true, the client formatting will be toggled off

      • numFormatFromTemplate boolean

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

    • Set the max value for the color range. Only applicable if "autoMinMax": false.

    • Set the min value for the color range. Only applicable if "autoMinMax": false.

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

      The paletteColor object is used to define the color when you color by single color ("mode": "primary").

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

    • reverseScheme boolean
      Required

      Set to reverse the color scheme.

    • singleColor number Deprecated
      Required
    • useBaseColors 'off'  |  'dimension'  |  'measure'
      Required

      Use colors encoded in master items. Only applicable when "mode": "primary" or "mode": "byMultiple" has been defined.

    • useDimColVal boolean
      Required

      Set to true if you want to apply the colors defined for library dimensions when used. Only applicable if 'colorMode': 'byDimension'.

    • useMeasureGradient boolean
      Required

      Set to true if you want to apply the colors defined for library measures when used. Only applicable if "mode": "byMeasure".

  • components Array< Component >
    Required

    Styling of chart components.

  • dataPoint object
    Required

    Data point settings.

    Show dataPoint properties
    • auto boolean
      Required

      Automatically select how to present data point values.

    • labelMode 'none'  |  'share'  |  'value'
      Required

      Set how to present data point values. Dependent of the auto property

    • labelValueMode 'arc'  |  'radius'
      Required

      Set how to present data point values. Dependent of the auto property

  • dimensionTitle boolean
    Required

    Display the dimension title.

  • donut object
    Required

    Pie chart donut settings.

    Show donut properties
    • showAsDonut boolean
      Required

      Set to present the pie chart as a donut.

  • footnote string  |  StringExpression

    Visualization footnote.

  • legend object
    Required

    Legend settings.

    Show legend properties
    • dock 'auto'  |  'right'  |  'left'  |  'bottom'  |  'top'
      Required

      Sets the legend position.

    • show boolean
      Required

      Set to show the legend.

    • showTitle boolean
      Required

      Show the legend title.

  • qHyperCubeDef object
    Required

    Extends HyperCubeDef, see Engine API: HyperCubeDef.

    Show qHyperCubeDef properties
  • showDetails boolean

    Show visualization details toggle

  • showDisclaimer boolean
    Required

    Show visualization disclaimer toggle

  • showTitles boolean

    Show title for the visualization.

  • subtitle string  |  StringExpression

    Visualization subtitle.

  • title string  |  StringExpression

    Visualization title.

  • tooltip object
    Required

    Custom tooltip properties

    Show tooltip properties
    • auto boolean
      Required

      Toggle for using custom tooltip or regular tooltip

    • The chart object is used to define the chart displayed by the custom tooltip.

      Show chart properties
      • 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

      • Object containing the styles of the chart such as 'size'

        Show style properties
        • size string
          Required

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

    • data object
      Required

      Data for the custom tooltip.

      Show data properties
      • qHyperCubeDef HyperCubeDef
        Required

        A hypercube definition containing measures to be displayed in the custom tooltip. Extends HyperCubeDef, see Engine API: HyperCubeDef.

    • hideBasic boolean
      Required

      Toggle for hiding basic information from custom tooltip

    • imageComponents Array< ImageComponent >
      Required

      The imageComponents objects are used to define the images displayed by the custom tooltip.

  • version string
    Required

    Current version of this generic object definition

AttributeDimensionProperties object

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

AttributeExpressionProperties ColorAttributes  |  CustomTooltipAttributes

Axis object

Properties

  • Required
    Show axis properties
    • Required
      Show title properties
      • Required
        Show color properties
        • color string
          Required

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

        • index number
          Required

          Index in palette

      • fontFamily string
        Required
      • fontSize string
        Required
  • key string
    Required

    This should be set to "axis" (Determines which component the settings apply to).

AxisStyling object

Properties

  • Required
    Show title properties
    • Required
      Show color properties
      • color string
        Required

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

      • index number
        Required

        Index in palette

    • fontFamily string
      Required
    • fontSize string
      Required

byDimDef object

Settings when coloring by dimension ("mode": "byDimension")

Properties

  • key string
    Required

    libraryId if "type": "libraryItem", dimension expression if "type": "expression"

  • label string
    Required

    Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.

  • type 'expression'  |  'libraryItem'
    Required

byMeasureDef object

Settings when coloring by measure ("mode": "byMeasure")

Properties

  • key string
    Required

    libraryId if "type": "libraryItem", measure expression if "type": "expression"

  • label string
    Required

    Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.

  • type 'expression'  |  'libraryItem'
    Required

ColorAttributes object

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

Component Slices  |  Label  |  Axis  |  Legend

CustomTooltipAttributes object

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, see Engine API: NxDimension.

Properties

FontStyling object

Properties

  • Required
    Show color properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

  • fontFamily string
    Required
  • fontSize string
    Required

ImageComponent object

Image component information structure.

Properties

  • cId string
    Required

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

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

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

Label object

Properties

  • key string
    Required

    This should be set to "label" (Determines which component the settings apply to).

  • Required
    Show label properties
    • Required

      Dimension value labels

      Show name properties
      • Required
        Show name properties
        • Required
          Show color properties
          • color string
            Required

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

          • index number
            Required

            Index in palette

        • fontFamily string
          Required
        • fontSize string
          Required
    • Required

      Measure value labels and share.

      Show value properties

LabelNameStyling object

Properties

  • Required
    Show name properties
    • Required
      Show color properties
      • color string
        Required

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

      • index number
        Required

        Index in palette

    • fontFamily string
      Required
    • fontSize string
      Required

LabelStyling object

Properties

  • Required

    Dimension value labels

    Show name properties
    • Required
      Show name properties
      • Required
        Show color properties
        • color string
          Required

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

        • index number
          Required

          Index in palette

      • fontFamily string
        Required
      • fontSize string
        Required
  • Required

    Measure value labels and share.

    Show value properties

LabelValueStyling object

Properties

  • Required
    Show value properties
    • Required
      Show color properties
      • color string
        Required

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

      • index number
        Required

        Index in palette

    • fontFamily string
      Required
    • fontSize string
      Required

Legend object

Properties

  • key string
    Required

    This should be set to "legend" (Determines which component the settings apply to).

  • Required
    Show legend properties
    • label LabelNameStyle
      Required
    • Required
      Show title properties
      • Required
        Show color properties
        • color string
          Required

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

        • index number
          Required

          Index in palette

      • fontFamily string
        Required
      • fontSize string
        Required

LegendStyling object

Properties

  • label LabelNameStyle
    Required
  • Required
    Show title properties
    • Required
      Show color properties
      • color string
        Required

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

      • index number
        Required

        Index in palette

    • fontFamily string
      Required
    • fontSize string
      Required

MasterVisualizationChart object

Chart component information structure.

Properties

  • 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

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

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

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

qStaticContentUrlDef object

Media Library structure that will be evaluated by the engine.

Properties

  • qUrl string
    Required

    Value of media library image

Slices object

Properties

  • key string
    Required

    This should be set to "slices" (Determines which component the settings apply to).

  • Required
    Show style properties
    • cornerRadius number
      Required

      A number between 0 and 40.

    • innerRadius number
      Required

      A number between 0.05 and 0.75. Only applicable for "donut" representation.

    • strokeColor paletteColor
      Required

      index: -1, color: '#ffffff' }"

      Show strokeColor properties
      • color string
        Required

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

      • index number
        Required

        Index in palette

    • strokeWidth 'none'  |  'small'  |  'medium'  |  'large'
      Required

      Set to specify stroke width.

SlicesStyling object

Properties

  • cornerRadius number
    Required

    A number between 0 and 40.

  • innerRadius number
    Required

    A number between 0.05 and 0.75. Only applicable for "donut" representation.

  • strokeColor paletteColor
    Required

    index: -1, color: '#ffffff' }"

    Show strokeColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

  • strokeWidth 'none'  |  'small'  |  'medium'  |  'large'
    Required

    Set to specify stroke width.