@pie-element/graphing 3.7.21 → 4.0.0

package/docs/config-schema.json.md

@@ -8,16 +8,83 @@ Properties of the `authoring` object:
 
 ## `settings` (boolean)
 
-Indicates if the item has to be displayed in the Settings Panel
+Indicates if the item is displayed in the Settings Panel
 
 ## `label` (string)
 
-Indicates the label for the item that has to be displayed in the Settings Panel
+Indicates the label for the item that is displayed in the Settings Panel
 
 ## `enabled` (boolean)
 
-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)
+Indicates if the Grid Setup Panel is displayed
+
+## `includeAxesEnabled` (boolean)
+
+Indicates if the "includeAxes" toggle is displayed in the Grid Setup Panel
+
+## `standardGridEnabled` (boolean)
+
+Indicates if the "standardGrid" toggle is displayed in the Grid Setup Panel
+
+## `min` (object)
+
+Properties of the `min` object:
+
+### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+## `max` (object)
+
+Properties of the `max` object:
+
+### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+## `axisLabel` (object)
+
+Properties of the `axisLabel` object:
+
+### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+## `step` (object)
+
+Properties of the `step` object:
+
+### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+## `labelStep` (object)
+
+Properties of the `labelStep` object:
+
+### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
 
 # `arrows` (object)
 
@@ -63,6 +130,12 @@ Properties of the `down` object:
 
 Indicates the label for the arrow that has to be displayed in the Settings Panel
 
+# `availableTools` (array)
+
+Graph toolbar tools configuration
+
+The object is an array with all elements of the type `string`.
+
 # `coordinatesOnHover` (object)
 
 Properties of the `coordinatesOnHover` object:
@@ -75,6 +148,34 @@ 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
 
+# `graphDimensions` (object)
+
+Properties of the `graphDimensions` object:
+
+## `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+## `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `enabled` (boolean)
+
+Indicates if the graph dimensions are included in the Grid Setup Panel
+
+## `min` (number)
+
+Indicates the minimum value for the graph width and height
+
+## `max` (number)
+
+Indicates the maximum value for the graph width and height
+
+## `step` (number)
+
+Indicates the increase/decrease value for the graph width and height
+
 # `padding` (object)
 
 Properties of the `padding` object:
@@ -188,6 +289,38 @@ 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)
 
+# `maxImageWidth` (object)
+
+Properties of the `maxImageWidth` object:
+
+## `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+## `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+## `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+# `maxImageHeight` (object)
+
+Properties of the `maxImageHeight` object:
+
+## `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+## `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+## `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
 # `showPrompt` (boolean)
 
 Determines whether prompt field will be displayed or not
@@ -212,22 +345,101 @@ Default: `true`
 
 The schema defines the following additional types:
 
-## `ConfigurePropWithEnabled` (object)
+## `AuthoringConfigProp` (object)
 
-Properties of the `ConfigurePropWithEnabled` object:
+Properties of the `AuthoringConfigProp` object:
 
 ### `settings` (boolean)
 
-Indicates if the item has to be displayed in the Settings Panel
+Indicates if the item is displayed in the Settings Panel
 
 ### `label` (string)
 
-Indicates the label for the item that has to be displayed in the Settings Panel
+Indicates the label for the item that is displayed in the Settings Panel
 
 ### `enabled` (boolean)
 
-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)
+Indicates if the Grid Setup Panel is displayed
+
+### `includeAxesEnabled` (boolean)
+
+Indicates if the "includeAxes" toggle is displayed in the Grid Setup Panel
+
+### `standardGridEnabled` (boolean)
+
+Indicates if the "standardGrid" toggle is displayed in the Grid Setup Panel
+
+### `min` (object)
+
+Properties of the `min` object:
+
+#### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+#### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+### `max` (object)
+
+Properties of the `max` object:
+
+#### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+#### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+### `axisLabel` (object)
+
+Properties of the `axisLabel` object:
+
+#### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+#### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+### `step` (object)
+
+Properties of the `step` object:
+
+#### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+#### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+### `labelStep` (object)
+
+Properties of the `labelStep` object:
+
+#### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+#### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
+
+## `GridPanelConfigProp` (object)
+
+Properties of the `GridPanelConfigProp` object:
+
+### `label` (string)
+
+Indicates the label for the item that is displayed in the Grid Setup Panel
+
+### `enabled` (boolean)
+
+Indicates if the item is displayed in the Grid Setup Panel
 
 ## `ArrowsConfigProp` (object)
 
