Nebula Button

Action button generic object definition

extends EngineAPI.GenericObjectProperties

Properties

version string
Required
Current version of this generic object definition.
showTitles boolean
Show title for the visualization
default = false
title string
Visualization title
default = ""
subtitle string
Visualization subtitle
default = ""
footnote string
Visualization footnote
default = ""
useEnabledCondition boolean
Required
Controlling if the button should use an expression to determine if it is enabled or not
default = false
enabledCondition number | EnabledExpression
Required
Number or expression evaluating to number, 0 means disabling the button
default = 1
actions Array< Action >
Required
List of actions, performed in this order
runtimeExpressionEvaluation
Required
Boolean to determine the parallel evaluation of expression. Set to true if you want the expression to be evaluated between the actions (instead of upfront).
navigation NavigationAction
Required
Navigation action to move to new sheet/URL, performed after all other actions
Show navigation properties
- action 'nextSheet' | 'prevSheet' | 'firstSheet' | 'lastSheet' | 'goToSheet' | 'goToSheetById' | 'goToSheetById' | 'goToStory' | 'openWebsite' | 'odagLink' | 'openChainedApp'
  Required
  Name of navigation action
- appId string
  app ID. Required for 'openChainedApp'
- sheet string
  sheet ID. Required for 'goToSheet' and 'goToSheetById'
- chartId string
  chart ID. Required for 'goToSheet' and highlighting the chart
- story string
  Story ID. Required for 'goToStory'
- websiteUrl string
  URL for website. required for 'openWebsite'
- sameWindow boolean
  Set to true to open in same window/tab. Required for 'openWebsite'
- odagLink string
  ODAG link name. Required for 'odagLink'
style Style
Required
All styling options
Show style properties
- label string
  The text displayed on the button
  default = "Button"
- showLabel boolean
  If the label should be shown or hidden
  default = true
- font Font
  Styling for the label
  
  Show font properties
  
  fontFamily string
  Font Family of the label
  default = "Source Sans Pro"
  
  useColorExpression boolean
  Set to true to use color expression
  default = false
  
  color PaletteColor
  Color defined by index or hex code, needed if useColorExpression is false
  
  Show color properties
  
  color string
  Color as hex string (only used if index: -1)
  
  index number
  Index in palette
  
  colorExpression ColorExpression
  Color defined by expression, needed if useColorExpression is true
  
  Show colorExpression properties
  
  qStringExpression object
  Required
  
  Show qStringExpression properties
  
  qExpr string
  Required
  expression that resolves to a supported color format
  
  size number
  Relative[] size of label, must be greater than 0 and 1 fills the entire button
  default = 0.5
  
  sizeFixed number
  Fixed size of the label in pixels. Must be bigger than 5. Only active when sizeBehavior is fixed.
  default = 20
  
  align 'left' | 'center' | 'right'
  Horizontal alignment
  default = "center"
  
  style object
  Additional style options
  
  Show style properties
  
  bold boolean
  Bold text
  default = true
  
  italic boolean
  Italic text
  default = false
  
  underline boolean
  Underlined text
  default = false
  
  sizeBehavior 'responsive' | 'relative' | 'fixed'
  Setting to determine how the fontsize of the label is calculated.
  default = "responsive"
- background Background
  Styling for background, including image
  
  Show background properties
  
  useColorExpression boolean
  Set to true to use color expression
  default = false
  
  color PaletteColor
  Color defined by index or hex code, needed if useColorExpression is false
  
  colorExpression ColorExpression
  Color defined by expression, needed if useColorExpression is true
  
  mode 'none' | 'media'
  Toggles the background image, set to media to show the image
  default = "none"
  
  useImage boolean
  Set to true to show background image
  default = false
  
  url object
  Contains the URL for the background image
  
  Show url properties
  
  qStaticContentUrlDef object
  
  Show qStaticContentUrlDef properties
  
  qUrl string
  URL represented as a string
  
  position 'topLeft' | 'centerLeft' | 'bottomLeft' | 'topCenter' | 'centerCenter' | 'bottomCenter' | 'topRight' | 'centerRight' | 'bottomRight' | 'top-left' | 'center-left' | 'bottom-left' | 'top-center' | 'center-center' | 'top-right' | 'center-right' | 'bottom-right'
  Image position
  default = "center-center"
  
  size 'auto' | 'alwaysFit' | 'fitWidth' | 'fitHeight' | 'fill' | 'alwaysFill' | 'stretchFit'
  Size of the image, relative to the button
  default = "auto"
