@nebula.js/sn-bar-chart:properties

v1.12.0

Bar chart generic object definition

properties

namespace

Properties

barGrouping

Bar grouping.

color

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.

components

Styling of chart components.

dataPoint

Data point settings.

dimensionAxis

Dimension axis settings.

footnote
optional
string | StringExpression

Visualization footnote.

gridLine

Grid lines settings.

legend

Legend settings.

measureAxis

Measure axis settings.

orientation
default='vertical'
'vertical' | 'horizontal'

Orientation setting. If vertical, the dimension axis can only be docked on bottom or top and measure axis on left or right.

preferContinuousAxis
default=true
boolean

Chart axis setting to control preference of scale on a dimensional axis. If true, the scale along the dimensional axis will be continuous if the data supports it, discrete otherwise.

qHyperCubeDef

Extends HyperCubeDef, see Engine API: HyperCubeDef.

refLine

Reference lines settings

scrollbar
default='miniChart'
'bar' | 'miniChart' | 'none'

Sets the style of the scroll bar

scrollStartPos
number

Scroll Alignment. If 0, then the scrollbar will start at the left/top of the chart, if 1 it starts at the right/bottom of the chart. Generally decides if the scroll starts at the beginning or end of the data

showDetails
optional
boolean

Show visualization details toggle

showDisclaimer
default=true
boolean

Show visualization disclaimer toggle

showMiniChartForContinuousAxis
default=true
boolean

Chart axis setting to turn on/off the mini chart for continuous axis.

showTitles
optional, default=true
boolean

Show title for the visualization

subtitle
optional
string | StringExpression

Visualization subtitle.

title
optional
string | StringExpression

Visualization title.

tooltip

Custom tooltip properties

version
string

Current version of this generic object definition

Accumulation

object

It allows you to accumulate values of your measure over one or two dimensions.

Properties

type
string

This should be set to "accumulation".

accumulationDimension:
optional
number

Only applicable when there are two dimensions. Selects the dimension on which the accumulation will take place. If the accumulation is made across multiple dimensions, this will be the first dimension.

crossAllDimensions
optional
boolean

Only applicable when there are two dimensions. Continues accumulation across both dimensions.

fullAccumulation
boolean

Select whether the accumulation will happen on the Full range or Custom range.

steps
optional
number

Only applicable when fullAccumulation is set to false. The number of steps in the dimensions which form an accumulation range. Only zero and positive integers are accepted. Note: Sorting order of dimension values (or step order) is important and affects results.

showExcludedValues
boolean

Shows the excluded values (values not in the current selection) in the accumulation.

disabled
optional
boolean

No description

AttributeDimensionProperties

object
extendsNxAttrDimDef

Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

Properties

id
string

One of: colorByAlternative: colors the chart using different dimensions (can be used together with color.mode="byDimension") or colorByExpression together with color.mode="byExpression".

AttributeExpressionProperties

Bar

object

Properties

key
string

This should be set to "bar" (Determines which component the settings apply to).

style

No description

BarStyling

object

Properties

strokeColor

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

strokeWidth
default='none'
'none' | 'small' | 'medium' | 'large'

Set to specify stroke width.

width
number

A number greater than 0 and less than or equal to 1.

byDimDef

object

Settings when coloring by dimension ("mode": "byDimension")

Properties

key
string

libraryId if "type": "libraryItem", dimension expression if "type": "expression"

label
string

Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.

type
'expression' | 'libraryItem'

No description

byMeasureDef

object

Settings when coloring by measure ("mode": "byMeasure")

Properties

key
string

libraryId if "type": "libraryItem", measure expression if "type": "expression"

label
string

Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.

type
'expression' | 'libraryItem'

No description

ColorAttributes

object
extendsNxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id
string

One of: colorByAlternative: colors the chart using different dimensions (can be used together with color.mode="byDimension") or colorByExpression together with color.mode="byExpression".

Component

Bar

Properties

key
string

This should be set to "bar" (Determines which component the settings apply to).

style

No description

CustomTooltipAttributes

object
extendsNxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id
'customTooltipTitle' | 'customTooltipDescription' | 'customTooltipExpression' | 'customTooltipImages'

Indicates how the attribute expression will be interpreted by the chart. customTooltipTitle: additional title displayed on the custom tooltip customTooltipDescription: description displayed on the custom tooltip customTooltipExpression: measures displayed on the custom tooltip

