Nebula Pivot table

Pivot Table generic object definition

Download specification

experimental

properties object

extends GenericObjectProperties

Properties

  • version string
    Required

    Current version of this generic object definition

  • qHyperCubeDef object
    Required
    Show qHyperCubeDef properties
    • qAlwaysFullyExpanded boolean
      Required

      default = false

    • qDimensions Array< DimensionProperties >
      Required
    • qMeasures Array< MeasureProperties >
      Required
    • qSuppressMissing boolean
      Required

      default = true

    • qSuppressZero boolean
      Required

      default = false

    • qShowTotalsAbove boolean
      Required

      default = true

    • qIndentMode boolean
      Required

      default = false

  • showTitles boolean

    Show title for the visualization

    default = true

  • title string  |  StringExpression

    Visualization title

    default = ""

  • subtitle string  |  StringExpression

    Visualization subtitle

    default = ""

  • footnote string  |  StringExpression

    Visualization footnote

    default = ""

  • nullValueRepresentation object

    Null value properties

    Show nullValueRepresentation properties
    • text string

      Null value text

      default = "-"

  • components Array< Component >

    General and chart specific styling

DimensionProperties object

extends NxDimension

Extends NxDimension, see Engine API: NxDimension

Properties

  • qDef InlineDimensionDef
    Required
    Show qDef properties
    • columnWidth ColumnWidth
      Show columnWidth properties
      • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
        Required

        Defines how the column width is set. For the right grid, auto calculates the width(s) so the total width of the columns equals the right grid width. If the width reaches a minimum value, the columns will overflow. For the left grid, auto is N/A and defaults to fitToContent. fitToContent calculates a width based on the column's content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart/grid width

      • pixels number

        Pixel value used if type is pixels

      • percentage number

        Percentage value used if type is percentage. Note that for the left grid columns, this is a percentage of the whole chart width. For the right grid columns, it is a percentage of the right grid width
    • textAlign TextAlign
      Show textAlign properties
      • auto boolean
        Required

        If true the chart decides text alignment, otherwise the "align" value is used.

      • align TextAlignValues

        Align value

        Show align properties
        • TextAlignValues "left"  |  "center"  |  "right"
          Required

          Text align values
  • qAttributeExpressions Array< AttributeExpressionDef >
    Required

MeasureProperties object

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure

Properties

  • qDefs InlineMeasureDef
    Required
    Show qDefs properties
    • columnWidth ColumnWidth
      Show columnWidth properties
      • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
        Required

        Defines how the column width is set. For the right grid, auto calculates the width(s) so the total width of the columns equals the right grid width. If the width reaches a minimum value, the columns will overflow. For the left grid, auto is N/A and defaults to fitToContent. fitToContent calculates a width based on the column's content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart/grid width

      • pixels number

        Pixel value used if type is pixels

      • percentage number

        Percentage value used if type is percentage. Note that for the left grid columns, this is a percentage of the whole chart width. For the right grid columns, it is a percentage of the right grid width
    • textAlign TextAlign
      Show textAlign properties
      • auto boolean
        Required

        If true the chart decides text alignment, otherwise the "align" value is used.

      • align TextAlignValues

        Align value

        Show align properties
        • TextAlignValues "left"  |  "center"  |  "right"
          Required

          Text align values
  • qAttributeExpressions Array< AttributeExpressionDef >
    Required

AttributeExpressionDef ColorByExpressionDef  |  NxAttrExprDef

ColorByExpressionId "cellBackgroundColor"  |  "cellForegroundColor"

Color by expression identifier

ColorByExpressionDef object

Properties

  • qExpression StringExpression
    Required
  • id ColorByExpressionId
    Required
    Show id properties
    • ColorByExpressionId "cellBackgroundColor"  |  "cellForegroundColor"
      Required

      Color by expression identifier

ColorByExpressionDef

{ qExpression: "=if(Sum([Sales Quantity]) > 500, green(), blue())", id: "cellBackgroundColor" }

InlineDimensionDef object