@@ -291,4 +503,65 @@ Indicates if the item has to be displayed in the Settings Panel
 
 ### `label` (string)
 
-Indicates the label for the item that has to be displayed in the Settings Panel
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `DimensionsConfigProp` (object)
+
+Properties of the `DimensionsConfigProp` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+### `enabled` (boolean)
+
+Indicates if the graph dimensions are included in the Grid Setup Panel
+
+### `min` (number)
+
+Indicates the minimum value for the graph width and height
+
+### `max` (number)
+
+Indicates the maximum value for the graph width and height
+
+### `step` (number)
+
+Indicates the increase/decrease value for the graph width and height
+
+## `ConfigurePropWithEnabled` (object)
+
+Properties of the `ConfigurePropWithEnabled` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+### `enabled` (boolean)
+
+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)
+
+## `ConfigureMaxImageDimensionsProp` (object)
+
+Properties of the `ConfigureMaxImageDimensionsProp` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale

package/docs/demo/generate.js

@@ -128,6 +128,7 @@ exports.model = (id, element) => ({
     labelStep: 1,
     axisLabel: 'x'
   },
+  defaultTool: 'point',
   graph: {
     width: 480,
     height: 480

package/docs/pie-schema.json

@@ -1485,6 +1485,22 @@
       "type": "boolean",
       "title": "coordinatesOnHover"
     },
+    "defaultTool": {
+      "description": "Indicates the default selected tool for the graph",
+      "enum": [
+        "circle",
+        "line",
+        "parabola",
+        "point",
+        "polygon",
+        "ray",
+        "segment",
+        "sine",
+        "vector"
+      ],
+      "type": "string",
+      "title": "defaultTool"
+    },
     "domain": {
       "title": "GraphSettings",
       "type": "object",
@@ -1549,6 +1565,11 @@
         "width"
       ]
     },
+    "includeAxes": {
+      "description": "Indicates if the graph axes and labels are enabled",
+      "type": "boolean",
+      "title": "includeAxes"
+    },
     "labels": {
       "title": "Labels",
       "type": "object",
@@ -1721,6 +1742,11 @@
       "type": "boolean",
       "title": "spellCheckEnabled"
     },
