Nebula KPI

KPI generic object definition

Download specification

properties object

extends GenericObjectProperties

Properties

  • version string
    Required

    Current version of this generic object definition

  • qHyperCubeDef object
    Required

    Extends HyperCubeDef, see Engine API: HyperCubeDef

    Show qHyperCubeDef properties
    • qMeasures Array< MeasureProperties >
      Required
    • qSuppressZero boolean
      Required

      default = false

    • qSuppressMissing boolean
      Required

      default = true

  • showTitles boolean

    default = false

  • title string

    default = ""

  • subtitle string

    default = ""

  • footnote string

    default = ""

  • showDetails boolean

    default = true

  • showMeasureTitle boolean
    Required

    default = true

  • showSecondMeasureTitle boolean
    Required

    default = true

  • textAlign 'left'  |  'center'  |  'right'

    default = "center"

  • layoutBehavior 'responsive'  |  'fixed'  |  'relative'

    default = "relative"

  • disableNavMenu boolean
    Required

    default = true

  • fontSize 'S'  |  'M'  |  'L'
    Required

    default = "M"

  • useLink boolean
    Required

    default = false

  • sheetLink string

    default = ""

  • openUrlInNewTab boolean

    default = true

  • components array
    Required

MeasureProperties object

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

  • coloring Coloring
    Show coloring properties
    • baseColor PaletteColor
      Show baseColor properties
      • index number
        Required
      • color string
        Required
    • gradient Gradient
      Show gradient properties
      • colors Array< PaletteColor >
        Required
      • breakTypes Array< boolean >
        Required
      • limits Array< number >
        Required
      • limitType 'percent'  |  'absolute'
        Required
  • measureAxis MeasureAxis
    Required
    Show measureAxis properties
    • min number
      Required
    • max number
      Required
  • conditionalColoring ConditionalColoring
    Required
    Show conditionalColoring properties
    • useConditionalColoring boolean
      Required
    • useBaseColors boolean
      Required
    • paletteSingleColor PaletteColor
      Required
    • segments Segments
      Required
      Show segments properties

Coloring object

Properties

  • baseColor PaletteColor
    Show baseColor properties
    • index number
      Required
    • color string
      Required
  • gradient Gradient
    Show gradient properties
    • colors Array< PaletteColor >
      Required
    • breakTypes Array< boolean >
      Required
    • limits Array< number >
      Required
    • limitType 'percent'  |  'absolute'
      Required

MeasureAxis object

Properties

  • min number
    Required
  • max number
    Required

ConditionalColoring object

Properties

  • useConditionalColoring boolean
    Required
  • useBaseColors boolean
    Required
  • paletteSingleColor PaletteColor
    Required
    Show paletteSingleColor properties
    • index number
      Required
    • color string
      Required
  • segments Segments
    Required
    Show segments properties

Gradient object

Properties

  • colors Array< PaletteColor >
    Required
  • breakTypes Array< boolean >
    Required
  • limits Array< number >
    Required
  • limitType 'percent'  |  'absolute'
    Required

Segments object

Properties

Limit object

Properties

  • value number
    Required
  • gradient boolean
    Required

PaletteColor object

Properties

  • index number
    Required
  • color string
    Required