extends NxInlineDimensionDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Properties

  • columnWidth ColumnWidth
    Show columnWidth properties
    • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
      Required

      Defines how the column width is set. For the right grid, auto calculates the width(s) so the total width of the columns equals the right grid width. If the width reaches a minimum value, the columns will overflow. For the left grid, auto is N/A and defaults to fitToContent. fitToContent calculates a width based on the column's content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart/grid width

    • pixels number

      Pixel value used if type is pixels

    • percentage number

      Percentage value used if type is percentage. Note that for the left grid columns, this is a percentage of the whole chart width. For the right grid columns, it is a percentage of the right grid width
  • textAlign TextAlign
    Show textAlign properties
    • auto boolean
      Required

      If true the chart decides text alignment, otherwise the "align" value is used.

    • align TextAlignValues

      Align value

      Show align properties
      • TextAlignValues "left"  |  "center"  |  "right"
        Required

        Text align values

InlineMeasureDef object

extends NxInlineMeasureDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

  • columnWidth ColumnWidth
    Show columnWidth properties
    • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
      Required

      Defines how the column width is set. For the right grid, auto calculates the width(s) so the total width of the columns equals the right grid width. If the width reaches a minimum value, the columns will overflow. For the left grid, auto is N/A and defaults to fitToContent. fitToContent calculates a width based on the column's content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart/grid width

    • pixels number

      Pixel value used if type is pixels

    • percentage number

      Percentage value used if type is percentage. Note that for the left grid columns, this is a percentage of the whole chart width. For the right grid columns, it is a percentage of the right grid width
  • textAlign TextAlign
    Show textAlign properties
    • auto boolean
      Required

      If true the chart decides text alignment, otherwise the "align" value is used.

    • align TextAlignValues

      Align value

      Show align properties
      • TextAlignValues "left"  |  "center"  |  "right"
        Required

        Text align values

ColumnWidth object

Column width info. For the left grid, the properties are always applied. For the right grid, only the leaf nodes will listen to the properties, and the columns above will get the width of the leaves accumulated

Properties

  • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
    Required

    Defines how the column width is set. For the right grid, auto calculates the width(s) so the total width of the columns equals the right grid width. If the width reaches a minimum value, the columns will overflow. For the left grid, auto is N/A and defaults to fitToContent. fitToContent calculates a width based on the column's content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart/grid width

  • pixels number

    Pixel value used if type is pixels

  • percentage number

    Percentage value used if type is percentage. Note that for the left grid columns, this is a percentage of the whole chart width. For the right grid columns, it is a percentage of the right grid width

TextAlignValues "left"  |  "center"  |  "right"

Text align values

TextAlign object

Set the alignment of text in the chart.

Properties

  • auto boolean
    Required

    If true the chart decides text alignment, otherwise the "align" value is used.

  • align TextAlignValues

    Align value

    Show align properties
    • TextAlignValues "left"  |  "center"  |  "right"
      Required

      Text align values

Component ChartStyling  |  GeneralStyling

Styling defintions

GeneralStylingKey "general"

Mandatory key for general styling

FontStyleValues "bold"  |  "italic"  |  "underline"

Font styling values

GeneralStyling object

General chart styling

Properties

  • key GeneralStylingKey
    Required
    Show key properties
    • GeneralStylingKey "general"
      Required

      Mandatory key for general styling
  • title TitleStyling
    Required
    Show title properties
    • main TitleOptions

      Styling for chart title

      Show main properties
      • fontSize string

        Font size in pixel value

      • fontFamily string

        Font family

      • fontStyle Array< FontStyleValues >

        Font style

      • color PaletteColor

        Font color palette

        Show color properties
        • color string
          Required

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

        • index number
          Required

          Index in palette
    • subTitle TitleOptions

      Styling for chart sub title

    • footer TitleOptions

      Styling for chart footer
  • bgColor BackgroundColor  |  BackgroundColorExpression
  • bgImage BackgroundImage
    Show bgImage properties
    • mode "media"
      Required

      Mode

    • mediaUrl MediaUrl
      Required

      Media url

      Show mediaUrl properties
      • qStaticContentUrlDef object
        Required

        Background image mode

        Show qStaticContentUrlDef properties
        • qUrl string
          Required

          Relative path of the image

GeneralStyling

{
 key: "general",
 title: {
   main: {
     fontSize: "18px",
     fontFamily: "Arial",
     fontStyle: ["bold", "italic"],
     color: { color: "orangered" },
   }
 },
 bgColor: {
   useExpression: true,
   color: {
     index: 6,
     color: "#006580"
   },
   colorExpression: {
     qStringExpression: {
       qExpr: "red()"
     }
   }
 },
 bgImage: {
   mode: "media",
   mediaUrl: {
     qStaticContentUrlDef: {
       qUrl: "<path-to-image>"
     }
   }
 }
}