+    "standardGrid": {
+      "description": "Indicates if some domain values will be synched to the range values",
+      "type": "boolean",
+      "title": "standardGrid"
+    },
     "studentInstructionsEnabled": {
       "description": "Indicates if Student Instructions are enabled",
       "type": "boolean",
@@ -1745,6 +1771,7 @@
   "required": [
     "answers",
     "backgroundMarks",
+    "defaultTool",
     "domain",
     "element",
     "graph",
@@ -1756,22 +1783,128 @@
     "teacherInstructionsEnabled"
   ],
   "definitions": {
-    "ConfigurePropWithEnabled": {
-      "title": "ConfigurePropWithEnabled",
+    "AuthoringConfigProp": {
+      "title": "AuthoringConfigProp",
       "type": "object",
       "properties": {
         "settings": {
-          "description": "Indicates if the item has to be displayed in the Settings Panel",
+          "description": "Indicates if the item is displayed in the Settings Panel",
           "type": "boolean",
           "title": "settings"
         },
         "label": {
-          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+          "description": "Indicates the label for the item that is displayed in the Settings Panel",
           "type": "string",
           "title": "label"
         },
         "enabled": {
-          "description": "Indicates the value of the item if it affects config-ui\n(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)",
+          "description": "Indicates if the Grid Setup Panel is displayed",
+          "type": "boolean",
+          "title": "enabled"
+        },
+        "includeAxesEnabled": {
+          "description": "Indicates if the \"includeAxes\" toggle is displayed in the Grid Setup Panel",
+          "type": "boolean",
+          "title": "includeAxesEnabled"
+        },
+        "standardGridEnabled": {
+          "description": "Indicates if the \"standardGrid\" toggle is displayed in the Grid Setup Panel",
+          "type": "boolean",
+          "title": "standardGridEnabled"
+        },
+        "min": {
+          "title": "GridPanelConfigProp",
+          "type": "object",
+          "properties": {
+            "label": {
+              "description": "Indicates the label for the item that is displayed in the Grid Setup Panel",
+              "type": "string",
+              "title": "label"
+            },
+            "enabled": {
+              "description": "Indicates if the item is displayed in the Grid Setup Panel",
+              "type": "boolean",
+              "title": "enabled"
+            }
+          }
+        },
+        "max": {
+          "title": "GridPanelConfigProp",
+          "type": "object",
+          "properties": {
+            "label": {
+              "description": "Indicates the label for the item that is displayed in the Grid Setup Panel",
+              "type": "string",
+              "title": "label"
+            },
+            "enabled": {
+              "description": "Indicates if the item is displayed in the Grid Setup Panel",
+              "type": "boolean",
+              "title": "enabled"
+            }
+          }
+        },
+        "axisLabel": {
+          "title": "GridPanelConfigProp",
+          "type": "object",
+          "properties": {
+            "label": {
+              "description": "Indicates the label for the item that is displayed in the Grid Setup Panel",
+              "type": "string",
+              "title": "label"
+            },
+            "enabled": {
+              "description": "Indicates if the item is displayed in the Grid Setup Panel",
+              "type": "boolean",
+              "title": "enabled"
+            }
+          }
+        },
+        "step": {
+          "title": "GridPanelConfigProp",
+          "type": "object",
+          "properties": {
+            "label": {
+              "description": "Indicates the label for the item that is displayed in the Grid Setup Panel",
+              "type": "string",
+              "title": "label"
+            },
+            "enabled": {
+              "description": "Indicates if the item is displayed in the Grid Setup Panel",
+              "type": "boolean",
+              "title": "enabled"
+            }
+          }
+        },
+        "labelStep": {
+          "title": "GridPanelConfigProp",
+          "type": "object",
+          "properties": {
+            "label": {
+              "description": "Indicates the label for the item that is displayed in the Grid Setup Panel",
+              "type": "string",
+              "title": "label"
+            },
+            "enabled": {
+              "description": "Indicates if the item is displayed in the Grid Setup Panel",
+              "type": "boolean",
+              "title": "enabled"
+            }
+          }
+        }
+      }
+    },
+    "GridPanelConfigProp": {
+      "title": "GridPanelConfigProp",
+      "type": "object",
+      "properties": {
+        "label": {
+          "description": "Indicates the label for the item that is displayed in the Grid Setup Panel",
+          "type": "string",
+          "title": "label"
+        },
+        "enabled": {
+          "description": "Indicates if the item is displayed in the Grid Setup Panel",
           "type": "boolean",
           "title": "enabled"
         }
@@ -1864,6 +1997,84 @@
         }
       }
     },
+    "DimensionsConfigProp": {
+      "title": "DimensionsConfigProp",
+      "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 item that has to be displayed in the Settings Panel",
+          "type": "string",
+          "title": "label"
+        },
+        "enabled": {
+          "description": "Indicates if the graph dimensions are included in the Grid Setup Panel",
+          "type": "boolean",
+          "title": "enabled"
+        },
+        "min": {
+          "description": "Indicates the minimum value for the graph width and height",
+          "type": "number",
+          "title": "min"
+        },
+        "max": {
+          "description": "Indicates the maximum value for the graph width and height",
+          "type": "number",
+          "title": "max"
+        },
+        "step": {
+          "description": "Indicates the increase/decrease value for the graph width and height",
+          "type": "number",
+          "title": "step"
+        }
+      }
+    },
+    "ConfigurePropWithEnabled": {
+      "title": "ConfigurePropWithEnabled",
+      "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 item that has to be displayed in the Settings Panel",
+          "type": "string",
+          "title": "label"
+        },
+        "enabled": {
+          "description": "Indicates the value of the item if it affects config-ui\n(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)",
+          "type": "boolean",
+          "title": "enabled"
+        }
+      }
+    },
+    "ConfigureMaxImageDimensionsProp": {
+      "title": "ConfigureMaxImageDimensionsProp",
+      "type": "object",
+      "properties": {
+        "teacherInstructions": {
+          "description": "Indicates the max dimension for images in teacher instructions",
+          "type": "number",
+          "title": "teacherInstructions"
+        },
+        "prompt": {
+          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+          "type": "number",
+          "title": "prompt"
+        },
+        "rationale": {
+          "description": "Indicates the max dimension for images in rationale",
+          "type": "number",
+          "title": "rationale"
+        }
+      }
+    },
     "Answer": {
       "title": "Answer",
       "type": "object",
@@ -2725,4 +2936,4 @@
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"
-}
+}