@pie-element/graphing 3.5.0 → 3.5.1-beta.587

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)
 
@@ -31,6 +98,220 @@ 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
 
+## `left` (object)
+
+Properties of the `left` object:
+
+### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+## `right` (object)
+
+Properties of the `right` object:
+
+### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+## `up` (object)
+
+Properties of the `up` object:
+
+### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+## `down` (object)
+
+Properties of the `down` object:
+
+### `label` (string)
+
+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:
+
+## `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
+
+# `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
+
+# `gridConfigurations` (array, required)
+
+Grid default configurations
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+## `label` (string)
+
+Indicates the label for the configuration
+
+## `arrows` (object)
+
+Properties of the `arrows` object:
+
+### `left` (boolean, required)
+
+Indicates if left arrow is enabled
+
+### `right` (boolean, required)
+
+Indicates if right arrow is enabled
+
+### `up` (boolean, required)
+
+Indicates if up arrow is enabled
+
+### `down` (boolean, required)
+
+Indicates if down arrow is enabled
+
+## `domain` (object, required)
+
+Properties of the `domain` object:
+
+### `min` (number, required)
+
+Min value
+
+### `max` (number, required)
+
+Max value
+
+### `padding` (number, required)
+
+Padding value
+
+### `step` (number, required)
+
+Step value
+
+### `labelStep` (number, required)
+
+Label step value
+
+### `axisLabel` (string, required)
+
+Axis Label
+
+## `graph` (object, required)
+
+Properties of the `graph` object:
+
+### `width` (number, required)
+
+Width for graph representation
+
+### `height` (number, required)
+
+Height for graph representation
+
+## `includeAxes` (boolean)
+
+Indicates if the graph axes and labels are enabled
+
+## `labels` (object)
+
+Properties of the `labels` object:
+
+### `top` (string, required)
+
+Label for top side of the graph
+
+### `bottom` (string, required)
+
+Label for bottom side of the graph
+
+### `left` (string, required)
+
+Label for left side of the graph
+
+### `right` (string, required)
+
+Label for right side of the graph
+
+## `padding` (boolean)
+
+Indicates if padding is enabled
+
+## `range` (object, required)
+
+Properties of the `range` object:
+
+### `min` (number, required)
+
+Min value
+
+### `max` (number, required)
+
+Max value
+
+### `padding` (number, required)
+
+Padding value
+
+### `step` (number, required)
+
+Step value
+
+### `labelStep` (number, required)
+
+Label step value
+
+### `axisLabel` (string, required)
+
+Axis Label
+
+## `standardGrid` (boolean)
+
+Indicates if some domain values will be synched to the range values
+
+## `title` (string)
+
+Indicates graph title
+
 # `padding` (object)
 
 Properties of the `padding` object:
@@ -47,6 +328,22 @@ Indicates the label for the item that has to be displayed in the Settings Panel
 
 Properties of the `labels` object:
 
+## `top` (string)
+
+Indicates the placeholder for the top label
+
+## `right` (string)
+
+Indicates the placeholder for the right label
+
+## `bottom` (string)
+
+Indicates the placeholder for the bottom label
+
+## `left` (string)
+
+Indicates the placeholder for the left label
+
 ## `settings` (boolean)
 
 Indicates if the item has to be displayed in the Settings Panel
@@ -55,6 +352,11 @@ 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
 
+## `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)
+
 # `prompt` (object)
 
 Properties of the `prompt` object:
@@ -67,6 +369,22 @@ 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
 
+# `settingsPanelDisabled` (boolean)
+
+Indicates if the settings panel is not available
+
+# `spellCheck` (object)
+
+Properties of the `spellCheck` 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
+
 # `rationale` (object)
 
 Properties of the `rationale` object:
@@ -119,6 +437,10 @@ Indicates the label for the item that has to be displayed in the Settings Panel
 
 Properties of the `title` object:
 
+## `placeholder` (string)
+
+Indicates the placeholder for the title label
+
 ## `settings` (boolean)
 
 Indicates if the item has to be displayed in the Settings Panel
@@ -132,6 +454,50 @@ 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
+
+# `withRubric` (object)
+
+Properties of the `withRubric` 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
+
 # `showPrompt` (boolean)
 
 Determines whether prompt field will be displayed or not
@@ -156,9 +522,425 @@ Default: `true`
 
 The schema defines the following additional types:
 
-## `ConfigurePropWithEnabled` (object)
+## `AuthoringConfigProp` (object)
+
+Properties of the `AuthoringConfigProp` object:
+
+### `settings` (boolean)
+
+Indicates if the item is displayed in the Settings Panel
+
+### `label` (string)
+
+Indicates the label for the item that is displayed in the Settings Panel
+
+### `enabled` (boolean)
+
+Indicates if the Grid Setup Panel is displayed
+
+### `includeAxesEnabled` (boolean)
+
+Indicates if the "includeAxes" toggle is displayed in the Grid Setup Panel
+
+### `standardGridEnabled` (boolean)
 