- border Border
  Styling for border
  
  Show border properties
  
  useBorder boolean
  Set to true to use border expression
  default = false
  
  width number
  Relative width, 0 is no border and 1 make the border fill the entire button
  default = 0
  
  radius number
  Relative border radius, 0 is no rounding and 1 will make the short side a half circle
  default = 0
  
  useColorExpression boolean
  Set to true to use color expression
  default = false
  
  color PaletteColor
  Color defined by index or hex code, needed if useColorExpression is false
  
  colorExpression string
  Color defined by expression, needed if useColorExpression is true
- icon Icon
  Styling for icon
  
  Show icon properties
  
  useIcon boolean
  Set to true to show icon, default is false
  default = false
  
  iconType object
  holds the name of the icon
  
  Show iconType properties
  
  value string
  name of icon
  default = ""
  
  position 'left' | 'right'
  Defines which side of the label the icon will be
  default = "left"

Defines what action to perform and options for that action type.

Properties

actionLabel string
Label for reference
default = ""
actionType 'applyBookmark' | 'back' | 'forward' | 'clearAll' | 'clearAllButThis' | 'clearField' | 'selectAll' | 'selectValues' | 'selectMatchingValues' | 'selectAlternative' | 'selectExcluded' | 'selectPossible' | 'toggleSelect' | 'lockAll' | 'lockField' | 'unlockAll' | 'unlockField' | 'setVariable' | 'doReload' | 'executeAutomation' | 'refreshDynamicViews'
The type of action
default = ""
bookmark string
ID of bookmark, required for type 'applyBookmark'
default = ""
field string
Name of field. Required for types 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible', 'toggleSelect', 'lockField' and 'unlockField'
default = ""
softLock string
Set to true to ignore locked field(s). Required for types 'clearAll', 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible' and 'toggleSelect'
default = ""
value string
To select certain values in a field or set a variable. Required for types 'selectValues', 'selectMatchingValues', 'toggleSelect' and 'setVariable'
default = ""
variable string
Name of variable. Required for type 'setVariable'
default = ""
partial boolean
Set to true if you want to do a partial reload.
default = false
automation string
Item ID of the automation (the id field returned from /api/v1/items?resourceType=automations)
default = ""
automationId string
ID of the automation (the id field from /api/v1/automations OR the id field from /api/v1/automations)
default = ""
automationPostData boolean
Set to true to include the current selections in the automation. Defaults to false
default = false
automationTriggered boolean
Set to true when the automation should use the triggered run mode. Defaults to false
default = false
automationTriggeredText string
Helper text when using the triggered run mode. Defaults to false
default = ""
automationExecutionToken string
Token used when using the triggered run mode
default = ""
automationShowNotification boolean
Set to true when an automation should return a notification when finished running. Defaults to false
default = false
automationNotificationDuration string
The amount of time in seconds that a notification should remain visible after running an automation
default = ""
automationNotificationDurationHelp string
Helper text when enabling notifications
default = ""
automationOpenLinkSameWindow boolean
Set to true if you want links from notifications to be opened in the same tab
default = false

Defines a navigation action to perform after the other actions. Note that when the sn-action-button is used outside Qlik Sense you can only use the 'openWebsite' action.

Properties

