Nebula Navigation menu

Navigation menu generic object definition

Download specification

properties object

extends GenericObjectProperties

Properties

  • components Array< Component >
    Required

    Holds general styling

  • footnote string  |  StringExpression

    Visualization footnote

    default = ""

  • layoutOptions object
    Required

    Layout settings.

    Show layoutOptions properties
    • alignment 'top-left'  |  'top-center'  |  'top-right'  |  'center-left'  |  'center-center'  |  'center-right'  |  'bottom-left'  |  'bottom-center'  |  'bottom-right'

      The alignment of the menu in the object viewport in both directions(horizontal and vertical)

    • dividerColor PaletteColor

      Divider color settings.

      Show dividerColor properties
      • color string
        Required

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

      • index number
        Required

        Index in palette

      • alpha number

        Transparency value, default to 1
    • drawerMode boolean

      If set to true, the navigation menu is displayed as a button, and the orientation and layout properties will be ignored. If set to false, the navigation menu is displayed as a menu, and the showDrawerIcon property will be ignored.

      default = false

    • largeItems boolean

      If set to true, menu items have a bigger padding top and bottom.

      default = false

    • layout 'fill'  |  'minimal'

      The space layout of the menu. If set to fill, menu items use all space in horizontal direction, if set to minimal, menu items use minimum space in horizontal direction.

    • orientation 'vertical'  |  'horizontal'

      The orientation of the menu. If set to vertical, menu items are displayed vertically, if set to horizontal, menu items are displayed horizontally

    • sameItemWidth boolean

      This is only valid if orientation property is set to horizontal. If set to true, all items have the same width.

      default = true

    • separateItems boolean

      If set to true, a divider is displayed between two menu items.

      default = false

    • showDrawerIcon boolean

      If set to true, the drawer icon is displayed.

      default = true

    • showItemIcons boolean

      If set to true, an icon is displayed to the left of a menu item.

      default = false

  • showDetails boolean

    Show visualization details toggle

    default = false

  • showTitles boolean

    Show title for the visualization

    default = false

  • subtitle string  |  StringExpression

    Visualization subtitle

    default = ""

  • title string  |  StringExpression

    Visualization title

    default = ""

  • version string
    Required

    Current version of this generic object definition

Component object

General styling for navigation menu. 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
    • fontFamily string
      Required

      Defaults to Source Sans Pro, sans serif

    • fontSize string
      Required

      Defaults to 12px

    • fontStyle FontStyle
      Required
      Show fontStyle properties
      • bold boolean
        Required

        Default to false

      • italic boolean
        Required

        Default to false

      • normal boolean
        Required

        Default to true

      • underline boolean
        Required

        Default to false
    • borderColor PaletteColor
      Show borderColor properties
      • color string
        Required

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

      • index number
        Required

        Index in palette

      • alpha number

        Transparency value, default to 1
    • borderRadius string
    • borderWidth string
    • boxShadow string
    • boxShadowColor PaletteColor
    • defaultColor PaletteColor

      Menu item color, defaults to white

    • defaultFontColor PaletteColor

      Defaults to #404040

    • drawerButton DrawerButtonStyling
      Show drawerButton properties
      • defaultColor PaletteColor

        Drawer button color, defaults to white

      • hoverColor PaletteColor

        Color when a drawer button is hovered, defaults to white
    • highlightColor PaletteColor

      Color when a menu item is highlighted, defaults to white

    • highlightFontColor PaletteColor

      Defaults to #404040

    • hoverColor PaletteColor

      Color when a menu item is hovered, defaults to #d3d3d3

    • hoverFontColor PaletteColor

      Defaults to #404040

ContentStyling object

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

Properties

  • fontFamily string
    Required

    Defaults to Source Sans Pro, sans serif

  • fontSize string
    Required

    Defaults to 12px

  • fontStyle FontStyle
    Required
    Show fontStyle properties
    • bold boolean
      Required

      Default to false

    • italic boolean
      Required

      Default to false

    • normal boolean
      Required

      Default to true

    • underline boolean
      Required

      Default to false
  • borderColor PaletteColor
    Show borderColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

    • alpha number

      Transparency value, default to 1
  • borderRadius string
  • borderWidth string
  • boxShadow string
  • boxShadowColor PaletteColor
  • defaultColor PaletteColor

    Menu item color, defaults to white

  • defaultFontColor PaletteColor

    Defaults to #404040

  • drawerButton DrawerButtonStyling
    Show drawerButton properties
    • defaultColor PaletteColor

      Drawer button color, defaults to white

    • hoverColor PaletteColor

      Color when a drawer button is hovered, defaults to white
  • highlightColor PaletteColor

    Color when a menu item is highlighted, defaults to white

  • highlightFontColor PaletteColor

    Defaults to #404040

  • hoverColor PaletteColor

    Color when a menu item is hovered, defaults to #d3d3d3

  • hoverFontColor PaletteColor

    Defaults to #404040

DrawerButtonStyling object

Holds properties for drawer button styling.

Properties

  • defaultColor PaletteColor

    Drawer button color, defaults to white

    Show defaultColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette

    • alpha number

      Transparency value, default to 1
  • hoverColor PaletteColor

    Color when a drawer button is hovered, defaults to white

FontStyle object

Font style

Properties

  • bold boolean
    Required

    Default to false

  • italic boolean
    Required

    Default to false

  • normal boolean
    Required

    Default to true

  • underline boolean
    Required

    Default to false

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

  • alpha number

    Transparency value, default to 1