BackgroundColor object

Chart background color

Properties

  • color PaletteColor
    Required

    Background color palette

    Show color properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

BackgroundColorExpression object

Chart background color by expression

Properties

  • useExpression boolean
    Required

    Boolean to indicate if color by expression should be used

  • colorExpression StringExpression
    Required

    Color expression, "useExpression" must also be true

BackgroundImage object

Chart background image.

Background image takes precedence over background color.

Properties

  • mode "media"
    Required

    Mode

  • mediaUrl MediaUrl
    Required

    Media url

    Show mediaUrl properties
    • qStaticContentUrlDef object
      Required

      Background image mode

      Show qStaticContentUrlDef properties
      • qUrl string
        Required

        Relative path of the image

MediaUrl object

Media url

Properties

  • qStaticContentUrlDef object
    Required

    Background image mode

    Show qStaticContentUrlDef properties
    • qUrl string
      Required

      Relative path of the image

TitleOptions object

Title styling options

Properties

  • fontSize string

    Font size in pixel value

  • fontFamily string

    Font family

  • fontStyle Array< FontStyleValues >

    Font style

  • color PaletteColor

    Font color palette

    Show color properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

TitleStyling object

Title styling

Properties

  • main TitleOptions

    Styling for chart title

    Show main properties
    • fontSize string

      Font size in pixel value

    • fontFamily string

      Font family

    • fontStyle Array< FontStyleValues >

      Font style

    • color PaletteColor

      Font color palette

      Show color properties
      • color string
        Required

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

      • index number
        Required

        Index in palette
  • subTitle TitleOptions

    Styling for chart sub title

  • footer TitleOptions

    Styling for chart footer

ChartStylingKey "theme"

Mandatory key for chart styling

ChartStyling object

Custom styling of cells

Properties

  • key ChartStylingKey
    Required
    Show key properties
    • ChartStylingKey "theme"
      Required

      Mandatory key for chart styling
  • header CellStyling

    Styling for header cells

    Show header properties
    • fontSize string

      Font size in pixel value

    • fontFamily string

      Font family

    • fontStyle Array< FontStyleValues >

      Font style

    • fontColor PaletteColor

      Font color palette

      Show fontColor properties
      • color string
        Required

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

      • index number
        Required

        Index in palette
    • background PaletteColor

      Cell background color palette
  • dimensionValues CellStyling

    Styling for dimension value cells

  • measureValues CellStyling

    Styling for measure value cells

  • measureLabels PartialCellStyling

    Styling for measure label cells

    Show measureLabels properties
  • totalValues PartialCellStyling

    Styling for total value cells

  • nullValues PartialCellStyling

    Styling for null values cells

  • grid GridStyling

    General grid styling

    Show grid properties
    • lineClamp number

      A numerical value that represents the number of lines a text at most can be splitt into

    • border PaletteColor

      Border color between cells

    • divider PaletteColor

      Border color between row and column dimensions sections

    • background PaletteColor

ChartStyling

{
 key: "theme",
 dimensionValues: {
   fontSize: "18px",
   fontFamily: "Arial",
   fontStyle: ["bold", "italic"],
   fontColor: { color: "orangered" },
   background: { index: 2 }
 }
}

CellStyling object

Properties for styling a cell

Properties

  • fontSize string

    Font size in pixel value

  • fontFamily string

    Font family

  • fontStyle Array< FontStyleValues >

    Font style

  • fontColor PaletteColor

    Font color palette

    Show fontColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette
  • background PaletteColor

    Cell background color palette

PartialCellStyling object

Properties for styling a cell

Properties

  • fontStyle Array< FontStyleValues >

    Font style

  • fontColor PaletteColor

    Font color palette

    Show fontColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette
  • background PaletteColor

    Cell background color palette

GridStyling object

General grid styling

Properties

  • lineClamp number

    A numerical value that represents the number of lines a text at most can be splitt into

  • border PaletteColor

    Border color between cells

    Show border properties
    • color string
      Required

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

    • index number
      Required

      Index in palette
  • divider PaletteColor

    Border color between row and column dimensions sections

  • background PaletteColor

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