@nebula.js/sn-bar-chart 1.28.0 → 1.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/api-specifications/api.md +7 -474
  2. package/api-specifications/plugins.json +29 -15
  3. package/api-specifications/properties.json +250 -281
  4. package/core/esm/index.js +5 -5
  5. package/dist/sn-bar-chart.js +13 -13
  6. package/dist/sn-bar-chart.systemjs.js +6 -6
  7. package/package.json +1 -1
  8. package/sn-bar-chart-ext/dist/sn-bar-chart.js +13 -13
  9. package/sn-bar-chart-ext/sn-bar-chart.qext +1 -1
package/api-specifications/api.md CHANGED
@@ -26,8 +26,8 @@
26
26
  - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
27
27
  - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
28
28
  - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
29
- - [.useMeasureGradient](#properties.color.useMeasureGradient)
30
- - [.components](#properties.components) : [<code>Array.&lt;Component&gt;</code>](#Component)
29
+ - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
30
+ - [.components](#properties.components) : [<code>Array.&lt;Bar&gt;</code>](#Bar)
31
31
  - [.dataPoint](#properties.dataPoint) : <code>object</code>
32
32
  - [.showLabels](#properties.dataPoint.showLabels) : <code>boolean</code>
33
33
  - [.showSegmentLabels](#properties.dataPoint.showSegmentLabels) : <code>boolean</code>
@@ -138,7 +138,7 @@ Note: Some of the color properties are depending on which theme is currently bei
138
138
  - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
139
139
  - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
140
140
  - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
141
- - [.useMeasureGradient](#properties.color.useMeasureGradient)
141
+ - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
142
142
 
143
143
  <a name="properties.color.auto"></a>
144
144
 
@@ -354,7 +354,7 @@ Only applicable if `'colorMode': 'byDimension'`.
354
354
  **Default**: <code>true</code>
355
355
  <a name="properties.color.useMeasureGradient"></a>
356
356
 
357
- #### color.useMeasureGradient
357
+ #### color.useMeasureGradient : <code>boolean</code>
358
358
 
359
359
  Set to true if you want to apply the colors defined for library measures when used. Only applicable if `"mode": "byMeasure"`.
360
360
 
@@ -362,7 +362,7 @@ Set to true if you want to apply the colors defined for library measures when us
362
362
  **Default**: <code>true</code>
363
363
  <a name="properties.components"></a>
364
364
 
365
- ### properties.components : [<code>Array.&lt;Component&gt;</code>](#Component)
365
+ ### properties.components : [<code>Array.&lt;Bar&gt;</code>](#Bar)
366
366
 
367
367
  Styling of chart components.
368
368
 
@@ -724,7 +724,7 @@ starts at the beginning or end of the data
724
724
  Show visualization details toggle
725
725
 
726
726
  **Kind**: static property of [<code>properties</code>](#properties)
727
- **Default**: <code>false</code>
727
+ **Default**: <code>true</code>
728
728
  <a name="properties.showDisclaimer"></a>
729
729
 
730
730
  ### properties.showDisclaimer : <code>boolean</code>
@@ -832,480 +832,13 @@ The imageComponents objects are used to define the images displayed by the custo
832
832
 
833
833
  # Definitions
834
834
 
835
- <a name="paletteColor"></a>
836
-
837
- ## paletteColor : <code>object</code>
838
-
839
- Color information structure. Holds the actual color and index in palette.
840
-
841
- **Kind**: global typedef
842
- **Properties**
843
-
844
- | Name | Type | Description |
845
- | ----- | ------------------- | -------------------------------------------- |
846
- | color | <code>string</code> | Color as hex string (mandatory if index: -1) |
847
- | index | <code>number</code> | Index in palette |
848
-
849
- <a name="refLineStyle"></a>
850
-
851
- ## refLineStyle : <code>object</code>
852
-
853
- Styling settings for reference line
854
-
855
- **Kind**: global typedef
856
- **Properties**
857
-
858
- | Name | Type | Default | Description |
859
- | --------------- | ------------------- | ------------------------------------- | ------------------------------------------ |
860
- | [lineThickness] | <code>number</code> | <code>2</code> | Set the thickness for this reference line. |
861
- | [lineType] | <code>string</code> | <code>&quot;&#x27;&#x27;&quot;</code> | Set the dash type for this reference line. |
862
-
863
- <a name="refLine"></a>
864
-
865
- ## refLine : <code>object</code>
866
-
867
- **Kind**: global typedef
868
- **Properties**
869
-
870
- | Name | Type | Default | Description |
871
- | ------------------- | ---------------------------------------------------- | ------------------ | --------------------------------------------------------------------------------- |
872
- | show | <code>boolean</code> \| <code>ValueExpression</code> | <code>true</code> | Set to true to display this reference line. |
873
- | label | <code>string</code> | | Reference line label. |
874
- | [showLabel] | <code>boolean</code> | <code>true</code> | Set to true to show the label of this reference line. |
875
- | [showValue] | <code>boolean</code> | <code>true</code> | Set to true to show the value of this reference line. |
876
- | paletteColor | [<code>paletteColor</code>](#paletteColor) | | |
877
- | [style] | [<code>refLineStyle</code>](#refLineStyle) | | Styling settings for reference line |
878
- | [coloredBackground] | <code>boolean</code> | <code>false</code> | Set to true to fill the label and/or value of this reference line with this color |
879
-
880
- <a name="refLine.refLineExpr"></a>
881
-
882
- ### refLine.refLineExpr : <code>object</code>
883
-
884
- **Kind**: static typedef of [<code>refLine</code>](#refLine)
885
- **Properties**
886
-
887
- | Name | Type |
888
- | ------- | ---------------------------------------------------- |
889
- | value | <code>number</code> \| <code>ValueExpression</code> |
890
- | [label] | <code>string</code> \| <code>StringExpression</code> |
891
-
892
- <a name="dimRefLine"></a>
893
-
894
- ## dimRefLine : <code>object</code>
895
-
896
- **Kind**: global typedef
897
- **Properties**
898
-
899
- | Name | Type | Default | Description |
900
- | ------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------- |
901
- | show | <code>boolean</code> \| <code>ValueExpression</code> | <code>true</code> | Set to true to display this reference line. |
902
- | label | <code>string</code> | | Reference line label. |
903
- | [showLabel] | <code>boolean</code> | <code>true</code> | Set to true to show the label of this reference line. |
904
- | [showValue] | <code>boolean</code> | <code>true</code> | Set to true to show the value of this reference line. |
905
- | paletteColor | [<code>paletteColor</code>](#paletteColor) | | |
906
- | [style] | [<code>refLineStyle</code>](#refLineStyle) | | Styling settings for reference line |
907
- | [coloredBackground] | <code>boolean</code> | <code>false</code> | Set to true to fill the label and/or value of this reference line with this color |
908
- | [align] | <code>&#x27;start&#x27;</code> \| <code>&#x27;center&#x27;</code> \| <code>&#x27;end&#x27;</code> | <code>&#x27;center&#x27;</code> | Set alignment for this reference line |
909
-
910
- <a name="dimRefLine.refLineExpr"></a>
911
-
912
- ### dimRefLine.refLineExpr : <code>object</code>
913
-
914
- **Kind**: static typedef of [<code>dimRefLine</code>](#dimRefLine)
915
- **Properties**
916
-
917
- | Name | Type |
918
- | ----------- | ---------------------------------------------------- |
919
- | value | <code>number</code> \| <code>ValueExpression</code> |
920
- | [label] | <code>string</code> \| <code>StringExpression</code> |
921
- | stringValue | <code>string</code> \| <code>StringExpression</code> |
922
-
923
- <a name="Component"></a>
924
-
925
- ## Component : [<code>Bar</code>](#Bar)
926
-
927
- **Kind**: global typedef
928
- <a name="Bar"></a>
929
-
930
- ## Bar : <code>object</code>
931
-
932
- **Kind**: global typedef
933
- **Properties**
934
-
935
- | Name | Type | Description |
936
- | ----- | -------------------------------------- | --------------------------------------------------------------------------------- |
937
- | key | <code>string</code> | This should be set to `"bar"` (Determines which component the settings apply to). |
938
- | style | [<code>BarStyling</code>](#BarStyling) | |
939
-
940
- <a name="BarStyling"></a>
941
-
942
- ## BarStyling : <code>object</code>
943
-
944
- **Kind**: global typedef
945
- **Properties**
946
-
947
- | Name | Type | Default | Description |
948
- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | ---------------------------------------------------- |
949
- | strokeColor | [<code>paletteColor</code>](#paletteColor) | | |
950
- | strokeWidth | <code>&#x27;none&#x27;</code> \| <code>&#x27;small&#x27;</code> \| <code>&#x27;medium&#x27;</code> \| <code>&#x27;large&#x27;</code> | <code>&#x27;none&#x27;</code> | Set to specify stroke width. |
951
- | width | <code>number</code> | | A number greater than 0 and less than or equal to 1. |
952
-
953
- <a name="byDimDef"></a>
954
-
955
- ## byDimDef : <code>object</code>
956
-
957
- Settings when coloring by dimension (`"mode": "byDimension"`)
958
-
959
- **Kind**: global typedef
960
- **Properties**
961
-
962
- | Name | Type | Description |
963
- | ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
964
- | key | <code>string</code> | libraryId if `"type": "libraryItem"`, dimension expression if `"type": "expression"` |
965
- | label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
966
- | type | <code>&#x27;expression&#x27;</code> \| <code>&#x27;libraryItem&#x27;</code> | |
967
-
968
- <a name="byMeasureDef"></a>
969
-
970
- ## byMeasureDef : <code>object</code>
971
-
972
- Settings when coloring by measure (`"mode": "byMeasure"`)
973
-
974
- **Kind**: global typedef
975
- **Properties**
976
-
977
- | Name | Type | Description |
978
- | ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
979
- | key | <code>string</code> | libraryId if `"type": "libraryItem"`, measure expression if `"type": "expression"` |
980
- | label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
981
- | type | <code>&#x27;expression&#x27;</code> \| <code>&#x27;libraryItem&#x27;</code> | |
982
-
983
- <a name="DimensionProperties"></a>
984
-
985
- ## DimensionProperties : <code>object</code>
986
-
987
- Extends `NxDimension`, see Engine API: `NxDimension`.
988
-
989
- **Kind**: global typedef
990
- **Extends**: <code>NxDimension</code>
991
- **Properties**
992
-
993
- | Name | Type |
994
- | -------------------- | ---------------------------------------------------------------------------------------- |
995
- | qAttributeDimensions | [<code>Array.&lt;AttributeDimensionProperties&gt;</code>](#AttributeDimensionProperties) |
996
- | qDef | [<code>InlineDimensionDef</code>](#InlineDimensionDef) |
997
-
998
- <a name="InlineDimensionDef"></a>
999
-
1000
- ## InlineDimensionDef : <code>object</code>
1001
-
1002
- Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.
1003
-
1004
- **Kind**: global typedef
1005
- **Extends**: <code>NxInlineDimensionDef</code>
1006
- **Properties**
1007
-
1008
- | Name | Type | Description |
1009
- | ----------- | ---------------------------------------------------- | ------------------------------------------------------------------- |
1010
- | [autoSort] | <code>boolean</code> | Set to automatically sort the dimension. |
1011
- | [cId] | <code>string</code> | ID used by the Qlik Sense. Must be unique within the current chart. |
1012
- | othersLabel | <code>string</code> \| <code>StringExpression</code> | |
1013
-
1014
- <a name="MeasureProperties"></a>
1015
-
1016
- ## MeasureProperties : <code>object</code>
1017
-
1018
- Extends `NxMeasure`, see Engine API: `NxMeasure`.
1019
-
1020
- **Kind**: global typedef
1021
- **Extends**: <code>NxMeasure</code>
1022
- **Properties**
1023
-
1024
- | Name | Type |
1025
- | --------------------- | ------------------------------------------------------------------------------------------ |
1026
- | qAttributeExpressions | [<code>Array.&lt;AttributeExpressionProperties&gt;</code>](#AttributeExpressionProperties) |
1027
- | qDef | [<code>InlineMeasureDef</code>](#InlineMeasureDef) |
1028
-
1029
- <a name="InlineMeasureDef"></a>
1030
-
1031
- ## InlineMeasureDef : <code>object</code>
1032
-
1033
- Extends `NxInlineMeasureDef`, see Engine API: `NxInlineMeasureDef`.
1034
-
1035
- **Kind**: global typedef
1036
- **Extends**: <code>NxInlineMeasureDef</code>
1037
- **Properties**
1038
-
1039
- | Name | Type | Default | Description |
1040
- | --------------------- | ---------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1041
- | [autoSort] | <code>boolean</code> | | Set to automatically sort the measure. |
1042
- | [cId] | <code>string</code> | | ID used by the Qlik Sense. Must be unique within the current chart. |
1043
- | [modifiers] | [<code>Array.&lt;Modifier&gt;</code>](#Modifier) | | Set to apply a modifier to a measure. |
1044
- | isCustomFormatted | <code>boolean</code> | | Set to true to toggle off the default client formatting. |
1045
- | numFormatFromTemplate | <code>boolean</code> | <code>true</code> | When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date). |
1046
- | othersLabel | <code>string</code> \| <code>StringExpression</code> | | |
1047
-
1048
- <a name="AttributeDimensionProperties"></a>
1049
-
1050
- ## AttributeDimensionProperties : <code>object</code>
1051
-
1052
- Extends `NxAttrDimDef`, see Engine API: `NxAttrDimDef`.
1053
-
1054
- **Kind**: global typedef
1055
- **Extends**: <code>NxAttrDimDef</code>
1056
- **Properties**
1057
-
1058
- | Name | Type | Description |
1059
- | ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1060
- | id | <code>string</code> | One of: `colorByAlternative`: colors the chart using different dimensions (can be used together with color.mode="byDimension") or `colorByExpression` together with color.mode="byExpression". |
1061
-
1062
835
  <a name="AttributeExpressionProperties"></a>
1063
836
 
1064
837
  ## AttributeExpressionProperties : [<code>ColorAttributes</code>](#ColorAttributes) \| [<code>CustomTooltipAttributes</code>](#CustomTooltipAttributes)
1065
838
 
1066
839
  **Kind**: global typedef
1067
- <a name="ColorAttributes"></a>
1068
-
1069
- ## ColorAttributes : <code>object</code>
1070
-
1071
- Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
1072
-
1073
- **Kind**: global typedef
1074
- **Extends**: <code>NxAttrExprDef</code>
1075
- **Properties**
1076
-
1077
- | Name | Type | Description |
1078
- | ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1079
- | id | <code>string</code> | One of: `colorByAlternative`: colors the chart using different dimensions (can be used together with color.mode="byDimension") or `colorByExpression` together with color.mode="byExpression". |
1080
-
1081
- <a name="CustomTooltipAttributes"></a>
1082
-
1083
- ## CustomTooltipAttributes : <code>object</code>
1084
-
1085
- Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
1086
-
1087
- **Kind**: global typedef
1088
- **Extends**: <code>NxAttrExprDef</code>
1089
- **Properties**
1090
-
1091
- | Name | Type | Description |
1092
- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1093
- | id | <code>&#x27;customTooltipTitle&#x27;</code> \| <code>&#x27;customTooltipDescription&#x27;</code> \| <code>&#x27;customTooltipExpression&#x27;</code> \| <code>&#x27;customTooltipImages&#x27;</code> | 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 |
1094
-
1095
- **Example**
1096
-
1097
- ```json
1098
- "qAttributeExpressions": [{
1099
- "qExpression": "",
1100
- "qLibraryId": "",
1101
- "qAttribute": true,
1102
- "qNumFormat": {
1103
- "qType": "U",
1104
- "qnDec": 10,
1105
- "qUseThou": 0,
1106
- "qFmt": "",
1107
- "qDec": "",
1108
- "qThou": "",
1109
- }
1110
- "qLabel": "custom title",
1111
- "qLabelExpression": "",
1112
- "id": "customTooltipTitle"
1113
- },
1114
- {
1115
- "qExpression": "avg(population)",
1116
- "qLibraryId": "",
1117
- "qAttribute": true,
1118
- "qNumFormat": {
1119
- "qType": "U",
1120
- "qnDec": 10,
1121
- "qUseThou": 0,
1122
- "qFmt": "",
1123
- "qDec": "",
1124
- "qThou": "",
1125
- }
1126
- "qLabel": "",
1127
- "qLabelExpression": "",
1128
- "id": "customTooltipDescription"
1129
- },
1130
- {
1131
- "qExpression": "",
1132
- "qLibraryId": "zpDNMcg",
1133
- "qAttribute": true,
1134
- "qNumFormat": {
1135
- "qType": "U",
1136
- "qnDec": 10,
1137
- "qUseThou": 0,
1138
- "qFmt": "",
1139
- "qDec": "",
1140
- "qThou": "",
1141
- }
1142
- "qLabel": "",
1143
- "qLabelExpression": "",
1144
- "id": "customTooltipExpression"
1145
- },
1146
- {
1147
- "qExpression": "sum(population)",
1148
- "qLibraryId": "",
1149
- "qAttribute": true,
1150
- "qNumFormat": {
1151
- "qType": "M",
1152
- "qnDec": 2,
1153
- "qUseThou": 0,
1154
- "qFmt": "$#,##0.00;-$#,##0.00",
1155
- "qDec": ".",
1156
- "qThou": ",",
1157
- }
1158
- "qLabel": "",
1159
- "qLabelExpression": "=avg(population)",
1160
- "id": "customTooltipExpression"
1161
- },
1162
- {
1163
- "qExpression": "'https://my_url/'+sum(population)",
1164
- "qLibraryId": "",
1165
- "qAttribute": true,
1166
- "qNumFormat": null,
1167
- "qLabel": "",
1168
- "qLabelExpression": "",
1169
- "cId": "generatedUniqueId",
1170
- "id": "customTooltipImages"
1171
- }]
1172
- ```
1173
-
1174
840
  <a name="Modifier"></a>
1175
841
 
1176
842
  ## Modifier : [<code>Accumulation</code>](#Accumulation) \| [<code>Difference</code>](#Difference) \| [<code>MovingAverage</code>](#MovingAverage)
1177
843
 
1178
- **Kind**: global typedef
1179
- <a name="Accumulation"></a>
1180
-
1181
- ## Accumulation : <code>object</code>
1182
-
1183
- It allows you to accumulate values of your measure over one or two dimensions.
1184
-
1185
- **Kind**: global typedef
1186
- **Properties**
1187
-
1188
- | Name | Type | Description |
1189
- | ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1190
- | type | <code>string</code> | This should be set to `"accumulation"`. |
1191
- | [accumulationDimension:] | <code>number</code> | 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. |
1192
- | [crossAllDimensions] | <code>boolean</code> | Only applicable when there are two dimensions. Continues accumulation across both dimensions. |
1193
- | fullAccumulation | <code>boolean</code> | Select whether the accumulation will happen on the Full range or Custom range. |
1194
- | [steps] | <code>number</code> | 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. |
1195
- | showExcludedValues | <code>boolean</code> | Shows the excluded values (values not in the current selection) in the accumulation. |
1196
- | [disabled] | <code>boolean</code> | |
1197
-
1198
- <a name="Difference"></a>
1199
-
1200
- ## Difference : <code>object</code>
1201
-
1202
- **Kind**: global typedef
1203
- **Properties**
1204
-
1205
- | Name | Type | Description |
1206
- | ------------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1207
- | type | <code>string</code> | This should be set to `"difference"`. |
1208
- | [accumulationDimension:] | <code>number</code> | 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. |
1209
- | [crossAllDimensions] | <code>boolean</code> | Only applicable when there are two dimensions. Continues the difference across both dimensions. |
1210
- | showExcludedValues | <code>boolean</code> | Shows the excluded values (values not in the current selection) in the difference. |
1211
- | [disabled] | <code>boolean</code> | |
1212
-
1213
- <a name="MovingAverage"></a>
1214
-
1215
- ## MovingAverage : <code>object</code>
1216
-
1217
- **Kind**: global typedef
1218
- **Properties**
1219
-
1220
- | Name | Type | Description |
1221
- | ------------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1222
- | type | <code>string</code> | This should be set to `"movingAverage"`. |
1223
- | [accumulationDimension:] | <code>number</code> | 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. |
1224
- | [crossAllDimensions] | <code>boolean</code> | Only applicable when there are two dimensions. Continues the moving average across both dimensions. |
1225
- | fullRange | <code>boolean</code> | Select whether the moving average will happen on the Full range or Custom range. |
1226
- | [steps] | <code>number</code> | 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. |
1227
- | nullSuppression | <code>boolean</code> | Choose to have null values calculated by the moving average modifier. |
1228
- | showExcludedValues | <code>boolean</code> | Shows the excluded values (values not in the current selection) in the moving average. |
1229
- | [disabled] | <code>boolean</code> | |
1230
-
1231
- <a name="MasterVisualizationChart"></a>
1232
-
1233
- ## MasterVisualizationChart : <code>object</code>
1234
-
1235
- Chart component information structure.
1236
-
1237
- **Kind**: global typedef
1238
- **Properties**
1239
-
1240
- | Name | Type | Description |
1241
- | ------ | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
1242
- | style | [<code>MasterVisualizationChartStyle</code>](#MasterVisualizationChartStyle) | Object containing the styles of the chart such as 'size' |
1243
- | object | [<code>MasterVisualizationChartObject</code>](#MasterVisualizationChartObject) | Object containing the information fo the visualization, such as refId in case of master visualization |
1244
-
1245
- <a name="MasterVisualizationChartStyle"></a>
1246
-
1247
- ## MasterVisualizationChartStyle : <code>object</code>
1248
-
1249
- Chart component information structure.
1250
-
1251
- **Kind**: global typedef
1252
- **Properties**
1253
-
1254
- | Name | Type | Description |
1255
- | ---- | ------------------- | -------------------------------------------- |
1256
- | size | <code>string</code> | Input type as 'small' or 'medium' or 'large' |
1257
-
1258
- <a name="MasterVisualizationChartObject"></a>
1259
-
1260
- ## MasterVisualizationChartObject : <code>object</code>
1261
-
1262
- Chart component information structure.
1263
-
1264
- **Kind**: global typedef
1265
- **Properties**
1266
-
1267
- | Name | Type | Description |
1268
- | ----- | ------------------- | ------------------------------------------------------------------------------------------------------------------------- |
1269
- | refId | <code>string</code> | Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization |
1270
-
1271
- <a name="ImageComponent"></a>
1272
-
1273
- ## ImageComponent : <code>object</code>
1274
-
1275
- Image component information structure.
1276
-
1277
- **Kind**: global typedef
1278
- **Properties**
1279
-
1280
- | Name | Type | Description |
1281
- | ---- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
1282
- | type | <code>string</code> | Input type as 'url' or 'media library' |
1283
- | size | <code>string</code> | Size as 'small','medium','large' or 'original' |
1284
- | cId | <code>string</code> | Identifier of the image component - used as a link with an attribute expression |
1285
- | ref | <code>string</code> \| <code>StringExpression</code> \| [<code>MediaLibraryRef</code>](#MediaLibraryRef) | The reference value of the image |
1286
-
1287
- <a name="MediaLibraryRef"></a>
1288
-
1289
- ## MediaLibraryRef : <code>object</code>
1290
-
1291
- Media Library Reference structure.
1292
-
1293
- **Kind**: global typedef
1294
- **Properties**
1295
-
1296
- | Name | Type | Description |
1297
- | -------------------- | ------------------- | ----------------------- |
1298
- | qStaticContentUrlDef | <code>object</code> | Media library structure |
1299
-
1300
- <a name="qStaticContentUrlDef"></a>
1301
-
1302
- ## qStaticContentUrlDef : <code>object</code>
1303
-
1304
- Media Library structure that will be evaluated by the engine.
1305
-
1306
- **Kind**: global typedef
1307
- **Properties**
1308
-
1309
- | Name | Type | Description |
1310
- | ---- | ------------------- | ---------------------------- |
1311
- | qUrl | <code>string</code> | Value of media library image |
844
+ **Kind**: global typedef
package/api-specifications/plugins.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
- "scriptappy": "1.0.0",
2
+ "scriptappy": "1.1.0",
3
3
  "info": {
4
4
  "name": "@nebula.js/sn-bar-chart:plugins",
5
5
  "description": "Bar chart plugins API definitions",
6
- "version": "1.28.0",
6
+ "version": "1.29.0",
7
7
  "license": "MIT",
8
8
  "stability": "experimental",
9
9
  "x-qlik-visibility": "public"
@@ -15,21 +15,19 @@
15
15
  "entries": {
16
16
  "keys": {
17
17
  "description": "The keys (references) to different types of chart internals",
18
- "kind": "object",
19
18
  "entries": {
20
19
  "COLLECTION": {
21
20
  "description": "The data collections the users can use to get data from",
22
- "kind": "object",
23
21
  "entries": {
24
22
  "MAIN": {
25
23
  "description": "The main data collection",
26
24
  "type": "string"
27
25
  }
28
- }
26
+ },
27
+ "kind": "object"
29
28
  },
30
29
  "COMPONENT": {
31
30
  "description": "The unique keys of the existing components available in the chart.\nThey are useful if you want to extend or override the existing components.",
32
- "kind": "object",
33
31
  "entries": {
34
32
  "BAR": {
35
33
  "description": "The bar component",
@@ -54,15 +52,14 @@
54
52
  "defaultValue": "y-axis",
55
53
  "type": "string"
56
54
  }
57
- }
55
+ },
56
+ "kind": "object"
58
57
  },
59
58
  "SCALE": {
60
59
  "description": "The scales associated with the bar chart\nThey are useful if you want to, via plugin, add a new component that\nuses the same scale as one of the measures.",
61
- "kind": "object",
62
60
  "entries": {
63
61
  "MAIN": {
64
62
  "description": "The main scales",
65
- "kind": "object",
66
63
  "entries": {
67
64
  "MAJOR": {
68
65
  "description": "The main major scale",
@@ -72,19 +69,36 @@
72
69
  "description": "The main minor scale",
73
70
  "type": "string"
74
71
  }
75
- }
72
+ },
73
+ "kind": "object"
76
74
  }
77
- }
75
+ },
76
+ "kind": "object"
78
77
  }
79
- }
78
+ },
79
+ "kind": "object"
80
80
  },
81
81
  "layout": {
82
82
  "description": "The layout from the enigma model.",
83
- "kind": "object",
84
- "entries": {}
83
+ "type": "object"
85
84
  }
86
85
  }
87
86
  }
88
87
  },
89
- "definitions": {}
88
+ "definitions": {
89
+ "getPluginArgs": {
90
+ "description": "Prepare important chart internals for the users to build their own plugins",
91
+ "kind": "function",
92
+ "params": [
93
+ {
94
+ "name": "layoutService",
95
+ "type": "object"
96
+ }
97
+ ],
98
+ "returns": {
99
+ "description": "Chart internals that will be exposed to the users.",
100
+ "type": "#/entries/pluginArguments"
101
+ }
102
+ }
103
+ }
90
104
  }