@nebula.js/sn-pie-chart 1.21.2 → 1.22.0

package/api-specifications/properties.json

@@ -1,9 +1,9 @@
 {
-  "scriptappy": "1.0.0",
+  "scriptappy": "1.1.0",
   "info": {
     "name": "@nebula.js/sn-pie-chart:properties",
     "description": "Pie chart generic object definition",
-    "version": "1.21.2",
+    "version": "1.22.0",
     "license": "MIT",
     "stability": "stable",
     "x-qlik-visibility": "public"
@@ -14,7 +14,6 @@
       "entries": {
         "color": {
           "description": "Color settings.\nMost color options for visualizations are set in the color object in the options. You activate custom coloring by setting `\"auto\": false` which turns off auto-coloring.\nIf `\"auto\": true`, no other properties need to be defined in the color object.\nNote: Some of the color properties are depending on which theme is currently being used.",
-          "kind": "object",
           "entries": {
             "auto": {
               "description": "Set to use automatic coloring.\nWhen `\"auto\": true`, color settings are based on the visualization used and the number of dimensions\nand measures, that is, the settings are not fixed, but are dependent on the data input.",
@@ -111,8 +110,7 @@
                   "kind": "literal",
                   "value": "'dc'"
                 }
-              ],
-              "type": "string"
+              ]
             },
             "mode": {
               "description": "Sets the coloring mode for the visualization when auto-coloring has been switched off (`\"auto\": false`). Can be one of:\n* `primary`: a single color (by default blue) is used for all items in the chart. In visualizations that do not benefit from multiple colors (bar charts with one dimension and scatter plots), single color is the default setting.\n* `byDimension`: coloring is based upon the amount of dimension values. Details are set in the `\"byDimDef\"` property.\n!Note: `byDimension` can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below.\n```json\n{\n    \"qDef\": {\n      \"qFieldDefs\": [\n        \"NetScoreName\"\n      ]\n    },\n    \"qAttributeDimensions\": [\n      {\n        \"qDef\": \"NetScoreName\",\n        \"id\": \"colorByAlternative\",\n        \"label\": \"Year\"\n      }\n    ]\n}\n```\n* `byExpression`: coloring is based on an expression, which in most cases is a color code. Details are set in the `\"expressionIsColor\"`, `\"expressionLabel`\" and `\"colorExpression\"` properties.\n* `byMeasure`: coloring is based on the measure value. Details are set in the `\"byMeasureDef\"` property.\n* `byMultiple`: can be used when more than one measure is used. By default, 12 colors are used for the dimensions. The colors are reused when there are more than 12 dimension values.",
@@ -139,8 +137,7 @@
                   "kind": "literal",
                   "value": "'byMultiple'"
                 }
-              ],
-              "type": "string"
+              ]
             },
             "paletteColor": {
               "description": "The paletteColor object is used to define the color when you color by single color `(\"mode\": \"primary\")`.",
@@ -180,8 +177,7 @@
                   "kind": "literal",
                   "value": "'measure'"
                 }
-              ],
-              "type": "string"
+              ]
             },
             "useDimColVal": {
               "description": "Set to true if you want to apply the colors defined for library dimensions when used.\nOnly applicable if `'colorMode': 'byDimension'`.",
@@ -191,21 +187,20 @@
             "useMeasureGradient": {
               "description": "Set to true if you want to apply the colors defined for library measures when used. Only applicable if `\"mode\": \"byMeasure\"`.",
               "defaultValue": true,
-              "kind": "literal",
-              "value": true
+              "type": "boolean"
             }
-          }
+          },
+          "kind": "object"
         },
         "components": {
           "description": "Styling of chart components.",
           "kind": "array",
           "items": {
-            "type": "#/definitions/Component"
+            "type": "#/definitions/Slices"
           }
         },
         "dataPoint": {
           "description": "Data point settings.",
-          "kind": "object",
           "entries": {
             "auto": {
               "description": "Automatically select how to present data point values.",
@@ -229,8 +224,7 @@
                   "kind": "literal",
                   "value": "'value'"
                 }
-              ],
-              "type": "string"
+              ]
             },
             "labelValueMode": {
               "description": "Set how to present data point values. Dependent of the auto property",
@@ -245,10 +239,10 @@
                   "kind": "literal",
                   "value": "'radius'"
                 }
