@pie-element/charting 5.11.3 → 6.0.0

package/docs/config-schema.json.md

@@ -140,6 +140,26 @@ Indicates the label for the item that has to be displayed in the Settings Panel
 Indicates the value of the item if it affects config-ui
 (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
 
+# `authorNewCategoryDefaults` (object, required)
+
+Properties of the `authorNewCategoryDefaults` object:
+
+## `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+## `label` (string)
+
+Indicates the label for the new category
+
+## `interactive` (boolean)
+
+Indicates if new category is interactive
+
+## `editable` (boolean)
+
+Indicates if new category is editable
+
 # `maxImageWidth` (object)
 
 Properties of the `maxImageWidth` object:
@@ -184,6 +204,90 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+# `chartingOptions` (object)
+
+Properties of the `chartingOptions` object:
+
+## `changeInteractive` (object)
+
+Properties of the `changeInteractive` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `authoringLabel` (string)
+
+Indicates the label for the option
+
+### `settingsLabel` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `changeEditable` (object)
+
+Properties of the `changeEditable` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `authoringLabel` (string)
+
+Indicates the label for the option
+
+### `settingsLabel` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `addCategory` (object)
+
+Properties of the `addCategory` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `authoringLabel` (string)
+
+Indicates the label for the option
+
+### `settingsLabel` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+# `availableChartTypes` (object)
+
+Properties of the `availableChartTypes` object:
+
+## `bar` (string, required)
+
+Indicates if bar chart is available and the label used for it.
+
+## `histogram` (string, required)
+
+Indicates if histogram is available and the label used for it.
+
+## `lineDot` (string, required)
+
+Indicates if line chart with dots is available and the label used for it.
+
+## `lineCross` (string, required)
+
+Indicates if line chart with crosses is available and the label used for it.
+
+## `dotPlot` (string, required)
+
+Indicates if dot plot is available and the label used for it.
+
+## `linePlot` (string, required)
+
+Indicates if line plot is available and the label used for it.
+
+# `chartTypeLabel` (string, required)
+
+Indicates the label for the chart type
+
 # `showPrompt` (boolean)
 
 Determines whether prompt field will be displayed or not
@@ -304,6 +408,26 @@ Indicates the label for the item that has to be displayed in the Settings Panel
 Indicates the value of the item if it affects config-ui
 (eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
 
+## `AuthorNewCategoryDefaults` (object)
+
+Properties of the `AuthorNewCategoryDefaults` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `label` (string)
+
+Indicates the label for the new category
+
+### `interactive` (boolean)
+
+Indicates if new category is interactive
+
+### `editable` (boolean)
+
+Indicates if new category is editable
+
 ## `ConfigureMaxImageDimensionsProp` (object)
 
 Properties of the `ConfigureMaxImageDimensionsProp` object:
@@ -318,4 +442,100 @@ Indicates the max dimension for images in prompt - this is also the default dime
 
 ### `rationale` (number)
 
-Indicates the max dimension for images in rationale
+Indicates the max dimension for images in rationale
+
+## `ChartingOptions` (object)
+
+Properties of the `ChartingOptions` object:
+
+### `changeInteractive` (object)
+
+Properties of the `changeInteractive` object:
+
+#### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+#### `authoringLabel` (string)
+
+Indicates the label for the option
+
+#### `settingsLabel` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+### `changeEditable` (object)
+
+Properties of the `changeEditable` object:
+
+#### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+#### `authoringLabel` (string)
+
+Indicates the label for the option
+
+#### `settingsLabel` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+### `addCategory` (object)
+
+Properties of the `addCategory` object:
+
+#### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+#### `authoringLabel` (string)
+
+Indicates the label for the option
+
+#### `settingsLabel` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `ChartingOption` (object)
+
+Properties of the `ChartingOption` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `authoringLabel` (string)
+
+Indicates the label for the option
+
+### `settingsLabel` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `AvailableChartTypes` (object)
+
+Properties of the `AvailableChartTypes` object:
+
+### `bar` (string, required)
+
+Indicates if bar chart is available and the label used for it.
+
+### `histogram` (string, required)
+
+Indicates if histogram is available and the label used for it.
+
+### `lineDot` (string, required)
+
+Indicates if line chart with dots is available and the label used for it.
+
+### `lineCross` (string, required)
+
+Indicates if line chart with crosses is available and the label used for it.
+
+### `dotPlot` (string, required)
+
+Indicates if dot plot is available and the label used for it.
+
+### `linePlot` (string, required)
+
+Indicates if line plot is available and the label used for it.

package/docs/demo/generate.js

@@ -2,7 +2,6 @@ exports.model = (id, element) => ({
   id,
   element,
   addCategoryEnabled: true,
-  categoryDefaultLabel: 'Category',
   chartType: 'bar',
   correctAnswer: {
     data: [

package/docs/pie-schema.json

@@ -8,11 +8,6 @@
       "type": "boolean",
       "title": "addCategoryEnabled"
     },
-    "categoryDefaultLabel": {
-      "description": "Indicates default value for a new category's label",
-      "type": "string",
-      "title": "categoryDefaultLabel"
-    },
     "chartType": {
       "enum": [
         "bar",
@@ -53,7 +48,7 @@
                   "title": "value"
                 },
                 "interactive": {
-                  "description": "Indicates if category label & value are interactive",
+                  "description": "Indicates if category value is interactive",
                   "type": "boolean",
                   "title": "interactive"
                 },
@@ -123,7 +118,7 @@
                     "title": "value"
                   },
                   "interactive": {
-                    "description": "Indicates if category label & value are interactive",
+                    "description": "Indicates if category value is interactive",
                     "type": "boolean",
                     "title": "interactive"
                   },
@@ -203,7 +198,7 @@
               "title": "value"
             },
             "interactive": {
-              "description": "Indicates if category label & value are interactive",
+              "description": "Indicates if category value is interactive",
               "type": "boolean",
               "title": "interactive"
             },
@@ -273,7 +268,7 @@
                 "title": "value"
               },
               "interactive": {
-                "description": "Indicates if category label & value are interactive",
+                "description": "Indicates if category value is interactive",
                 "type": "boolean",
                 "title": "interactive"
               },
@@ -508,6 +503,26 @@
       "type": "boolean",
       "title": "rubricEnabled"
     },
+    "changeInteractiveEnabled": {
+      "description": "Indicates if teacher can enable/disable data[]:interactive",
+      "type": "boolean",
+      "title": "changeInteractiveEnabled"
+    },
+    "changeEditableEnabled": {
+      "description": "Indicates if teacher can enable/disable data[]:editable",
+      "type": "boolean",
+      "title": "changeEditableEnabled"
+    },
+    "changeAddCategoryEnabled": {
+      "description": "Indicates if teacher can enable/disable addCategoryEnabled",
+      "type": "boolean",
+      "title": "changeAddCategoryEnabled"
+    },
+    "studentNewCategoryDefaultLabel": {
+      "description": "Label for new category in correct response and player's chart",
+      "type": "string",
+      "title": "studentNewCategoryDefaultLabel"
+    },
     "id": {
       "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.",
       "type": "string",
@@ -521,7 +536,9 @@
   },
   "required": [
     "addCategoryEnabled",
-    "categoryDefaultLabel",
+    "changeAddCategoryEnabled",
+    "changeEditableEnabled",
+    "changeInteractiveEnabled",
     "chartType",
     "correctAnswer",
     "data",
@@ -534,6 +551,7 @@
     "rubricEnabled",
     "spellCheckEnabled",
     "studentInstructionsEnabled",
+    "studentNewCategoryDefaultLabel",
     "teacherInstructionsEnabled"
   ],
   "definitions": {
@@ -615,6 +633,32 @@
         }
       }
     },
