@nebula.js/sn-pie-chart 1.21.2 → 1.22.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.
- package/api-specifications/api.md +7 -348
- package/api-specifications/plugins.json +25 -11
- package/api-specifications/properties.json +87 -105
- package/core/esm/index.js +5 -5
- package/dist/sn-pie-chart.js +12 -12
- package/dist/sn-pie-chart.systemjs.js +6 -6
- package/package.json +1 -1
- package/sn-pie-chart-ext/dist/sn-pie-chart.js +12 -12
- package/sn-pie-chart-ext/sn-pie-chart.qext +1 -1
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
- ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
|
|
25
25
|
- [.useBaseColors](#properties.color.useBaseColors) : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
|
|
26
26
|
- [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
|
|
27
|
-
- [.useMeasureGradient](#properties.color.useMeasureGradient)
|
|
28
|
-
- [.components](#properties.components) : [<code>Array.<
|
|
27
|
+
- [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
|
|
28
|
+
- [.components](#properties.components) : [<code>Array.<Slices></code>](#Slices)
|
|
29
29
|
- [.dataPoint](#properties.dataPoint) : <code>object</code>
|
|
30
30
|
- [.auto](#properties.dataPoint.auto) : <code>boolean</code>
|
|
31
31
|
- [.labelMode](#properties.dataPoint.labelMode) : <code>'none'</code> \| <code>'share'</code> \| <code>'value'</code>
|
|
@@ -98,7 +98,7 @@ Note: Some of the color properties are depending on which theme is currently bei
|
|
|
98
98
|
- ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
|
|
99
99
|
- [.useBaseColors](#properties.color.useBaseColors) : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
|
|
100
100
|
- [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
|
|
101
|
-
- [.useMeasureGradient](#properties.color.useMeasureGradient)
|
|
101
|
+
- [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
|
|
102
102
|
|
|
103
103
|
<a name="properties.color.auto"></a>
|
|
104
104
|
|
|
@@ -314,7 +314,7 @@ Only applicable if `'colorMode': 'byDimension'`.
|
|
|
314
314
|
**Default**: <code>true</code>
|
|
315
315
|
<a name="properties.color.useMeasureGradient"></a>
|
|
316
316
|
|
|
317
|
-
#### color.useMeasureGradient
|
|
317
|
+
#### color.useMeasureGradient : <code>boolean</code>
|
|
318
318
|
|
|
319
319
|
Set to true if you want to apply the colors defined for library measures when used. Only applicable if `"mode": "byMeasure"`.
|
|
320
320
|
|
|
@@ -322,7 +322,7 @@ Set to true if you want to apply the colors defined for library measures when us
|
|
|
322
322
|
**Default**: <code>true</code>
|
|
323
323
|
<a name="properties.components"></a>
|
|
324
324
|
|
|
325
|
-
### properties.components : [<code>Array.<
|
|
325
|
+
### properties.components : [<code>Array.<Slices></code>](#Slices)
|
|
326
326
|
|
|
327
327
|
Styling of chart components.
|
|
328
328
|
|
|
@@ -476,7 +476,7 @@ Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
|
|
|
476
476
|
Show visualization details toggle
|
|
477
477
|
|
|
478
478
|
**Kind**: static property of [<code>properties</code>](#properties)
|
|
479
|
-
**Default**: <code>
|
|
479
|
+
**Default**: <code>true</code>
|
|
480
480
|
<a name="properties.showDisclaimer"></a>
|
|
481
481
|
|
|
482
482
|
### properties.showDisclaimer : <code>boolean</code>
|
|
@@ -576,349 +576,8 @@ The imageComponents objects are used to define the images displayed by the custo
|
|
|
576
576
|
|
|
577
577
|
# Definitions
|
|
578
578
|
|
|
579
|
-
<a name="paletteColor"></a>
|
|
580
|
-
|
|
581
|
-
## paletteColor : <code>object</code>
|
|
582
|
-
|
|
583
|
-
Color information structure. Holds the actual color and index in palette.
|
|
584
|
-
|
|
585
|
-
**Kind**: global typedef
|
|
586
|
-
**Properties**
|
|
587
|
-
|
|
588
|
-
| Name | Type | Description |
|
|
589
|
-
| ----- | ------------------- | -------------------------------------------- |
|
|
590
|
-
| color | <code>string</code> | Color as hex string (mandatory if index: -1) |
|
|
591
|
-
| index | <code>number</code> | Index in palette |
|
|
592
|
-
|
|
593
|
-
<a name="Component"></a>
|
|
594
|
-
|
|
595
|
-
## Component : [<code>Slices</code>](#Slices)
|
|
596
|
-
|
|
597
|
-
**Kind**: global typedef
|
|
598
|
-
<a name="Slices"></a>
|
|
599
|
-
|
|
600
|
-
## Slices : <code>object</code>
|
|
601
|
-
|
|
602
|
-
**Kind**: global typedef
|
|
603
|
-
**Properties**
|
|
604
|
-
|
|
605
|
-
| Name | Type | Description |
|
|
606
|
-
| ----- | -------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
607
|
-
| key | <code>string</code> | This should be set to `"slices"` (Determines which component the settings apply to). |
|
|
608
|
-
| style | [<code>SlicesStyling</code>](#SlicesStyling) | |
|
|
609
|
-
|
|
610
|
-
<a name="SlicesStyling"></a>
|
|
611
|
-
|
|
612
|
-
## SlicesStyling : <code>object</code>
|
|
613
|
-
|
|
614
|
-
**Kind**: global typedef
|
|
615
|
-
**Properties**
|
|
616
|
-
|
|
617
|
-
| Name | Type | Default | Description |
|
|
618
|
-
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | --------------------------------------------------------------------------- |
|
|
619
|
-
| strokeColor | [<code>paletteColor</code>](#paletteColor) | <code>"{</code> | index: -1, color: '#ffffff' }" |
|
|
620
|
-
| strokeWidth | <code>'none'</code> \| <code>'small'</code> \| <code>'medium'</code> \| <code>'large'</code> | <code>'none'</code> | Set to specify stroke width. |
|
|
621
|
-
| cornerRadius | <code>number</code> | <code>0</code> | A number between 0 and 40. |
|
|
622
|
-
| innerRadius | <code>number</code> | <code>0.55</code> | A number between 0.05 and 0.75. Only applicable for "donut" representation. |
|
|
623
|
-
|
|
624
|
-
<a name="byDimDef"></a>
|
|
625
|
-
|
|
626
|
-
## byDimDef : <code>object</code>
|
|
627
|
-
|
|
628
|
-
Settings when coloring by dimension (`"mode": "byDimension"`)
|
|
629
|
-
|
|
630
|
-
**Kind**: global typedef
|
|
631
|
-
**Properties**
|
|
632
|
-
|
|
633
|
-
| Name | Type | Description |
|
|
634
|
-
| ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
635
|
-
| key | <code>string</code> | libraryId if `"type": "libraryItem"`, dimension expression if `"type": "expression"` |
|
|
636
|
-
| label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
|
|
637
|
-
| type | <code>'expression'</code> \| <code>'libraryItem'</code> | |
|
|
638
|
-
|
|
639
|
-
<a name="byMeasureDef"></a>
|
|
640
|
-
|
|
641
|
-
## byMeasureDef : <code>object</code>
|
|
642
|
-
|
|
643
|
-
Settings when coloring by measure (`"mode": "byMeasure"`)
|
|
644
|
-
|
|
645
|
-
**Kind**: global typedef
|
|
646
|
-
**Properties**
|
|
647
|
-
|
|
648
|
-
| Name | Type | Description |
|
|
649
|
-
| ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
650
|
-
| key | <code>string</code> | libraryId if `"type": "libraryItem"`, measure expression if `"type": "expression"` |
|
|
651
|
-
| label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
|
|
652
|
-
| type | <code>'expression'</code> \| <code>'libraryItem'</code> | |
|
|
653
|
-
|
|
654
|
-
<a name="DimensionProperties"></a>
|
|
655
|
-
|
|
656
|
-
## DimensionProperties : <code>object</code>
|
|
657
|
-
|
|
658
|
-
Extends `NxDimension`, see Engine API: `NxDimension`.
|
|
659
|
-
|
|
660
|
-
**Kind**: global typedef
|
|
661
|
-
**Extends**: <code>NxDimension</code>
|
|
662
|
-
**Properties**
|
|
663
|
-
|
|
664
|
-
| Name | Type |
|
|
665
|
-
| -------------------- | ---------------------------------------------------------------------------------------- |
|
|
666
|
-
| qAttributeDimensions | [<code>Array.<AttributeDimensionProperties></code>](#AttributeDimensionProperties) |
|
|
667
|
-
| qDef | [<code>InlineDimensionDef</code>](#InlineDimensionDef) |
|
|
668
|
-
|
|
669
|
-
<a name="InlineDimensionDef"></a>
|
|
670
|
-
|
|
671
|
-
## InlineDimensionDef : <code>object</code>
|
|
672
|
-
|
|
673
|
-
Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.
|
|
674
|
-
|
|
675
|
-
**Kind**: global typedef
|
|
676
|
-
**Extends**: <code>NxInlineDimensionDef</code>
|
|
677
|
-
**Properties**
|
|
678
|
-
|
|
679
|
-
| Name | Type | Description |
|
|
680
|
-
| ----------- | ---------------------------------------------------- | ------------------------------------------------------------------- |
|
|
681
|
-
| [autoSort] | <code>boolean</code> | Set to automatically sort the dimension. |
|
|
682
|
-
| [cId] | <code>string</code> | ID used by the Qlik Sense. Must be unique within the current chart. |
|
|
683
|
-
| othersLabel | <code>string</code> \| <code>StringExpression</code> | |
|
|
684
|
-
|
|
685
|
-
<a name="MeasureProperties"></a>
|
|
686
|
-
|
|
687
|
-
## MeasureProperties : <code>object</code>
|
|
688
|
-
|
|
689
|
-
Extends `NxMeasure`, see Engine API: `NxMeasure`.
|
|
690
|
-
|
|
691
|
-
**Kind**: global typedef
|
|
692
|
-
**Extends**: <code>NxMeasure</code>
|
|
693
|
-
**Properties**
|
|
694
|
-
|
|
695
|
-
| Name | Type |
|
|
696
|
-
| --------------------- | ------------------------------------------------------------------------------------------ |
|
|
697
|
-
| qAttributeExpressions | [<code>Array.<AttributeExpressionProperties></code>](#AttributeExpressionProperties) |
|
|
698
|
-
| qDef | [<code>InlineMeasureDef</code>](#InlineMeasureDef) |
|
|
699
|
-
|
|
700
|
-
<a name="InlineMeasureDef"></a>
|
|
701
|
-
|
|
702
|
-
## InlineMeasureDef : <code>object</code>
|
|
703
|
-
|
|
704
|
-
Extends `NxInlineMeasureDef`, see Engine API: `NxInlineMeasureDef`.
|
|
705
|
-
|
|
706
|
-
**Kind**: global typedef
|
|
707
|
-
**Extends**: <code>NxInlineMeasureDef</code>
|
|
708
|
-
**Properties**
|
|
709
|
-
|
|
710
|
-
| Name | Type | Default | Description |
|
|
711
|
-
| --------------------- | ---------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
712
|
-
| [autoSort] | <code>boolean</code> | | Set to automatically sort the measure. |
|
|
713
|
-
| [cId] | <code>string</code> | | ID used by the Qlik Sense. Must be unique within the current chart. |
|
|
714
|
-
| isCustomFormatted | <code>boolean</code> | | Set to true to toggle off the default client formatting. |
|
|
715
|
-
| 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). |
|
|
716
|
-
| othersLabel | <code>string</code> \| <code>StringExpression</code> | | |
|
|
717
|
-
|
|
718
|
-
<a name="AttributeDimensionProperties"></a>
|
|
719
|
-
|
|
720
|
-
## AttributeDimensionProperties : <code>object</code>
|
|
721
|
-
|
|
722
|
-
Extends `NxAttrDimDef`, see Engine API: `NxAttrDimDef`.
|
|
723
|
-
|
|
724
|
-
**Kind**: global typedef
|
|
725
|
-
**Extends**: <code>NxAttrDimDef</code>
|
|
726
|
-
**Properties**
|
|
727
|
-
|
|
728
|
-
| Name | Type | Description |
|
|
729
|
-
| ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
730
|
-
| 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". |
|
|
731
|
-
|
|
732
579
|
<a name="AttributeExpressionProperties"></a>
|
|
733
580
|
|
|
734
581
|
## AttributeExpressionProperties : [<code>ColorAttributes</code>](#ColorAttributes) \| [<code>CustomTooltipAttributes</code>](#CustomTooltipAttributes)
|
|
735
582
|
|
|
736
|
-
**Kind**: global typedef
|
|
737
|
-
<a name="ColorAttributes"></a>
|
|
738
|
-
|
|
739
|
-
## ColorAttributes : <code>object</code>
|
|
740
|
-
|
|
741
|
-
Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
|
|
742
|
-
|
|
743
|
-
**Kind**: global typedef
|
|
744
|
-
**Extends**: <code>NxAttrExprDef</code>
|
|
745
|
-
**Properties**
|
|
746
|
-
|
|
747
|
-
| Name | Type | Description |
|
|
748
|
-
| ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
749
|
-
| 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". |
|
|
750
|
-
|
|
751
|
-
<a name="CustomTooltipAttributes"></a>
|
|
752
|
-
|
|
753
|
-
## CustomTooltipAttributes : <code>object</code>
|
|
754
|
-
|
|
755
|
-
Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
|
|
756
|
-
|
|
757
|
-
**Kind**: global typedef
|
|
758
|
-
**Extends**: <code>NxAttrExprDef</code>
|
|
759
|
-
**Properties**
|
|
760
|
-
|
|
761
|
-
| Name | Type | Description |
|
|
762
|
-
| ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
763
|
-
| id | <code>'customTooltipTitle'</code> \| <code>'customTooltipDescription'</code> \| <code>'customTooltipExpression'</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 |
|
|
764
|
-
|
|
765
|
-
**Example**
|
|
766
|
-
|
|
767
|
-
```json
|
|
768
|
-
"qAttributeExpressions": [{
|
|
769
|
-
"qExpression": "",
|
|
770
|
-
"qLibraryId": "",
|
|
771
|
-
"qAttribute": true,
|
|
772
|
-
"qNumFormat": {
|
|
773
|
-
"qType": "U",
|
|
774
|
-
"qnDec": 10,
|
|
775
|
-
"qUseThou": 0,
|
|
776
|
-
"qFmt": "",
|
|
777
|
-
"qDec": "",
|
|
778
|
-
"qThou": "",
|
|
779
|
-
}
|
|
780
|
-
"qLabel": "custom title",
|
|
781
|
-
"qLabelExpression": "",
|
|
782
|
-
"id": "customTooltipTitle"
|
|
783
|
-
},
|
|
784
|
-
{
|
|
785
|
-
"qExpression": "avg(population)",
|
|
786
|
-
"qLibraryId": "",
|
|
787
|
-
"qAttribute": true,
|
|
788
|
-
"qNumFormat": {
|
|
789
|
-
"qType": "U",
|
|
790
|
-
"qnDec": 10,
|
|
791
|
-
"qUseThou": 0,
|
|
792
|
-
"qFmt": "",
|
|
793
|
-
"qDec": "",
|
|
794
|
-
"qThou": "",
|
|
795
|
-
}
|
|
796
|
-
"qLabel": "",
|
|
797
|
-
"qLabelExpression": "",
|
|
798
|
-
"id": "customTooltipDescription"
|
|
799
|
-
},
|
|
800
|
-
{
|
|
801
|
-
"qExpression": "",
|
|
802
|
-
"qLibraryId": "zpDNMcg",
|
|
803
|
-
"qAttribute": true,
|
|
804
|
-
"qNumFormat": {
|
|
805
|
-
"qType": "U",
|
|
806
|
-
"qnDec": 10,
|
|
807
|
-
"qUseThou": 0,
|
|
808
|
-
"qFmt": "",
|
|
809
|
-
"qDec": "",
|
|
810
|
-
"qThou": "",
|
|
811
|
-
}
|
|
812
|
-
"qLabel": "",
|
|
813
|
-
"qLabelExpression": "",
|
|
814
|
-
"id": "customTooltipExpression"
|
|
815
|
-
},
|
|
816
|
-
{
|
|
817
|
-
"qExpression": "sum(population)",
|
|
818
|
-
"qLibraryId": "",
|
|
819
|
-
"qAttribute": true,
|
|
820
|
-
"qNumFormat": {
|
|
821
|
-
"qType": "M",
|
|
822
|
-
"qnDec": 2,
|
|
823
|
-
"qUseThou": 0,
|
|
824
|
-
"qFmt": "$#,##0.00;-$#,##0.00",
|
|
825
|
-
"qDec": ".",
|
|
826
|
-
"qThou": ",",
|
|
827
|
-
}
|
|
828
|
-
"qLabel": "",
|
|
829
|
-
"qLabelExpression": "=avg(population)",
|
|
830
|
-
"id": "customTooltipExpression"
|
|
831
|
-
},
|
|
832
|
-
{
|
|
833
|
-
"qExpression": "'https://my_url/'+sum(population)",
|
|
834
|
-
"qLibraryId": "",
|
|
835
|
-
"qAttribute": true,
|
|
836
|
-
"qNumFormat": null,
|
|
837
|
-
"qLabel": "",
|
|
838
|
-
"qLabelExpression": "",
|
|
839
|
-
"cId": "generatedUniqueId",
|
|
840
|
-
"id": "customTooltipImages"
|
|
841
|
-
}]
|
|
842
|
-
```
|
|
843
|
-
|
|
844
|
-
<a name="MasterVisualizationChart"></a>
|
|
845
|
-
|
|
846
|
-
## MasterVisualizationChart : <code>object</code>
|
|
847
|
-
|
|
848
|
-
Chart component information structure.
|
|
849
|
-
|
|
850
|
-
**Kind**: global typedef
|
|
851
|
-
**Properties**
|
|
852
|
-
|
|
853
|
-
| Name | Type | Description |
|
|
854
|
-
| ------ | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
|
855
|
-
| style | [<code>MasterVisualizationChartStyle</code>](#MasterVisualizationChartStyle) | Object containing the styles of the chart such as 'size' |
|
|
856
|
-
| object | [<code>MasterVisualizationChartObject</code>](#MasterVisualizationChartObject) | Object containing the information fo the visualization, such as refId in case of master visualization |
|
|
857
|
-
|
|
858
|
-
<a name="MasterVisualizationChartStyle"></a>
|
|
859
|
-
|
|
860
|
-
## MasterVisualizationChartStyle : <code>object</code>
|
|
861
|
-
|
|
862
|
-
Chart component information structure.
|
|
863
|
-
|
|
864
|
-
**Kind**: global typedef
|
|
865
|
-
**Properties**
|
|
866
|
-
|
|
867
|
-
| Name | Type | Description |
|
|
868
|
-
| ---- | ------------------- | -------------------------------------------- |
|
|
869
|
-
| size | <code>string</code> | Input type as 'small' or 'medium' or 'large' |
|
|
870
|
-
|
|
871
|
-
<a name="MasterVisualizationChartObject"></a>
|
|
872
|
-
|
|
873
|
-
## MasterVisualizationChartObject : <code>object</code>
|
|
874
|
-
|
|
875
|
-
Chart component information structure.
|
|
876
|
-
|
|
877
|
-
**Kind**: global typedef
|
|
878
|
-
**Properties**
|
|
879
|
-
|
|
880
|
-
| Name | Type | Description |
|
|
881
|
-
| ----- | ------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
882
|
-
| refId | <code>string</code> | Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization |
|
|
883
|
-
|
|
884
|
-
<a name="ImageComponent"></a>
|
|
885
|
-
|
|
886
|
-
## ImageComponent : <code>object</code>
|
|
887
|
-
|
|
888
|
-
Image component information structure.
|
|
889
|
-
|
|
890
|
-
**Kind**: global typedef
|
|
891
|
-
**Properties**
|
|
892
|
-
|
|
893
|
-
| Name | Type | Description |
|
|
894
|
-
| ---- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
895
|
-
| type | <code>string</code> | Input type as 'url' or 'media library' |
|
|
896
|
-
| size | <code>string</code> | Size as 'small','medium','large' or 'original' |
|
|
897
|
-
| cId | <code>string</code> | Identifier of the image component - used as a link with an attribute expression |
|
|
898
|
-
| ref | <code>string</code> \| <code>StringExpression</code> \| [<code>MediaLibraryRef</code>](#MediaLibraryRef) | The reference value of the image |
|
|
899
|
-
|
|
900
|
-
<a name="MediaLibraryRef"></a>
|
|
901
|
-
|
|
902
|
-
## MediaLibraryRef : <code>object</code>
|
|
903
|
-
|
|
904
|
-
Media Library Reference structure.
|
|
905
|
-
|
|
906
|
-
**Kind**: global typedef
|
|
907
|
-
**Properties**
|
|
908
|
-
|
|
909
|
-
| Name | Type | Description |
|
|
910
|
-
| -------------------- | ------------------- | ----------------------- |
|
|
911
|
-
| qStaticContentUrlDef | <code>object</code> | Media library structure |
|
|
912
|
-
|
|
913
|
-
<a name="qStaticContentUrlDef"></a>
|
|
914
|
-
|
|
915
|
-
## qStaticContentUrlDef : <code>object</code>
|
|
916
|
-
|
|
917
|
-
Media Library structure that will be evaluated by the engine.
|
|
918
|
-
|
|
919
|
-
**Kind**: global typedef
|
|
920
|
-
**Properties**
|
|
921
|
-
|
|
922
|
-
| Name | Type | Description |
|
|
923
|
-
| ---- | ------------------- | ---------------------------- |
|
|
924
|
-
| qUrl | <code>string</code> | Value of media library image |
|
|
583
|
+
**Kind**: global typedef
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"scriptappy": "1.
|
|
2
|
+
"scriptappy": "1.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"name": "@nebula.js/sn-pie-chart:plugins",
|
|
5
5
|
"description": "Pie chart plugins API definitions",
|
|
6
|
-
"version": "1.
|
|
6
|
+
"version": "1.22.0",
|
|
7
7
|
"license": "MIT",
|
|
8
8
|
"stability": "experimental",
|
|
9
9
|
"x-qlik-visibility": "public"
|
|
@@ -15,11 +15,9 @@
|
|
|
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
|
"COMPONENT": {
|
|
21
20
|
"description": "The unique keys of the existing components available in the pie chart.\nThey are useful if you want to extend or override the existing components.",
|
|
22
|
-
"kind": "object",
|
|
23
21
|
"entries": {
|
|
24
22
|
"DIMENSION_TITLE": {
|
|
25
23
|
"description": "The dimension title component",
|
|
@@ -36,28 +34,44 @@
|
|
|
36
34
|
"defaultValue": "slices",
|
|
37
35
|
"type": "string"
|
|
38
36
|
}
|
|
39
|
-
}
|
|
37
|
+
},
|
|
38
|
+
"kind": "object"
|
|
40
39
|
},
|
|
41
40
|
"SCALE": {
|
|
42
41
|
"description": "The scales associated with the pie chart.\nThey are useful if you want to, via plugin, add a new component that\nuses the same scale as one of the measures.",
|
|
43
|
-
"kind": "object",
|
|
44
42
|
"entries": {
|
|
45
43
|
"FILL": {
|
|
46
44
|
"description": "The scale used for coloring the slices",
|
|
47
45
|
"defaultValue": "fill",
|
|
48
46
|
"type": "string"
|
|
49
47
|
}
|
|
50
|
-
}
|
|
48
|
+
},
|
|
49
|
+
"kind": "object"
|
|
51
50
|
}
|
|
52
|
-
}
|
|
51
|
+
},
|
|
52
|
+
"kind": "object"
|
|
53
53
|
},
|
|
54
54
|
"layout": {
|
|
55
55
|
"description": "The layout from the enigma model.",
|
|
56
|
-
"
|
|
57
|
-
"entries": {}
|
|
56
|
+
"type": "object"
|
|
58
57
|
}
|
|
59
58
|
}
|
|
60
59
|
}
|
|
61
60
|
},
|
|
62
|
-
"definitions": {
|
|
61
|
+
"definitions": {
|
|
62
|
+
"getPluginArgs": {
|
|
63
|
+
"description": "Prepare important chart internals for the users to build their own plugins",
|
|
64
|
+
"kind": "function",
|
|
65
|
+
"params": [
|
|
66
|
+
{
|
|
67
|
+
"name": "layoutService",
|
|
68
|
+
"type": "object"
|
|
69
|
+
}
|
|
70
|
+
],
|
|
71
|
+
"returns": {
|
|
72
|
+
"description": "Chart internals that will be exposed to the users.",
|
|
73
|
+
"type": "#/entries/pluginArguments"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
63
77
|
}
|