action 'nextSheet' | 'prevSheet' | 'firstSheet' | 'lastSheet' | 'goToSheet' | 'goToSheetById' | 'goToSheetById' | 'goToStory' | 'openWebsite' | 'odagLink' | 'openChainedApp'
Required
Name of navigation action
appId string
app ID. Required for 'openChainedApp'
sheet string
sheet ID. Required for 'goToSheet' and 'goToSheetById'
chartId string
chart ID. Required for 'goToSheet' and highlighting the chart
story string
Story ID. Required for 'goToStory'
websiteUrl string
URL for website. required for 'openWebsite'
sameWindow boolean
Set to true to open in same window/tab. Required for 'openWebsite'
odagLink string
ODAG link name. Required for 'odagLink'

Holds styling options

Properties

label string
The text displayed on the button
default = "Button"
showLabel boolean
If the label should be shown or hidden
default = true
font Font
Styling for the label
Show font properties
- fontFamily string
  Font Family of the label
  default = "Source Sans Pro"
- useColorExpression boolean
  Set to true to use color expression
  default = false
- color PaletteColor
  Color defined by index or hex code, needed if useColorExpression is false
  
  Show color properties
  
  color string
  Color as hex string (only used if index: -1)
  
  index number
  Index in palette
- colorExpression ColorExpression
  Color defined by expression, needed if useColorExpression is true
  
  Show colorExpression properties
  
  qStringExpression object
  Required
  
  Show qStringExpression properties
  
  qExpr string
  Required
  expression that resolves to a supported color format
- size number
  Relative[] size of label, must be greater than 0 and 1 fills the entire button
  default = 0.5
- sizeFixed number
  Fixed size of the label in pixels. Must be bigger than 5. Only active when sizeBehavior is fixed.
  default = 20
- align 'left' | 'center' | 'right'
  Horizontal alignment
  default = "center"
- style object
  Additional style options
  
  Show style properties
  
  bold boolean
  Bold text
  default = true
  
  italic boolean
  Italic text
  default = false
  
  underline boolean
  Underlined text
  default = false
- sizeBehavior 'responsive' | 'relative' | 'fixed'
  Setting to determine how the fontsize of the label is calculated.
  default = "responsive"
background Background
Styling for background, including image
Show background properties
- useColorExpression boolean
  Set to true to use color expression
  default = false
- color PaletteColor
  Color defined by index or hex code, needed if useColorExpression is false
- colorExpression ColorExpression
  Color defined by expression, needed if useColorExpression is true
- mode 'none' | 'media'
  Toggles the background image, set to media to show the image
  default = "none"
- useImage boolean
  Set to true to show background image
  default = false
- url object
  Contains the URL for the background image
  
  Show url properties
  
  qStaticContentUrlDef object
  
  Show qStaticContentUrlDef properties
  
  qUrl string
  URL represented as a string
- position 'topLeft' | 'centerLeft' | 'bottomLeft' | 'topCenter' | 'centerCenter' | 'bottomCenter' | 'topRight' | 'centerRight' | 'bottomRight' | 'top-left' | 'center-left' | 'bottom-left' | 'top-center' | 'center-center' | 'top-right' | 'center-right' | 'bottom-right'
  Image position
  default = "center-center"
- size 'auto' | 'alwaysFit' | 'fitWidth' | 'fitHeight' | 'fill' | 'alwaysFill' | 'stretchFit'
  Size of the image, relative to the button
  default = "auto"
border Border
Styling for border
Show border properties
- useBorder boolean
  Set to true to use border expression
  default = false
- width number
  Relative width, 0 is no border and 1 make the border fill the entire button
  default = 0
- radius number
  Relative border radius, 0 is no rounding and 1 will make the short side a half circle
  default = 0
- useColorExpression boolean
  Set to true to use color expression
  default = false
- color PaletteColor
  Color defined by index or hex code, needed if useColorExpression is false
- colorExpression string
  Color defined by expression, needed if useColorExpression is true
icon Icon
Styling for icon
Show icon properties
- useIcon boolean
  Set to true to show icon, default is false
  default = false
- iconType object
  holds the name of the icon
  
  Show iconType properties
  
  value string
  name of icon
  default = ""
- position 'left' | 'right'
  Defines which side of the label the icon will be
  default = "left"

Properties

