@nebula.js/sn-combo-chart 1.20.6 → 1.21.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 +4 -491
  2. package/api-specifications/plugins.json +37 -23
  3. package/api-specifications/properties.json +311 -338
  4. package/core/esm/index.js +5 -5
  5. package/dist/sn-combo-chart.js +13 -13
  6. package/dist/sn-combo-chart.systemjs.js +6 -6
  7. package/package.json +1 -1
  8. package/sn-combo-chart-ext/dist/sn-combo-chart.js +13 -13
  9. package/sn-combo-chart-ext/sn-combo-chart.qext +1 -1
package/api-specifications/api.md CHANGED
@@ -27,7 +27,7 @@
27
27
  - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
28
28
  - [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
29
29
  - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
30
- - [.useMeasureGradient](#properties.color.useMeasureGradient)
30
+ - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
31
31
  - [.persistent](#properties.color.persistent) : <code>boolean</code>
32
32
  - [.expressionIsColor](#properties.color.expressionIsColor) : <code>boolean</code>
33
33
  - [.expressionLabel](#properties.color.expressionLabel) : <code>string</code>
@@ -245,7 +245,7 @@ Note: Some of the color properties are depending on which theme is currently bei
245
245
  - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
246
246
  - [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
247
247
  - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
248
- - [.useMeasureGradient](#properties.color.useMeasureGradient)
248
+ - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
249
249
  - [.persistent](#properties.color.persistent) : <code>boolean</code>
250
250
  - [.expressionIsColor](#properties.color.expressionIsColor) : <code>boolean</code>
251
251
  - [.expressionLabel](#properties.color.expressionLabel) : <code>string</code>
@@ -325,7 +325,7 @@ Only applicable if `'colorMode': 'byDimension'`.
325
325
  **Default**: <code>true</code>
326
326
  <a name="properties.color.useMeasureGradient"></a>
327
327
 
328
- #### color.useMeasureGradient
328
+ #### color.useMeasureGradient : <code>boolean</code>
329
329
 
330
330
  Set to true if you want to apply the colors defined for library measures when used. Only applicable if `"mode": "byMeasure"`.
331
331
 
@@ -646,505 +646,18 @@ The imageComponents objects are used to define the images displayed by the custo
646
646
 
647
647
  # Definitions
648
648
 
649
- <a name="measureAxis"></a>
650
-
651
- ## measureAxis : <code>object</code>
652
-
653
- **Kind**: global typedef
654
- **Properties**
655
-
656
- | Name | Type | Default | Description |
657
- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
658
- | [show] | <code>&#x27;all&#x27;</code> \| <code>&#x27;labels&#x27;</code> \| <code>&#x27;title&#x27;</code> \| <code>&#x27;none&#x27;</code> | <code>&quot;all&quot;</code> | Labels and title |
659
- | [dock] | <code>&#x27;near&#x27;</code> \| <code>&#x27;far&#x27;</code> | <code>&quot;near&quot;</code> | Axis docking position |
660
- | [spacing] | <code>number</code> | <code>1</code> | Axis scale |
661
- | [autoMinMax] | <code>boolean</code> | <code>true</code> | Automatic max/min |
662
- | minMax | <code>&#x27;min&#x27;</code> \| <code>&#x27;max&#x27;</code> \| <code>&#x27;minMax&#x27;</code> | | Set custom max/min |
663
- | min | <code>number</code> \| <code>ValueExpression</code> | | Axis min value. `"autoMinMax"` must be set to false and `"minMax"` must be set to `"min"` or `"minMax"` to use this property |
664
- | max | <code>number</code> \| <code>ValueExpression</code> | | Axis max value. `"autoMinMax"` must be set to false and `"minMax"` must be set to `"max"` or `"minMax"` to use this property |
665
-
666
- <a name="DimensionProperties"></a>
667
-
668
- ## DimensionProperties : <code>object</code>
669
-
670
- Extends `NxDimension`, see Engine API: `NxDimension`.
671
-
672
- **Kind**: global typedef
673
- **Extends**: <code>NxDimension</code>
674
- **Properties**
675
-
676
- | Name | Type |
677
- | -------------------- | ---------------------------------------------------------------------------------------- |
678
- | qAttributeDimensions | [<code>Array.&lt;AttributeDimensionProperties&gt;</code>](#AttributeDimensionProperties) |
679
- | qDef | [<code>InlineDimensionDef</code>](#InlineDimensionDef) |
680
-
681
- <a name="AttributeDimensionProperties"></a>
682
-
683
- ## AttributeDimensionProperties : <code>object</code>
684
-
685
- Extends `NxAttrDimDef`, see Engine API: `NxAttrDimDef`.
686
-
687
- **Kind**: global typedef
688
- **Extends**: <code>NxAttrDimDef</code>
689
- **Properties**
690
-
691
- | Name | Type | Description |
692
- | ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
693
- | 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". |
694
-
695
- <a name="InlineDimensionDef"></a>
696
-
697
- ## InlineDimensionDef : <code>object</code>
698
-
699
- Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.
700
-
701
- **Kind**: global typedef
702
- **Extends**: <code>NxInlineDimensionDef</code>
703
- **Properties**
704
-
705
- | Name | Type | Description |
706
- | ----------- | ---------------------------------------------------- | ------------------------------------------------------------------- |
707
- | [autoSort] | <code>boolean</code> | Set to automatically sort the dimension. |
708
- | [cId] | <code>string</code> | ID used by the Qlik Sense. Must be unique within the current chart. |
709
- | othersLabel | <code>string</code> \| <code>StringExpression</code> | |
710
-
711
- <a name="MeasureProperties"></a>
712
-
713
- ## MeasureProperties : <code>object</code>
714
-
715
- Extends `NxMeasure`, see Engine API: `NxMeasure`.
716
-
717
- **Kind**: global typedef
718
- **Extends**: <code>NxMeasure</code>
719
- **Properties**
720
-
721
- | Name | Type |
722
- | --------------------- | ------------------------------------------------------------------------------------------ |
723
- | qAttributeExpressions | [<code>Array.&lt;AttributeExpressionProperties&gt;</code>](#AttributeExpressionProperties) |
724
- | qDef | [<code>InlineMeasureDef</code>](#InlineMeasureDef) |
725
-
726
- <a name="InlineMeasureDef"></a>
727
-
728
- ## InlineMeasureDef : <code>object</code>
729
-
730
- Extends `NxInlineMeasureDef`, see Engine API: `NxInlineMeasureDef`.
731
-
732
- **Kind**: global typedef
733
- **Extends**: <code>NxInlineMeasureDef</code>
734
- **Properties**
735
-
736
- | Name | Type | Default | Description |
737
- | --------------------- | ---------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------- |
738
- | [autoSort] | <code>boolean</code> | | Set to automatically sort the measure. |
739
- | [cId] | <code>string</code> | | ID used by the Qlik Sense. Must be unique within the current chart. |
740
- | [modifiers] | [<code>Array.&lt;Modifier&gt;</code>](#Modifier) | | Set to apply a modifier to a measure. |
741
- | isCustomFormatted | <code>boolean</code> | | Set to true to toggle off the default client formatting. |
742
- | 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). |
743
- | othersLabel | <code>string</code> \| <code>StringExpression</code> | | |
744
- | [series] | [<code>Series</code>](#Series) | | Set to define type of series and series options |
745
- | [color] | [<code>MeasureColor</code>](#MeasureColor) | | Set to define color for this measure |
746
-
747
649
  <a name="AttributeExpressionProperties"></a>
748
650
 
749
651
  ## AttributeExpressionProperties : [<code>ColorAttributes</code>](#ColorAttributes) \| [<code>CustomTooltipAttributes</code>](#CustomTooltipAttributes)
750
652
 
751
653
  **Kind**: global typedef
752
- <a name="ColorAttributes"></a>
753
-
754
- ## ColorAttributes : <code>object</code>
755
-
756
- Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
757
-
758
- **Kind**: global typedef
759
- **Extends**: <code>NxAttrExprDef</code>
760
- **Properties**
761
-
762
- | Name | Type | Description |
763
- | ---- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
764
- | id | <code>string</code> | One of: `colorByAlternative`: colors the chart using different dimensions (can be used together with color.mode="byDimension"), `colorByExpression` together with color.mode="byExpression" or `colorByMeasureExpression` togehter with color.mode="byExpression" on the current measure. |
765
-
766
654
  <a name="Modifier"></a>
767
655
 
768
656
  ## Modifier : [<code>Accumulation</code>](#Accumulation)
769
657
 
770
658
  **Kind**: global typedef
771
- <a name="Accumulation"></a>
772
-
773
- ## Accumulation : <code>object</code>
774
-
775
- It allows you to accumulate values of your measure over one dimension.
776
-
777
- **Kind**: global typedef
778
- **Properties**
779
-
780
- | Name | Type | Description |
781
- | ------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
782
- | type | <code>string</code> | This should be set to `"accumulation"`. |
783
- | fullAccumulation | <code>boolean</code> | Select whether the accumulation will happen on the Full range or Custom range. |
784
- | [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. |
785
- | showExcludedValues | <code>boolean</code> | Shows the excluded values (values not in the current selection) in the accumulation. |
786
- | [disabled] | <code>boolean</code> | |
787
-
788
- <a name="paletteColor"></a>
789
-
790
- ## paletteColor : <code>object</code>
791
-
792
- Color information structure. Holds the actual color and index in palette.
793
-
794
- **Kind**: global typedef
795
- **Properties**
796
-
797
- | Name | Type | Description |
798
- | ----- | ------------------- | -------------------------------------------- |
799
- | color | <code>string</code> | Color as hex string (mandatory if index: -1) |
800
- | index | <code>number</code> | Index in palette |
801
-
802
- <a name="Series"></a>
803
-
804
- ## Series : <code>object</code>
805
-
806
- Series information that defines the type of series and how it is represented.
807
-
808
- **Kind**: global typedef
809
- **Properties**
810
-
811
- | Name | Type | Default | Description |
812
- | ------- | ------------------------------------------------------------------------------------------------ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
813
- | [type] | <code>&#x27;bar&#x27;</code> \| <code>&#x27;line&#x27;</code> \| <code>&#x27;marker&#x27;</code> | <code>&quot;bar&quot;</code> | Set the type of series. Defaults to 'bar' with less than 2 measure, otherwise 'line'. |
814
- | [axis] | <code>0</code> \| <code>1</code> | <code>0</code> | Set which axes the series should be represented on. 0 for primary axis and 1 for secondary axis. Defaults to primary with less than 2 measure, otherwise secondary axis. |
815
- | options | [<code>SeriesMarkerOptions</code>](#SeriesMarkerOptions) | | Set options specific for a series. |
816
-
817
- <a name="SeriesMarkerOptions"></a>
818
-
819
- ## SeriesMarkerOptions : <code>object</code>
820
-
821
- Series options for the Marker type.
822
-
823
- **Kind**: global typedef
824
- **Properties**
825
-
826
- | Name | Type | Default | Description |
827
- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------- |
828
- | [type] | <code>&#x27;circle&#x27;</code> \| <code>&#x27;line&#x27;</code> \| <code>&#x27;diamond&#x27;</code> \| <code>&#x27;triangle&#x27;</code> \| <code>&#x27;rect&#x27;</code> | <code>&quot;circle&quot;</code> | Set the type of marker. |
829
- | [fill] | <code>boolean</code> | <code>true</code> | Set to true if the marker should be filled with a color. If false, only stroke of the marker is rendered. |
830
-
831
- <a name="MeasureColor"></a>
832
-
833
- ## MeasureColor : <code>object</code>
834
-
835
- Series information that defines the type of series and how it is represented.
836
-
837
- **Kind**: global typedef
838
- **Properties**
839
-
840
- | Name | Type | Default | Description |
841
- | ----------------- | ------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
842
- | on | <code>boolean</code> | <code>false</code> | Set if the color settings should be used |
843
- | mode | <code>&#x27;primary&#x27;</code> \| <code>&#x27;byExpression&#x27;</code> | <code>&quot;primary&quot;</code> | Sets the coloring mode for the measure when coloring has been switched on Can be one of: _ `primary`: a single color (by default blue) is used. single color is the default setting. _ `byExpression`: coloring is based on an expression. The expression are set in the `"colorExpression"` property. |
844
- | paletteColor | [<code>paletteColor</code>](#paletteColor) | <code>{</code> | index: 6 } The paletteColor object is used to define the color when you color by single color `("mode": "primary")`. |
845
- | [colorExpression] | <code>string</code> | | Sets the color expression to be used when `"mode": "byExpression"` is defined. Expression is a color code. Supported formats are: `RGB`, `ARGB` and `HSL` |
846
-
847
659
  <a name="Component"></a>
848
660
 
849
661
  ## Component : [<code>Line</code>](#Line) \| [<code>Bar</code>](#Bar)
850
662
 
851
- **Kind**: global typedef
852
- <a name="Bar"></a>
853
-
854
- ## Bar : <code>object</code>
855
-
856
- **Kind**: global typedef
857
- **Properties**
858
-
859
- | Name | Type | Description |
860
- | ----- | -------------------------------------- | --------------------------------------------------------------------------------- |
861
- | key | <code>string</code> | This should be set to `"bar"` (Determines which component the settings apply to). |
862
- | style | [<code>BarStyling</code>](#BarStyling) | |
863
-
864
- <a name="BarStyling"></a>
865
-
866
- ## BarStyling : <code>object</code>
867
-
868
- **Kind**: global typedef
869
- **Properties**
870
-
871
- | Name | Type | Default | Description |
872
- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | ---------------------------------------------------- |
873
- | strokeColor | [<code>paletteColor</code>](#paletteColor) | | |
874
- | 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. |
875
- | width | <code>number</code> | | A number greater than 0 and less than or equal to 1. |
876
-
877
- <a name="Line"></a>
878
-
879
- ## Line : <code>object</code>
880
-
881
- **Kind**: global typedef
882
- **Properties**
883
-
884
- | Name | Type | Description |
885
- | ----- | ---------------------------------------- | ---------------------------------------------------------------------------------- |
886
- | key | <code>string</code> | This should be set to `"line"` (Determines which component the settings apply to). |
887
- | style | [<code>LineStyling</code>](#LineStyling) | |
888
-
889
- <a name="LineStyling"></a>
890
-
891
- ## LineStyling : <code>object</code>
892
-
893
- **Kind**: global typedef
894
- **Properties**
895
-
896
- | Name | Type | Default | Description |
897
- | ------------- | -------------------------------------------------------------------- | ------------------------------- | ------------------------------------------------------ |
898
- | dataPointSize | <code>number</code> | <code>6</code> | Set to specify the size of the data point. |
899
- | lineCurve | <code>&#x27;linear&#x27;</code> \| <code>&#x27;monotone&#x27;</code> | <code>&quot;linear&quot;</code> | |
900
- | lineThickness | <code>number</code> | <code>1</code> | Set to specify line thickness. Can be set from 1 to 5. |
901
- | lineType | <code>&#x27;solid&#x27;</code> \| <code>&#x27;dashed&#x27;</code> | <code>&quot;solid&quot;</code> | |
902
-
903
- <a name="refLineStyle"></a>
904
-
905
- ## refLineStyle : <code>object</code>
906
-
907
- Styling settings for reference line
908
-
909
- **Kind**: global typedef
910
- **Properties**
911
-
912
- | Name | Type | Default | Description |
913
- | --------------- | ------------------- | ------------------------------------- | ------------------------------------------ |
914
- | [lineThickness] | <code>number</code> | <code>2</code> | Set the thickness for this reference line. |
915
- | [lineType] | <code>string</code> | <code>&quot;&#x27;&#x27;&quot;</code> | Set the dash type for this reference line. |
916
-
917
- <a name="refLine"></a>
918
-
919
- ## refLine : <code>object</code>
920
-
921
- **Kind**: global typedef
922
- **Properties**
923
-
924
- | Name | Type | Default | Description |
925
- | ------------------- | ---------------------------------------------------- | ------------------ | --------------------------------------------------------------------------------- |
926
- | show | <code>boolean</code> \| <code>ValueExpression</code> | <code>true</code> | Set to true to display this reference line. |
927
- | label | <code>string</code> | | Reference line label. |
928
- | [showLabel] | <code>boolean</code> | <code>true</code> | Set to true to show the label of this reference line. |
929
- | [showValue] | <code>boolean</code> | <code>true</code> | Set to true to show the value of this reference line. |
930
- | paletteColor | [<code>paletteColor</code>](#paletteColor) | | |
931
- | [style] | [<code>refLineStyle</code>](#refLineStyle) | | Styling settings for reference line |
932
- | [coloredBackground] | <code>boolean</code> | <code>false</code> | Set to true to fill the label and/or value of this reference line with this color |
933
-
934
- <a name="refLine.refLineExpr"></a>
935
-
936
- ### refLine.refLineExpr : <code>object</code>
937
-
938
- **Kind**: static typedef of [<code>refLine</code>](#refLine)
939
- **Properties**
940
-
941
- | Name | Type |
942
- | ------- | ---------------------------------------------------- |
943
- | value | <code>number</code> \| <code>ValueExpression</code> |
944
- | [label] | <code>string</code> \| <code>StringExpression</code> |
945
-
946
- <a name="dimRefLine"></a>
947
-
948
- ## dimRefLine : <code>object</code>
949
-
950
- **Kind**: global typedef
951
- **Properties**
952
-
953
- | Name | Type | Default | Description |
954
- | ------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------- |
955
- | show | <code>boolean</code> \| <code>ValueExpression</code> | <code>true</code> | Set to true to display this reference line. |
956
- | label | <code>string</code> | | Reference line label. |
957
- | [showLabel] | <code>boolean</code> | <code>true</code> | Set to true to show the label of this reference line. |
958
- | [showValue] | <code>boolean</code> | <code>true</code> | Set to true to show the value of this reference line. |
959
- | paletteColor | [<code>paletteColor</code>](#paletteColor) | | |
960
- | [style] | [<code>refLineStyle</code>](#refLineStyle) | | Styling settings for reference line |
961
- | [coloredBackground] | <code>boolean</code> | <code>false</code> | Set to true to fill the label and/or value of this reference line with this color |
962
- | [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 |
963
-
964
- <a name="dimRefLine.refLineExpr"></a>
965
-
966
- ### dimRefLine.refLineExpr : <code>object</code>
967
-
968
- **Kind**: static typedef of [<code>dimRefLine</code>](#dimRefLine)
969
- **Properties**
970
-
971
- | Name | Type |
972
- | ----------- | ---------------------------------------------------- |
973
- | value | <code>number</code> \| <code>ValueExpression</code> |
974
- | [label] | <code>string</code> \| <code>StringExpression</code> |
975
- | stringValue | <code>string</code> \| <code>StringExpression</code> |
976
-
977
- <a name="CustomTooltipAttributes"></a>
978
-
979
- ## CustomTooltipAttributes : <code>object</code>
980
-
981
- Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
982
-
983
- **Kind**: global typedef
984
- **Extends**: <code>NxAttrExprDef</code>
985
- **Properties**
986
-
987
- | Name | Type | Description |
988
- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
989
- | id | <code>&#x27;customTooltipTitle&#x27;</code> \| <code>&#x27;customTooltipDescription&#x27;</code> \| <code>&#x27;customTooltipExpression&#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 |
990
-
991
- **Example**
992
-
993
- ```json
994
- "qAttributeExpressions": [{
995
- "qExpression": "",
996
- "qLibraryId": "",
997
- "qAttribute": true,
998
- "qNumFormat": {
999
- "qType": "U",
1000
- "qnDec": 10,
1001
- "qUseThou": 0,
1002
- "qFmt": "",
1003
- "qDec": "",
1004
- "qThou": "",
1005
- }
1006
- "qLabel": "custom title",
1007
- "qLabelExpression": "",
1008
- "id": "customTooltipTitle"
1009
- },
1010
- {
1011
- "qExpression": "avg(population)",
1012
- "qLibraryId": "",
1013
- "qAttribute": true,
1014
- "qNumFormat": {
1015
- "qType": "U",
1016
- "qnDec": 10,
1017
- "qUseThou": 0,
1018
- "qFmt": "",
1019
- "qDec": "",
1020
- "qThou": "",
1021
- }
1022
- "qLabel": "",
1023
- "qLabelExpression": "",
1024
- "id": "customTooltipDescription"
1025
- },
1026
- {
1027
- "qExpression": "",
1028
- "qLibraryId": "zpDNMcg",
1029
- "qAttribute": true,
1030
- "qNumFormat": {
1031
- "qType": "U",
1032
- "qnDec": 10,
1033
- "qUseThou": 0,
1034
- "qFmt": "",
1035
- "qDec": "",
1036
- "qThou": "",
1037
- }
1038
- "qLabel": "",
1039
- "qLabelExpression": "",
1040
- "id": "customTooltipExpression"
1041
- },
1042
- {
1043
- "qExpression": "sum(population)",
1044
- "qLibraryId": "",
1045
- "qAttribute": true,
1046
- "qNumFormat": {
1047
- "qType": "M",
1048
- "qnDec": 2,
1049
- "qUseThou": 0,
1050
- "qFmt": "$#,##0.00;-$#,##0.00",
1051
- "qDec": ".",
1052
- "qThou": ",",
1053
- }
1054
- "qLabel": "",
1055
- "qLabelExpression": "=avg(population)",
1056
- "id": "customTooltipExpression"
1057
- },
1058
- {
1059
- "qExpression": "'https://my_url/'+sum(population)",
1060
- "qLibraryId": "",
1061
- "qAttribute": true,
1062
- "qNumFormat": null,
1063
- "qLabel": "",
1064
- "qLabelExpression": "",
1065
- "cId": "generatedUniqueId",
1066
- "id": "customTooltipImages"
1067
- }]
1068
- ```
1069
-
1070
- <a name="MasterVisualizationChart"></a>
1071
-
1072
- ## MasterVisualizationChart : <code>object</code>
1073
-
1074
- Chart component information structure.
1075
-
1076
- **Kind**: global typedef
1077
- **Properties**
1078
-
1079
- | Name | Type | Description |
1080
- | ------ | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
1081
- | style | [<code>MasterVisualizationChartStyle</code>](#MasterVisualizationChartStyle) | Object containing the styles of the chart such as 'size' |
1082
- | object | [<code>MasterVisualizationChartObject</code>](#MasterVisualizationChartObject) | Object containing the information fo the visualization, such as refId in case of master visualization |
1083
-
1084
- <a name="MasterVisualizationChartStyle"></a>
1085
-
1086
- ## MasterVisualizationChartStyle : <code>object</code>
1087
-
1088
- Chart component information structure.
1089
-
1090
- **Kind**: global typedef
1091
- **Properties**
1092
-
1093
- | Name | Type | Description |
1094
- | ---- | ------------------- | -------------------------------------------- |
1095
- | size | <code>string</code> | Input type as 'small' or 'medium' or 'large' |
1096
-
1097
- <a name="MasterVisualizationChartObject"></a>
1098
-
1099
- ## MasterVisualizationChartObject : <code>object</code>
1100
-
1101
- Chart component information structure.
1102
-
1103
- **Kind**: global typedef
1104
- **Properties**
1105
-
1106
- | Name | Type | Description |
1107
- | ----- | ------------------- | ------------------------------------------------------------------------------------------------------------------------- |
1108
- | refId | <code>string</code> | Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization |
1109
-
1110
- <a name="ImageComponent"></a>
1111
-
1112
- ## ImageComponent : <code>object</code>
1113
-
1114
- Image component information structure.
1115
-
1116
- **Kind**: global typedef
1117
- **Properties**
1118
-
1119
- | Name | Type | Description |
1120
- | ---- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
1121
- | type | <code>string</code> | Input type as 'url' or 'media library' |
1122
- | size | <code>string</code> | Size as 'small','medium','large' or 'original' |
1123
- | cId | <code>string</code> | Identifier of the image component - used as a link with an attribute expression |
1124
- | ref | <code>string</code> \| <code>StringExpression</code> \| [<code>MediaLibraryRef</code>](#MediaLibraryRef) | The reference value of the image |
1125
-
1126
- <a name="MediaLibraryRef"></a>
1127
-
1128
- ## MediaLibraryRef : <code>object</code>
1129
-
1130
- Media Library Reference structure.
1131
-
1132
- **Kind**: global typedef
1133
- **Properties**
1134
-
1135
- | Name | Type | Description |
1136
- | -------------------- | ------------------- | ----------------------- |
1137
- | qStaticContentUrlDef | <code>object</code> | Media library structure |
1138
-
1139
- <a name="qStaticContentUrlDef"></a>
1140
-
1141
- ## qStaticContentUrlDef : <code>object</code>
1142
-
1143
- Media Library structure that will be evaluated by the engine.
1144
-
1145
- **Kind**: global typedef
1146
- **Properties**
1147
-
1148
- | Name | Type | Description |
1149
- | ---- | ------------------- | ---------------------------- |
1150
- | qUrl | <code>string</code> | Value of media library image |
663
+ **Kind**: global typedef