+    "AuthorNewCategoryDefaults": {
+      "title": "AuthorNewCategoryDefaults",
+      "type": "object",
+      "properties": {
+        "settings": {
+          "description": "Indicates if the item has to be displayed in the Settings Panel",
+          "type": "boolean",
+          "title": "settings"
+        },
+        "label": {
+          "description": "Indicates the label for the new category",
+          "type": "string",
+          "title": "label"
+        },
+        "interactive": {
+          "description": "Indicates if new category is interactive",
+          "type": "boolean",
+          "title": "interactive"
+        },
+        "editable": {
+          "description": "Indicates if new category is editable",
+          "type": "boolean",
+          "title": "editable"
+        }
+      }
+    },
     "ConfigureMaxImageDimensionsProp": {
       "title": "ConfigureMaxImageDimensionsProp",
       "type": "object",
@@ -636,6 +680,140 @@
         }
       }
     },
+    "ChartingOptions": {
+      "title": "ChartingOptions",
+      "type": "object",
+      "properties": {
+        "changeInteractive": {
+          "title": "ChartingOption",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "authoringLabel": {
+              "description": "Indicates the label for the option",
+              "type": "string",
+              "title": "authoringLabel"
+            },
+            "settingsLabel": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "settingsLabel"
+            }
+          }
+        },
+        "changeEditable": {
+          "title": "ChartingOption",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "authoringLabel": {
+              "description": "Indicates the label for the option",
+              "type": "string",
+              "title": "authoringLabel"
+            },
+            "settingsLabel": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "settingsLabel"
+            }
+          }
+        },
+        "addCategory": {
+          "title": "ChartingOption",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "authoringLabel": {
+              "description": "Indicates the label for the option",
+              "type": "string",
+              "title": "authoringLabel"
+            },
+            "settingsLabel": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "settingsLabel"
+            }
+          }
+        }
+      }
+    },
+    "ChartingOption": {
+      "title": "ChartingOption",
+      "type": "object",
+      "properties": {
+        "settings": {
+          "description": "Indicates if the item has to be displayed in the Settings Panel",
+          "type": "boolean",
+          "title": "settings"
+        },
+        "authoringLabel": {
+          "description": "Indicates the label for the option",
+          "type": "string",
+          "title": "authoringLabel"
+        },
+        "settingsLabel": {
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+          "type": "string",
+          "title": "settingsLabel"
+        }
+      }
+    },
+    "AvailableChartTypes": {
+      "title": "AvailableChartTypes",
+      "type": "object",
+      "properties": {
+        "bar": {
+          "description": "Indicates if bar chart is available and the label used for it.",
+          "type": "string",
+          "title": "bar"
+        },
+        "histogram": {
+          "description": "Indicates if histogram is available and the label used for it.",
+          "type": "string",
+          "title": "histogram"
+        },
+        "lineDot": {
+          "description": "Indicates if line chart with dots is available and the label used for it.",
+          "type": "string",
+          "title": "lineDot"
+        },
+        "lineCross": {
+          "description": "Indicates if line chart with crosses is available and the label used for it.",
+          "type": "string",
+          "title": "lineCross"
+        },
+        "dotPlot": {
+          "description": "Indicates if dot plot is available and the label used for it.",
+          "type": "string",
+          "title": "dotPlot"
+        },
+        "linePlot": {
+          "description": "Indicates if line plot is available and the label used for it.",
+          "type": "string",
+          "title": "linePlot"
+        }
+      },
+      "required": [
+        "bar",
+        "dotPlot",
+        "histogram",
+        "lineCross",
+        "lineDot",
+        "linePlot"
+      ]
+    },
     "Answer": {
       "title": "Answer",
       "type": "object",
@@ -664,7 +842,7 @@
                   "title": "value"
                 },
                 "interactive": {
-                  "description": "Indicates if category label & value are interactive",
+                  "description": "Indicates if category value is interactive",
                   "type": "boolean",
                   "title": "interactive"
                 },
@@ -734,7 +912,7 @@
                     "title": "value"
                   },
                   "interactive": {
-                    "description": "Indicates if category label & value are interactive",
+                    "description": "Indicates if category value is interactive",
                     "type": "boolean",
                     "title": "interactive"
                   },
@@ -810,7 +988,7 @@
           "title": "value"
         },
         "interactive": {
-          "description": "Indicates if category label & value are interactive",
+          "description": "Indicates if category value is interactive",
           "type": "boolean",
           "title": "interactive"
         },