@nebula.js/sn-action-button:properties

v1.19.0

Action button generic object definition

properties

object
extendsqae.GenericObjectProperties

Properties

actions

List of actions, performed in this order

enabledCondition
default=1

Number or expression evaluating to number, 0 means disabling the button

footnote
optional, default=''
string

Visualization footnote

navigation

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.

showTitles
optional, default=true
boolean

Show title for the visualization

style

Holds styling options

subtitle
optional, default=''
string

Visualization subtitle

title
optional, default=''
string

Visualization title

useEnabledCondition
default=false
boolean

Controlling if the button should use an expression to determine if it is enabled or not

version
string

Current version of this generic object definition.

Action

object

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

Properties

actionLabel
optional, default=''
string

Label for reference

actionType
optional, default=''
'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

bookmark
optional, default=''
string

ID of bookmark, required for type 'applyBookmark'

field
optional, default=''
string

Name of field. Required for types 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible', 'toggleSelect', 'lockField' and 'unlockField'

softLock
optional, default=''
string

Set to true to ignore locked field(s). Required for types 'clearAll', 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible' and 'toggleSelect'

value
optional, default=''
string

To select certain values in a field or set a variable. Required for types 'selectValues', 'selectMatchingValues', 'toggleSelect' and 'setVariable'

variable
optional, default=''
string

Name of variable. Required for type 'setVariable'

partial
optional, default=false
boolean

Set to true if you want to do a partial reload.

automation
optional, default=''
string

ID of the automation. Required for type 'setVariable'

automationPostData
optional, default=false
boolean

Set to true to include the current selections in the automation. Defaults to false

Background

object

Properties

useColorExpression
optional, default=false
boolean

Set to true to use color expression

color
optional

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

colorExpression

Format for using color expressions

useImage
optional, default=false
boolean

Set to true to show background image

url
optional

Contains the URL for the background image

position
optional, default='centerCenter'
'topLeft' | 'centerLeft' | 'bottomLeft' | 'topCenter' | 'centerCenter' | 'bottomCenter' | 'topRight' | 'centerRight' | 'bottomRight'

Image position

size
optional, default='auto'
'auto' | 'alwaysFit' | 'fitWidth' | 'fitWidth' | 'fitHeight' | 'fill' | 'alwaysFill'

Size of the image, relative to the button

Border

object

Properties

useBorder
optional, default=false
boolean

Set to true to use border expression

width
optional, default=0
number

Relative width, 0 is no border and 1 make the border fill the entire button

radius
optional, default=0
number

Relative border radius, 0 is no rounding and 1 will make the short side a half circle

useColorExpression
optional, default=false
boolean

Set to true to use color expression

color
optional

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

colorExpression
optional
string

Color defined by expression, needed if useColorExpression is true

ColorExpression

object

Format for using color expressions

Properties

qStringExpression

No description

EnabledExpression

object

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

Properties

qStringExpression

No description

Font

object

Properties

useColorExpression
optional, default=false
boolean

Set to true to use color expression

color
optional

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

colorExpression

Format for using color expressions

size
optional, default=0.5
number

Relative[] size of label, must be greater than 0 and 1 fills the entire button

align
optional, default='center'
'left' | 'center' | 'right'

Horizontal alignment

style
optional

Additional style options

Icon

object

Icons are only available inside Qlik Sense

Properties

useIcon
optional, default=false
boolean

Set to true to show icon, default is false

iconType
optional

holds the name of the icon

position
optional, default='left'
'left' | 'right'

Defines which side of the label the icon will be

NavigationAction

object

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'

Name of navigation action

appId
optional
string

app ID. Required for 'openChainedApp'

sheet
optional
string

sheet ID. Required for 'goToSheet' and 'goToSheetById'

story
optional
string

Story ID. Required for 'goToStory'

websiteUrl
optional
string

URL for website. required for 'openWebsite'

sameWindow
optional
boolean

Set to true to open in same window/tab. Required for 'openWebsite'

odagLink
optional
string

ODAG link name. Required for 'odagLink'

PaletteColor

object

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

Properties

color
optional
string

Color as hex string (only used if index: -1)

index
optional
number

Index in palette

Style

object

Holds styling options

Properties

label
optional, default='Button'
string

The text displayed on the button

font
optional

Styling for the label

background
optional

Styling for background, including image

border
optional

Styling for border

icon
optional

Icons are only available inside Qlik Sense

Was this page helpful?