@nebula.js/sn-waterfall:properties

v0.25.10
experimental

Waterfall chart generic object definition

properties

namespace
experimental

Properties

color
experimental

Color settings. Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting "auto": false which turns off auto-coloring. If "auto": true, no other properties need to be defined in the color object. Note: Some of the color properties are depending on which theme is currently being used.

dataPoint
experimental

Data point.

dimensionAxis
experimental

Dimension axis settings.

footnote
experimental
optional
string | StringExpression

Visualization footnote.

gridlines
experimental

Grid lines settings.

legend
experimental

Legend settings.

measureAxis
experimental

Measure axis settings.

qHyperCubeDef
experimental

Extends HyperCubeDef, see Engine API: HyperCubeDef.

refLine
experimental

Reference lines settings

showTitles
experimental
optional, default=true
boolean

Show title for the visualization.

subtitle
experimental
optional
string | StringExpression

Visualization subtitle.

title
experimental
optional
string | StringExpression

Visualization title.

version
experimental
string

Current version of this generic object definition.

FieldAttributes

object
experimental

Field attributes structure.

Properties

dec
experimental
string

Defines the decimal separator.

Fmt
experimental
string

Defines the format pattern that applies to qText.

nDec
experimental
number

Number of decimals.

Thou
experimental
string

Defines the thousand separator (if any).

Type
experimental
string

Type of the field.

UseThou
experimental
number

Defines whether or not a thousands separator must be used.

InlineMeasureDef

object
extendsNxInlineMeasureDef
experimental

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

subtotal
experimental

Settings for subtotal

valueType
experimental
default='NORMAL'
'NORMAL' | 'INVERSE' | 'SUBTOTAL'

Measure operation.

MeasureProperties

object
extendsNxMeasure
experimental

Extends NxMeasure, see Engine API: NxMeasure.

Properties

qDef
experimental

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

paletteColor

object
experimental

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

Properties

color
experimental
string

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

index
experimental
number

Index in palette

properties.qDef.isCustomFormatted

boolean
experimental

If true, the client formatting will be toggled off.

properties.qDef.numFormatFromTemplate

boolean
experimental

When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).

properties.qDef.qNumFormat

FieldAttributes
experimental

Field attributes structure.

Properties

dec
experimental
string

Defines the decimal separator.

Fmt
experimental
string

Defines the format pattern that applies to qText.

nDec
experimental
number

Number of decimals.

Thou
experimental
string

Defines the thousand separator (if any).

Type
experimental
string

Type of the field.

UseThou
experimental
number

Defines whether or not a thousands separator must be used.

refLine

object
experimental

Properties

show
experimental
default=true
boolean | ValueExpression

Set to true to display this reference line.

label
experimental
string

Reference line label.

showLabel
experimental
optional, default=true
boolean

Set to true to show the label of this reference line.

showValue
experimental
optional, default=true
boolean

Set to true to show the value of this reference line.

paletteColor
experimental

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

style
experimental
optional

Styling settings for reference line

coloredBackground
experimental
optional
boolean

Set to true to fill the label and/or value of this reference line with this color

refLineStyle

object
experimental

Styling settings for reference line

Properties

lineThickness
experimental
optional, default=2
number

Set the thickness for this reference line.

lineType
experimental
optional, default=''
string

Set the dash type for this reference line.

subtotalProperties

object
experimental

Settings for subtotal

Properties

enable
experimental
boolean

Option to add a subtotal after a measure.

label
experimental
default='Subtotal'
string

Label of the subtotal added after a measure.

Was this page helpful?