-              ],
-              "type": "string"
+              ]
             }
-          }
+          },
+          "kind": "object"
         },
         "dimensionTitle": {
           "description": "Display the dimension title.",
@@ -257,14 +251,14 @@
         },
         "donut": {
           "description": "Pie chart donut settings.",
-          "kind": "object",
           "entries": {
             "showAsDonut": {
               "description": "Set to present the pie chart as a donut.",
               "defaultValue": false,
               "type": "boolean"
             }
-          }
+          },
+          "kind": "object"
         },
         "footnote": {
           "description": "Visualization footnote.",
@@ -278,12 +272,10 @@
             {
               "type": "StringExpression"
             }
-          ],
-          "type": "any"
+          ]
         },
         "legend": {
           "description": "Legend settings.",
-          "kind": "object",
           "entries": {
             "dock": {
               "description": "Sets the legend position.",
@@ -310,8 +302,7 @@
                   "kind": "literal",
                   "value": "'top'"
                 }
-              ],
-              "type": "string"
+              ]
             },
             "show": {
               "description": "Set to show the legend.",
@@ -323,7 +314,8 @@
               "defaultValue": true,
               "type": "boolean"
             }
-          }
+          },
+          "kind": "object"
         },
         "qHyperCubeDef": {
           "description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
@@ -359,7 +351,7 @@
         "showDetails": {
           "description": "Show visualization details toggle",
           "optional": true,
-          "defaultValue": false,
+          "defaultValue": true,
           "type": "boolean"
         },
         "showDisclaimer": {
@@ -385,8 +377,7 @@
             {
               "type": "StringExpression"
             }
-          ],
-          "type": "any"
+          ]
         },
         "title": {
           "description": "Visualization title.",
@@ -400,12 +391,10 @@
             {
               "type": "StringExpression"
             }
-          ],
-          "type": "any"
+          ]
         },
         "tooltip": {
           "description": "Custom tooltip properties",
-          "kind": "object",
           "entries": {
             "auto": {
               "description": "Toggle for using custom tooltip or regular tooltip",
@@ -419,14 +408,14 @@
             },
             "data": {
               "description": "Data for the custom tooltip.",
-              "kind": "object",
               "entries": {
                 "qHyperCubeDef": {
                   "description": "A hypercube definition containing measures to be displayed in the custom tooltip.\nExtends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
                   "defaultValue": "undefined",
                   "type": "HyperCubeDef"
                 }
-              }
+              },
+              "kind": "object"
             },
             "hideBasic": {
               "description": "Toggle for hiding basic information from custom tooltip",
@@ -441,7 +430,8 @@
                 "type": "#/definitions/ImageComponent"
               }
             }
-          }
+          },
+          "kind": "object"
         },
         "version": {
           "description": "Current version of this generic object definition",
@@ -467,16 +457,18 @@
       }
     },
     "AttributeExpressionProperties": {
-      "kind": "union",
-      "items": [
-        {
-          "type": "#/definitions/ColorAttributes"
-        },
-        {
-          "type": "#/definitions/CustomTooltipAttributes"
-        }
-      ],
-      "type": "any"
+      "kind": "alias",
+      "items": {
+        "kind": "union",
+        "items": [
+          {
+            "type": "#/definitions/ColorAttributes"
+          },
+          {
+            "type": "#/definitions/CustomTooltipAttributes"
+          }
+        ]
+      }
     },
     "byDimDef": {
       "description": "Settings when coloring by dimension (`\"mode\": \"byDimension\"`)",
@@ -501,8 +493,7 @@
               "kind": "literal",
               "value": "'libraryItem'"
             }
-          ],
-          "type": "string"
+          ]
         }
       }
     },
@@ -529,8 +520,7 @@
               "kind": "literal",
               "value": "'libraryItem'"
             }
-          ],
-          "type": "string"
+          ]
         }
       }
     },
@@ -549,9 +539,6 @@
         }
       }
     },