fontFamily string
Font Family of the label
default = "Source Sans Pro"
useColorExpression boolean
Set to true to use color expression
default = false
color PaletteColor
Color defined by index or hex code, needed if useColorExpression is false
Show color properties
- color string
  Color as hex string (only used if index: -1)
- index number
  Index in palette
colorExpression ColorExpression
Color defined by expression, needed if useColorExpression is true
Show colorExpression properties
- qStringExpression object
  Required
  
  Show qStringExpression properties
  
  qExpr string
  Required
  expression that resolves to a supported color format
size number
Relative[] size of label, must be greater than 0 and 1 fills the entire button
default = 0.5
sizeFixed number
Fixed size of the label in pixels. Must be bigger than 5. Only active when sizeBehavior is fixed.
default = 20
align 'left' | 'center' | 'right'
Horizontal alignment
default = "center"
style object
Additional style options
Show style properties
- bold boolean
  Bold text
  default = true
- italic boolean
  Italic text
  default = false
- underline boolean
  Underlined text
  default = false
sizeBehavior 'responsive' | 'relative' | 'fixed'
Setting to determine how the fontsize of the label is calculated.
default = "responsive"

Properties

useColorExpression boolean
Set to true to use color expression
default = false
color PaletteColor
Color defined by index or hex code, needed if useColorExpression is false
Show color properties
- color string
  Color as hex string (only used if index: -1)
- index number
  Index in palette
colorExpression ColorExpression
Color defined by expression, needed if useColorExpression is true
Show colorExpression properties
- qStringExpression object
  Required
  
  Show qStringExpression properties
  
  qExpr string
  Required
  expression that resolves to a supported color format
mode 'none' | 'media'
Toggles the background image, set to media to show the image
default = "none"
useImage boolean
Set to true to show background image
default = false
url object
Contains the URL for the background image
Show url properties
- qStaticContentUrlDef object
  
  Show qStaticContentUrlDef properties
  
  qUrl string
  URL represented as a string
position 'topLeft' | 'centerLeft' | 'bottomLeft' | 'topCenter' | 'centerCenter' | 'bottomCenter' | 'topRight' | 'centerRight' | 'bottomRight' | 'top-left' | 'center-left' | 'bottom-left' | 'top-center' | 'center-center' | 'top-right' | 'center-right' | 'bottom-right'
Image position
default = "center-center"
size 'auto' | 'alwaysFit' | 'fitWidth' | 'fitHeight' | 'fill' | 'alwaysFill' | 'stretchFit'
Size of the image, relative to the button
default = "auto"

Properties

useBorder boolean
Set to true to use border expression
default = false
width number
Relative width, 0 is no border and 1 make the border fill the entire button
default = 0
radius number
Relative border radius, 0 is no rounding and 1 will make the short side a half circle
default = 0
useColorExpression boolean
Set to true to use color expression
default = false
color PaletteColor
Color defined by index or hex code, needed if useColorExpression is false
Show color properties
- color string
  Color as hex string (only used if index: -1)
- index number
  Index in palette
colorExpression string
Color defined by expression, needed if useColorExpression is true

Icons are only available inside Qlik Sense

Properties

useIcon boolean
Set to true to show icon, default is false
default = false
iconType object
holds the name of the icon
Show iconType properties
- value string
  name of icon
  default = ""
position 'left' | 'right'
Defines which side of the label the icon will be
default = "left"

Color information structure. Holds the actual color and index in palette.

Properties

color string
Color as hex string (only used if index: -1)
index number
Index in palette

Format for using color expressions

Properties

qStringExpression object
Required
Show qStringExpression properties
- qExpr string
  Required
  expression that resolves to a supported color format

Format for setting if the button is enabled/disabled with an expression

Properties

qStringExpression object
Required
Show qStringExpression properties
- qExpr string
  Required
  expression that resolves to a number

Nebula Button

properties object

Properties

Action object

Properties

NavigationAction object

Properties

Style object

Properties

Font object

Properties

Background object

Properties

Border object

Properties

Icon object

Properties

PaletteColor object

Properties

ColorExpression object

Properties

EnabledExpression object

Properties