-Properties of the `ConfigurePropWithEnabled` object:
+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)
+
+Properties of the `ArrowsConfigProp` 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
+
+### `left` (object)
+
+Properties of the `left` object:
+
+#### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+### `right` (object)
+
+Properties of the `right` object:
+
+#### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+### `up` (object)
+
+Properties of the `up` object:
+
+#### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+### `down` (object)
+
+Properties of the `down` object:
+
+#### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+## `ArrowsProp` (object)
+
+Properties of the `ArrowsProp` object:
+
+### `label` (string)
+
+Indicates the label for the arrow that has to be displayed in the Settings Panel
+
+## `ConfigureProp` (object)
+
+Properties of the `ConfigureProp` 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
+
+## `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
+
+## `GridConfigurationsProp` (object)
+
+Properties of the `GridConfigurationsProp` object:
+
+### `label` (string)
+
+Indicates the label for the configuration
+
+### `arrows` (object)
+
+Properties of the `arrows` object:
+
+#### `left` (boolean, required)
+
+Indicates if left arrow is enabled
+
+#### `right` (boolean, required)
+
+Indicates if right arrow is enabled
+
+#### `up` (boolean, required)
+
+Indicates if up arrow is enabled
+
+#### `down` (boolean, required)
+
+Indicates if down arrow is enabled
+
+### `domain` (object, required)
+
+Properties of the `domain` object:
+
+#### `min` (number, required)
+
+Min value
+
+#### `max` (number, required)
+
+Max value
+
+#### `padding` (number, required)
+
+Padding value
+
+#### `step` (number, required)
+
+Step value
+
+#### `labelStep` (number, required)
+
+Label step value
+
+#### `axisLabel` (string, required)
+
+Axis Label
+
+### `graph` (object, required)
+
+Properties of the `graph` object:
+
+#### `width` (number, required)
+
+Width for graph representation
+
+#### `height` (number, required)
+
+Height for graph representation
+
+### `includeAxes` (boolean)
+
+Indicates if the graph axes and labels are enabled
+
+### `labels` (object)
+
+Properties of the `labels` object:
+
+#### `top` (string, required)
+
+Label for top side of the graph
+
+#### `bottom` (string, required)
+
+Label for bottom side of the graph
+
+#### `left` (string, required)
+
+Label for left side of the graph
+
+#### `right` (string, required)
+
+Label for right side of the graph
+
+### `padding` (boolean)
+
+Indicates if padding is enabled
+
+### `range` (object, required)
+
+Properties of the `range` object:
+
+#### `min` (number, required)
+
+Min value
+
+#### `max` (number, required)
+
+Max value
+
+#### `padding` (number, required)
+
+Padding value
+
+#### `step` (number, required)
+
+Step value
+
+#### `labelStep` (number, required)
+
+Label step value
+
+#### `axisLabel` (string, required)
+
+Axis Label
+
+### `standardGrid` (boolean)
+
+Indicates if some domain values will be synched to the range values
+
+### `title` (string)
+
+Indicates graph title
+
+## `Arrows` (object)
+
+Properties of the `Arrows` object:
+
+### `left` (boolean, required)
+
+Indicates if left arrow is enabled
+
+### `right` (boolean, required)
+
+Indicates if right arrow is enabled
+
+### `up` (boolean, required)
+
+Indicates if up arrow is enabled
+
+### `down` (boolean, required)
+
+Indicates if down arrow is enabled
+
+## `GraphSettings` (object)
+
+Properties of the `GraphSettings` object:
+
+### `min` (number, required)
+
+Min value
+
+### `max` (number, required)
+
+Max value
+
+### `padding` (number, required)
+
+Padding value
+
+### `step` (number, required)
+
+Step value
+
+### `labelStep` (number, required)
+
+Label step value
+
+### `axisLabel` (string, required)
+
+Axis Label
+
+## `Graph` (object)
+
+Properties of the `Graph` object:
+
+### `width` (number, required)
+
+Width for graph representation
+
+### `height` (number, required)
+
+Height for graph representation
+
+## `Labels` (object)
+
+Properties of the `Labels` object:
+
+### `top` (string, required)
+
+Label for top side of the graph
+
+### `bottom` (string, required)
+
+Label for bottom side of the graph
+
+### `left` (string, required)
+
+Label for left side of the graph
+
+### `right` (string, required)
+
+Label for right side of the graph
+
+## `LabelsConfigProp` (object)
+
+Properties of the `LabelsConfigProp` object:
+
+### `top` (string)
+
+Indicates the placeholder for the top label
+
+### `right` (string)
+
+Indicates the placeholder for the right label
+
+### `bottom` (string)
+
+Indicates the placeholder for the bottom label
+
+### `left` (string)
+
+Indicates the placeholder for the left label
 
 ### `settings` (boolean)
 
@@ -173,9 +955,13 @@ 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)
 
-## `ConfigureProp` (object)
+## `TitleConfigProp` (object)
 
-Properties of the `ConfigureProp` object:
+Properties of the `TitleConfigProp` object:
+
+### `placeholder` (string)
+
+Indicates the placeholder for the title label
 
 ### `settings` (boolean)
 
@@ -183,4 +969,25 @@ 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
+
+### `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