-    "Component": {
-      "type": "#/definitions/Slices"
-    },
     "CustomTooltipAttributes": {
       "description": "Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.",
       "extends": [
@@ -577,8 +564,7 @@
               "kind": "literal",
               "value": "'customTooltipExpression'"
             }
-          ],
-          "type": "string"
+          ]
         }
       },
       "examples": [
@@ -609,14 +595,6 @@
       "description": "Image component information structure.",
       "kind": "object",
       "entries": {
-        "type": {
-          "description": "Input type as 'url' or 'media library'",
-          "type": "string"
-        },
-        "size": {
-          "description": "Size as 'small','medium','large' or 'original'",
-          "type": "string"
-        },
         "cId": {
           "description": "Identifier of the image component - used as a link with an attribute expression",
           "type": "string"
@@ -634,8 +612,15 @@
             {
               "type": "#/definitions/MediaLibraryRef"
             }
-          ],
-          "type": "any"
+          ]
+        },
+        "size": {
+          "description": "Size as 'small','medium','large' or 'original'",
+          "type": "string"
+        },
+        "type": {
+          "description": "Input type as 'url' or 'media library'",
+          "type": "string"
         }
       }
     },
@@ -648,16 +633,6 @@
       ],
       "kind": "object",
       "entries": {
-        "autoSort": {
-          "description": "Set to automatically sort the dimension.",
-          "optional": true,
-          "type": "boolean"
-        },
-        "cId": {
-          "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
-          "optional": true,
-          "type": "string"
-        },
         "othersLabel": {
           "kind": "union",
           "items": [
@@ -667,8 +642,17 @@
             {
               "type": "StringExpression"
             }
-          ],
-          "type": "any"
+          ]
+        },
+        "autoSort": {
+          "description": "Set to automatically sort the dimension.",
+          "optional": true,
+          "type": "boolean"
+        },
+        "cId": {
+          "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
+          "optional": true,
+          "type": "string"
         }
       }
     },
@@ -681,16 +665,6 @@
       ],
       "kind": "object",
       "entries": {
-        "autoSort": {
-          "description": "Set to automatically sort the measure.",
-          "optional": true,
-          "type": "boolean"
-        },
-        "cId": {
-          "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
-          "optional": true,
-          "type": "string"
-        },
         "isCustomFormatted": {
           "description": "Set to true to toggle off the default client formatting.",
           "type": "boolean"
@@ -709,8 +683,17 @@
             {
               "type": "StringExpression"
             }
-          ],
-          "type": "any"
+          ]
+        },
+        "autoSort": {
+          "description": "Set to automatically sort the measure.",
+          "optional": true,
+          "type": "boolean"
+        },
+        "cId": {
+          "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
+          "optional": true,
+          "type": "string"
         }
       }
     },
@@ -718,13 +701,13 @@
       "description": "Chart component information structure.",
       "kind": "object",
       "entries": {
-        "style": {
-          "description": "Object containing the styles of the chart such as 'size'",
-          "type": "#/definitions/MasterVisualizationChartStyle"
-        },
         "object": {
           "description": "Object containing the information fo the visualization, such as refId in case of master visualization",
           "type": "#/definitions/MasterVisualizationChartObject"
+        },
+        "style": {
+          "description": "Object containing the styles of the chart such as 'size'",
+          "type": "#/definitions/MasterVisualizationChartStyle"
         }
       }
     },
@@ -817,6 +800,16 @@
     "SlicesStyling": {
       "kind": "object",
       "entries": {
+        "cornerRadius": {
+          "description": "A number between 0 and 40.",
+          "defaultValue": 0,
+          "type": "number"
+        },
+        "innerRadius": {
+          "description": "A number between 0.05 and 0.75. Only applicable for \"donut\" representation.",
+          "defaultValue": 0.55,
+          "type": "number"
+        },
         "strokeColor": {
           "description": "index: -1, color: '#ffffff' }\"",
           "defaultValue": "\"{",
@@ -843,18 +836,7 @@
               "kind": "literal",
               "value": "'large'"
             }
-          ],
-          "type": "string"
-        },
-        "cornerRadius": {
-          "description": "A number between 0 and 40.",
-          "defaultValue": 0,
-          "type": "number"
-        },
-        "innerRadius": {
-          "description": "A number between 0.05 and 0.75. Only applicable for \"donut\" representation.",
-          "defaultValue": 0.55,
-          "type": "number"
+          ]
         }
       }
     }