Nebula Table

Table 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
    • qDimensions Array< DimensionProperties >
      Required

      The maximum amount of dimensions is 1000

    • qMeasures Array< MeasureProperties >
      Required

      The maximum amount of measures is 1000

    • qColumnOrder Array< number >
      Required
  • showTitles boolean

    Show title for the visualization

    default = true

  • enableChartExploration boolean

    Show chart exploration option in context menu

    default = false

  • title string  |  StringExpression

    Visualization title

    default = ""

  • subtitle string  |  StringExpression

    Visualization subtitle

    default = ""

  • footnote string  |  StringExpression

    Visualization footnote

    default = ""

  • totals object

    totals settings

    Show totals properties
    • label string

      The label of the totals row, shown in the leftmost column

      default = "Totals"

    • show boolean

      If set to true, the display of the totals row will be handled automatically, and the position prop will be ignored.

      default = true

    • position 'top'  |  'bottom'  |  'noTotals'

      The position of the totals row, hiding it if set to noTotals

      default = "noTotals"

  • usePagination boolean

    Use pagination or continuous scroll. If undefined, defaults to using pagination

    default = false

  • components Array< Component >
    Required

    Holds general styling

DimensionProperties object

extends NxDimension

Extends NxDimension, see Engine API: NxDimension

Properties

  • qDef InlineDimensionDef
    Required
    Show qDef properties
    • textAlign TextAlign
      Show textAlign properties
      • auto boolean
        Required

        If true, sets the alignment based on the type of column (left for dimension, right for measure)

      • align 'left'  |  'center'  |  'right'
        Required

        Is used (and mandatory) if auto is false
    • columnWidth ColumnWidth
      Show columnWidth properties
      • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
        Required

        Defines how the column width is set. auto calculates the width(s) so the total table width equals the chart width. fitToContent calculates a width based on the cells' content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart width

      • pixels number

        Is used (and mandatory) if type is pixels

      • percentage number

        Is used (and mandatory) if type is percentage
  • qAttributeExpressions Array< AttributeExpressionProperties >
    Required

MeasureProperties object

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure

Properties

  • qDef InlineMeasureDef
    Required
    Show qDef properties
    • textAlign TextAlign
      Show textAlign properties
      • auto boolean
        Required

        If true, sets the alignment based on the type of column (left for dimension, right for measure)

      • align 'left'  |  'center'  |  'right'
        Required

        Is used (and mandatory) if auto is false
    • columnWidth ColumnWidth
      Show columnWidth properties
      • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
        Required

        Defines how the column width is set. auto calculates the width(s) so the total table width equals the chart width. fitToContent calculates a width based on the cells' content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart width

      • pixels number

        Is used (and mandatory) if type is pixels

      • percentage number

        Is used (and mandatory) if type is percentage
  • qAttributeExpressions Array< AttributeExpressionProperties >
    Required

InlineDimensionDef object

extends NxInlineDimensionDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Properties

  • textAlign TextAlign
    Show textAlign properties
    • auto boolean
      Required

      If true, sets the alignment based on the type of column (left for dimension, right for measure)

    • align 'left'  |  'center'  |  'right'
      Required

      Is used (and mandatory) if auto is false
  • columnWidth ColumnWidth
    Show columnWidth properties
    • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
      Required

      Defines how the column width is set. auto calculates the width(s) so the total table width equals the chart width. fitToContent calculates a width based on the cells' content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart width

    • pixels number

      Is used (and mandatory) if type is pixels

    • percentage number

      Is used (and mandatory) if type is percentage

InlineMeasureDef object

extends NxInlineMeasureDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

  • textAlign TextAlign
    Show textAlign properties
    • auto boolean
      Required

      If true, sets the alignment based on the type of column (left for dimension, right for measure)

    • align 'left'  |  'center'  |  'right'
      Required

      Is used (and mandatory) if auto is false
  • columnWidth ColumnWidth
    Show columnWidth properties
    • type 'auto'  |  'FitToContent'  |  'pixels'  |  'percentage'
      Required

      Defines how the column width is set. auto calculates the width(s) so the total table width equals the chart width. fitToContent calculates a width based on the cells' content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart width

    • pixels number

      Is used (and mandatory) if type is pixels

    • percentage number

      Is used (and mandatory) if type is percentage

AttributeExpressionProperties object

extends NxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef. Column specific styling overrides general styling, that is defined in components.

Properties

  • id 'cellForegroundColor'  |  'cellBackgroundColor'  |  'textStyleExpression'
    Required

    specifying what the style applies to

TextAlign object

extends NxInlineDimensionDef

Holds text alignment for a specific column.

Properties

  • auto boolean
    Required

    If true, sets the alignment based on the type of column (left for dimension, right for measure)

  • align 'left'  |  'center'  |  'right'
    Required

    Is used (and mandatory) if auto is false

ColumnWidth object

Column width info

Properties

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

    Defines how the column width is set. auto calculates the width(s) so the total table width equals the chart width. fitToContent calculates a width based on the cells' content. pixels uses a specified pixel value. percentage sets the column width to specified percentage of the chart width

  • pixels number

    Is used (and mandatory) if type is pixels

  • percentage number

    Is used (and mandatory) if type is percentage

Component object

General styling for all columns. Split up into header and content (body) styling. If any property is not set, default values specific for each property is used.

Properties

  • key string
    Required

    This should be set to theme

  • content ContentStyling
    Show content properties
    • fontSize number

      Defaults to 14

    • fontColor PaletteColor

      Defaults to #404040

      Show fontColor properties
      • color string
        Required

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

      • index number
        Required

        Index in palette
    • hoverEffect boolean

      Toggles hover effect

    • hoverColor PaletteColor

      Background hover color. Uses #f4f4f4 if no hover colors are set, is transparent if only hoverFontColor is set

    • hoverFontColor PaletteColor

      When only hoverColor is set, this is adjusted to either #f4f4f4 or #ffffff for optimal contrast

    • padding string

      Css setting for the cell padding, defaults to 4px 12px
  • header HeaderStyling
    Show header properties
    • fontSize number

      Defaults to 14

    • fontColor PaletteColor

      Defaults to #404040

ContentStyling object

Holds properties for font size, font color and hover styling.

Properties

  • fontSize number

    Defaults to 14

  • fontColor PaletteColor

    Defaults to #404040

    Show fontColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette
  • hoverEffect boolean

    Toggles hover effect

  • hoverColor PaletteColor

    Background hover color. Uses #f4f4f4 if no hover colors are set, is transparent if only hoverFontColor is set

  • hoverFontColor PaletteColor

    When only hoverColor is set, this is adjusted to either #f4f4f4 or #ffffff for optimal contrast

  • padding string

    Css setting for the cell padding, defaults to 4px 12px

HeaderStyling object

Holds properties for font size and color.

Properties

  • fontSize number

    Defaults to 14

  • fontColor PaletteColor

    Defaults to #404040

    Show fontColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

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