```json
"qAttributeExpressions": [{
  "qExpression": "",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "U",
     "qnDec": 10,
     "qUseThou": 0,
     "qFmt": "",
     "qDec": "",
     "qThou": "",
   }
  "qLabel": "custom title",
  "qLabelExpression": "",
  "id": "customTooltipTitle"
},
{
  "qExpression": "avg(population)",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "U",
     "qnDec": 10,
     "qUseThou": 0,
     "qFmt": "",
     "qDec": "",
     "qThou": "",
   }
  "qLabel": "",
  "qLabelExpression": "",
  "id": "customTooltipDescription"
},
{
  "qExpression": "",
  "qLibraryId": "zpDNMcg",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "U",
     "qnDec": 10,
     "qUseThou": 0,
     "qFmt": "",
     "qDec": "",
     "qThou": "",
   }
  "qLabel": "",
  "qLabelExpression": "",
  "id": "customTooltipExpression"
},
{
  "qExpression": "sum(population)",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": {
     "qType": "M",
     "qnDec": 2,
     "qUseThou": 0,
     "qFmt": "$#,##0.00;-$#,##0.00",
     "qDec": ".",
     "qThou": ",",
   }
  "qLabel": "",
  "qLabelExpression": "=avg(population)",
  "id": "customTooltipExpression"
},
{
  "qExpression": "'https://my_url/'+sum(population)",
  "qLibraryId": "",
  "qAttribute": true,
  "qNumFormat": null,
  "qLabel": "",
  "qLabelExpression": "",
  "cId": "generatedUniqueId",
  "id": "customTooltipImages"
}]
```

Difference

object

Properties

type
string

This should be set to "difference".

accumulationDimension:
optional
number

Only applicable when there are two dimensions. Selects the dimension on which the difference will take place. If the difference is made across multiple dimensions, this will be the first dimension.

crossAllDimensions
optional
boolean

Only applicable when there are two dimensions. Continues the difference across both dimensions.

showExcludedValues
boolean

Shows the excluded values (values not in the current selection) in the difference.

disabled
optional
boolean

No description

DimensionProperties

object
extendsNxDimension

Extends NxDimension, see Engine API: NxDimension.

Properties

qAttributeDimensions

No description

qDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

dimRefLine

object

Properties

show
default=true
boolean | ValueExpression

Set to true to display this reference line.

label
string

Reference line label.

showLabel
optional, default=true
boolean

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

showValue
optional, default=true
boolean

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

paletteColor

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

style
optional

Styling settings for reference line

coloredBackground
optional
boolean

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

align
optional, default='center'
'start' | 'center' | 'end'

Set alignment for this reference line

refLineExpr

No description

ImageComponent

object

Image component information structure.

Properties

type
string

Input type as 'url' or 'media library'

size
string

Size as 'small','medium','large' or 'original'

cId
string

Identifier of the image component - used as a link with an attribute expression

ref
string | StringExpression | MediaLibraryRef

The reference value of the image

InlineDimensionDef

object
extendsNxInlineDimensionDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Properties

autoSort
optional
boolean

Set to automatically sort the dimension.

cId
optional
string

ID used by the Qlik Sense. Must be unique within the current chart.

othersLabel
string | StringExpression

No description

InlineMeasureDef

object
extendsNxInlineMeasureDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

autoSort
optional
boolean

Set to automatically sort the measure.

cId
optional
string

ID used by the Qlik Sense. Must be unique within the current chart.

modifiers

Set to apply a modifier to a measure.

isCustomFormatted
boolean

Set to true to toggle off the default client formatting.

numFormatFromTemplate
default=true
boolean

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

othersLabel
string | StringExpression

No description

MasterVisualizationChart

object

Chart component information structure.

Properties

style

Chart component information structure.

object

Chart component information structure.

MasterVisualizationChartObject

object

Chart component information structure.

Properties

refId
string

Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization

MasterVisualizationChartStyle

object

Chart component information structure.

Properties

size
string

Input type as 'small' or 'medium' or 'large'

MeasureProperties

object
extendsNxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

qAttributeExpressions

No description

qDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

MediaLibraryRef

object

Media Library Reference structure.

Properties

qStaticContentUrlDef
object

Media library structure

Modifier

MovingAverage

object

Properties

type
string

This should be set to "movingAverage".

accumulationDimension:
optional
number

Only applicable when there are two dimensions. Selects the dimension on which the moving average will take place. If the moving average is made across multiple dimensions, this will be the first dimension.

crossAllDimensions
optional
boolean

Only applicable when there are two dimensions. Continues the moving average across both dimensions.

fullRange
boolean

Select whether the moving average will happen on the Full range or Custom range.

steps
optional
number

Only applicable when fullRange is set to false. The number of steps in the dimension which form a moving average. Only zero and positive integers are accepted. Note: Sorting order of dimension values (or step order) is important and affects results.

nullSuppression
boolean

Choose to have null values calculated by the moving average modifier.

showExcludedValues
boolean

Shows the excluded values (values not in the current selection) in the moving average.

disabled
optional
boolean

No description

paletteColor

object

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

Properties

color
string

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

index
number

Index in palette

qStaticContentUrlDef

object

Media Library structure that will be evaluated by the engine.

Properties

qUrl
string

Value of media library image

refLine

object

Properties

show
default=true
boolean | ValueExpression

Set to true to display this reference line.

label
string

Reference line label.

showLabel
optional, default=true
boolean

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

showValue
optional, default=true
boolean

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

paletteColor

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

style
optional

Styling settings for reference line

coloredBackground
optional
boolean

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

refLineExpr

No description

refLineStyle

object

Styling settings for reference line

Properties

lineThickness
optional, default=2
number

Set the thickness for this reference line.

lineType
optional, default=''
string

Set the dash type for this reference line.

Was this page helpful?