@nebula.js/sn-bar-chart:properties
Bar chart generic object definition
properties
namespaceProperties
barGrouping experimental | Bar grouping. |
color experimental | Color settings.
Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting |
components experimental | Styling of chart components. |
dataPoint experimental | Data point settings. |
dimensionAxis experimental | Dimension axis settings. |
footnote experimental optional string | StringExpression | Visualization footnote. |
gridLine experimental | Grid lines settings. |
legend experimental | Legend settings. |
measureAxis experimental | Measure axis settings. |
orientation experimental 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 experimental 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 experimental | Extends |
refLine experimental | Reference lines settings |
scrollbar experimental default='miniChart' 'bar' | 'miniChart' | 'none' | Sets the style of the scroll bar |
scrollStartPos experimental default=0 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 experimental optional, default=false boolean | Show visualization details toggle |
showDisclaimer experimental default=true boolean | Show visualization disclaimer toggle |
showMiniChartForContinuousAxis experimental default=true boolean | Chart axis setting to turn on/off the mini chart for continuous axis. |
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. |
tooltip experimental | Custom tooltip properties |
version experimental string | Current version of this generic object definition |
Accumulation
objectIt allows you to accumulate values of your measure over one or two dimensions.
Properties
type experimental string | This should be set to |
accumulationDimension: experimental 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 experimental optional boolean | Only applicable when there are two dimensions. Continues accumulation across both dimensions. |
fullAccumulation experimental boolean | Select whether the accumulation will happen on the Full range or Custom range. |
steps experimental optional number | Only applicable when |
showExcludedValues experimental boolean | Shows the excluded values (values not in the current selection) in the accumulation. |
disabled experimental optional boolean | No description |
AttributeDimensionProperties
objectExtends NxAttrDimDef
, see Engine API: NxAttrDimDef
.
Properties
id experimental string | One of: |
AttributeExpressionProperties
Bar
objectProperties
key experimental string | This should be set to |
style experimental | No description |
BarStyling
objectProperties
strokeColor experimental | Color information structure. Holds the actual color and index in palette. |
strokeWidth experimental default='none' 'none' | 'small' | 'medium' | 'large' | Set to specify stroke width. |
width experimental number | A number greater than 0 and less than or equal to 1. |
byDimDef
objectSettings when coloring by dimension ("mode": "byDimension"
)
Properties
key experimental string | libraryId if |
label experimental string | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
type experimental 'expression' | 'libraryItem' | No description |
byMeasureDef
objectSettings when coloring by measure ("mode": "byMeasure"
)
Properties
key experimental string | libraryId if |
label experimental string | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
type experimental 'expression' | 'libraryItem' | No description |
ColorAttributes
objectExtends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
id experimental string | One of: |
Component
BarProperties
key experimental string | This should be set to |
style experimental | No description |
CustomTooltipAttributes
objectExtends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
id experimental 'customTooltipTitle' | 'customTooltipDescription' | 'customTooltipExpression' | 'customTooltipImages' | Indicates how the attribute expression will be interpreted by the chart.
|
```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
objectProperties
type experimental string | This should be set to |
accumulationDimension: experimental 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 experimental optional boolean | Only applicable when there are two dimensions. Continues the difference across both dimensions. |
showExcludedValues experimental boolean | Shows the excluded values (values not in the current selection) in the difference. |
disabled experimental optional boolean | No description |
DimensionProperties
objectExtends NxDimension
, see Engine API: NxDimension
.
Properties
qAttributeDimensions experimental | No description |
qDef experimental | Extends |
dimRefLine
objectProperties
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, default=false boolean | Set to true to fill the label and/or value of this reference line with this color |
align experimental optional, default='center' 'start' | 'center' | 'end' | Set alignment for this reference line |
refLineExpr experimental | No description |
ImageComponent
objectImage component information structure.
Properties
type experimental string | Input type as 'url' or 'media library' |
size experimental string | Size as 'small','medium','large' or 'original' |
cId experimental string | Identifier of the image component - used as a link with an attribute expression |
ref experimental string | StringExpression | MediaLibraryRef | The reference value of the image |
InlineDimensionDef
objectExtends NxInlineDimensionDef
, see Engine API: NxInlineDimensionDef
.
Properties
autoSort experimental optional boolean | Set to automatically sort the dimension. |
cId experimental optional string | ID used by the Qlik Sense. Must be unique within the current chart. |
othersLabel experimental string | StringExpression | No description |
InlineMeasureDef
objectExtends NxInlineMeasureDef
, see Engine API: NxInlineMeasureDef
.
Properties
autoSort experimental optional boolean | Set to automatically sort the measure. |
cId experimental 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 experimental boolean | Set to true to toggle off the default client formatting. |
numFormatFromTemplate experimental 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 experimental string | StringExpression | No description |
MeasureProperties
objectExtends NxMeasure
, see Engine API: NxMeasure
.
Properties
qAttributeExpressions experimental Array<ColorAttributes | CustomTooltipAttributes> | No description |
qDef experimental | Extends |
MediaLibraryRef
objectMedia Library Reference structure.
Properties
qStaticContentUrlDef experimental object | Media library structure |
Modifier
MovingAverage
objectProperties
type experimental string | This should be set to |
accumulationDimension: experimental 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 experimental optional boolean | Only applicable when there are two dimensions. Continues the moving average across both dimensions. |
fullRange experimental boolean | Select whether the moving average will happen on the Full range or Custom range. |
steps experimental optional number | Only applicable when |
nullSuppression experimental boolean | Choose to have null values calculated by the moving average modifier. |
showExcludedValues experimental boolean | Shows the excluded values (values not in the current selection) in the moving average. |
disabled experimental optional boolean | No description |
paletteColor
objectColor 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 |
qStaticContentUrlDef
objectMedia Library structure that will be evaluated by the engine.
Properties
qUrl experimental string | Value of media library image |
refLine
objectProperties
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, default=false boolean | Set to true to fill the label and/or value of this reference line with this color |
refLineExpr experimental | No description |
refLineStyle
objectStyling 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. |