@pie-element/graphing 3.4.19-next.85 → 3.5.1-beta.587

package/docs/pie-schema.json.md

@@ -40,9 +40,25 @@ Additional restrictions:
 
 * Minimum items: `1`
 
-# `arrows` (boolean)
+# `arrows` (object)
 
-Indicates if arrows are enabled
+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
 
 # `backgroundMarks` (array, required)
 
@@ -52,6 +68,26 @@ Additional restrictions:
 
 * Minimum items: `1`
 
+# `coordinatesOnHover` (boolean)
+
+Indicates if coordinates of a point are displayed on hover
+
+# `defaultTool` (string, enum, required)
+
+Indicates the default selected tool for the graph
+
+This element must be one of the following enum values:
+
+* `circle`
+* `line`
+* `parabola`
+* `point`
+* `polygon`
+* `ray`
+* `segment`
+* `sine`
+* `vector`
+
 # `domain` (object, required)
 
 Properties of the `domain` object:
@@ -92,6 +128,10 @@ Width for graph representation
 
 Height for graph representation
 
+# `includeAxes` (boolean)
+
+Indicates if the graph axes and labels are enabled
+
 # `labels` (object)
 
 Properties of the `labels` object:
@@ -177,6 +217,14 @@ Indicates teacher instructions
 
 Indicates graph title
 
+# `labelsEnabled` (boolean)
+
+Indicates if the graph labels are displayed
+
+# `titleEnabled` (boolean)
+
+Indicates if the graph title is displayed
+
 # `toolbarTools` (array)
 
 Indicates the tools that have to be displayed in toolbar
@@ -189,6 +237,14 @@ Additional restrictions:
 
 Indicates if Rationale are enabled
 
+# `spellCheckEnabled` (boolean, required)
+
+Indicates if spellcheck is enabled for the author. Default value is true
+
+# `standardGrid` (boolean)
+
+Indicates if some domain values will be synched to the range values
+
 # `studentInstructionsEnabled` (boolean, required)
 
 Indicates if Student Instructions are enabled
@@ -197,6 +253,10 @@ Indicates if Student Instructions are enabled
 
 Indicates if Teacher Instructions are enabled
 
+# `rubricEnabled` (boolean, required)
+
+Indicates if Rubric is enabled
+
 # `id` (string, required)
 
 Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
@@ -211,9 +271,105 @@ The html Element tag name
 
 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 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)
+
+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)
 
@@ -223,10 +379,45 @@ 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)
+### `left` (object)
 
-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)
+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)
 
@@ -240,157 +431,185 @@ 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
 
-## `Answer` (object)
+## `DimensionsConfigProp` (object)
 
-Properties of the `Answer` object:
+Properties of the `DimensionsConfigProp` object:
 
-### `name` (string, required)
+### `settings` (boolean)
 
-Indicates name of answer
+Indicates if the item has to be displayed in the Settings Panel
 
-### `marks` (array, required)
+### `label` (string)
 
-Indicates marks for the answer
+Indicates the label for the item that has to be displayed in the Settings Panel
 
-Additional restrictions:
+### `enabled` (boolean)
 
-* Minimum items: `1`
+Indicates if the graph dimensions are included in the Grid Setup Panel
 
-## `Mark` (object)
+### `min` (number)
 
-Properties of the `Mark` object:
+Indicates the minimum value for the graph width and height
 
-### `type` (string, enum, required)
+### `max` (number)
 
-Indicates type of mark
+Indicates the maximum value for the graph width and height
 
-This element must be one of the following enum values:
+### `step` (number)
 
-* `circle`
-* `line`
-* `parabola`
-* `point`
-* `polygon`
-* `ray`
-* `segment`
-* `sine`
-* `vector`
+Indicates the increase/decrease value for the graph width and height
 
-### `showLabel` (boolean)
+## `GridConfigurationsProp` (object)
 
-Indicates if label should be visible
+Properties of the `GridConfigurationsProp` object:
 
 ### `label` (string)
 
-Indicates label value for mark
+Indicates the label for the configuration
 
-### `building` (boolean, required)
+### `arrows` (object)
 
-Indicates if mark is in build process
+Properties of the `arrows` object:
 
-### `x` (number)
+#### `left` (boolean, required)
 
-Indicates x coordinate if type is point
+Indicates if left arrow is enabled
 
-### `y` (number)
+#### `right` (boolean, required)
 
-Indicates y coordinate if type is point
+Indicates if right arrow is enabled
 
-### `from` (object)
+#### `up` (boolean, required)
 
-Properties of the `from` object:
+Indicates if up arrow is enabled
 
-#### `x` (number, required)
+#### `down` (boolean, required)
 
-Indicates x coordinate
+Indicates if down arrow is enabled
 
-#### `y` (number, required)
+### `domain` (object, required)
 
-Indicates y coordinate
+Properties of the `domain` object:
 
-### `to` (object)
+#### `min` (number, required)
 
-Properties of the `to` object:
+Min value
 
-#### `x` (number, required)
+#### `max` (number, required)
 
-Indicates x coordinate
+Max value
 
-#### `y` (number, required)
+#### `padding` (number, required)
 
-Indicates y coordinate
+Padding value
 
-### `center` (object)
+#### `step` (number, required)
 
-Properties of the `center` object:
+Step value
 
-#### `x` (number, required)
+#### `labelStep` (number, required)
 
-Indicates x coordinate
+Label step value
 
-#### `y` (number, required)
+#### `axisLabel` (string, required)
 
-Indicates y coordinate
+Axis Label
 
-### `outerPoint` (object)
+### `graph` (object, required)
 
-Properties of the `outerPoint` object:
+Properties of the `graph` object:
 
-#### `x` (number, required)
+#### `width` (number, required)
 
-Indicates x coordinate
+Width for graph representation
 
-#### `y` (number, required)
+#### `height` (number, required)
 
-Indicates y coordinate
+Height for graph representation
 
-### `closed` (boolean)
+### `includeAxes` (boolean)
 
-Indicates if mark is closed if type is polygon, sine
+Indicates if the graph axes and labels are enabled
 
-### `points` (array)
+### `labels` (object)
 
-Indicates all mark's points if type is polygon
+Properties of the `labels` object:
 
-Additional restrictions:
+#### `top` (string, required)
 
-* Minimum items: `1`
+Label for top side of the graph
 
-### `root` (object)
+#### `bottom` (string, required)
 
-Properties of the `root` object:
+Label for bottom side of the graph
 
-#### `x` (number, required)
+#### `left` (string, required)
 
-Indicates x coordinate
+Label for left side of the graph
 
-#### `y` (number, required)
+#### `right` (string, required)
 
-Indicates y coordinate
+Label for right side of the graph
 
-### `edge` (object)
+### `padding` (boolean)
 
-Properties of the `edge` object:
+Indicates if padding is enabled
 
-#### `x` (number, required)
+### `range` (object, required)
 
-Indicates x coordinate
+Properties of the `range` object:
 
-#### `y` (number, required)
+#### `min` (number, required)
 
-Indicates y coordinate
+Min value
 
-## `Point` (object)
+#### `max` (number, required)
 
-Properties of the `Point` object:
+Max value
 
-### `x` (number, required)
+#### `padding` (number, required)
 
-Indicates x coordinate
+Padding value
 
-### `y` (number, required)
+#### `step` (number, required)
 
-Indicates y coordinate
+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)
 
@@ -450,4 +669,202 @@ Label for left side of the graph
 
 ### `right` (string, required)
 
-Label for right side of the graph
+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)
+
+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)
+
+## `TitleConfigProp` (object)
+
+Properties of the `TitleConfigProp` object:
+
+### `placeholder` (string)
+
+Indicates the placeholder for the title label
+
+### `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
+
+## `Answer` (object)
+
+Properties of the `Answer` object:
+
+### `name` (string, required)
+
+Indicates name of answer
+
+### `marks` (array, required)
+
+Indicates marks for the answer
+
+Additional restrictions:
+
+* Minimum items: `1`
+
+## `Mark` (object)
+
+Properties of the `Mark` object:
+
+### `type` (string, enum, required)
+
+Indicates type of mark
+
+This element must be one of the following enum values:
+
+* `circle`
+* `line`
+* `parabola`
+* `point`
+* `polygon`
+* `ray`
+* `segment`
+* `sine`
+* `vector`
+
+### `showLabel` (boolean)
+
+Indicates if label should be visible
+
+### `label` (string)
+
+Indicates label value for mark
+
+### `building` (boolean, required)
+
+Indicates if mark is in build process
+
+### `x` (number)
+
+Indicates x coordinate if type is point
+
+### `y` (number)
+
+Indicates y coordinate if type is point
+
+### `from` (object)
+
+Properties of the `from` object:
+
+#### `x` (number, required)
+
+Indicates x coordinate
+
+#### `y` (number, required)
+
+Indicates y coordinate
+
+### `to` (object)
+
+Properties of the `to` object:
+
+#### `x` (number, required)
+
+Indicates x coordinate
+
+#### `y` (number, required)
+
+Indicates y coordinate
+
+### `closed` (boolean)
+
+Indicates if mark is closed if type is polygon, sine
+
+### `points` (array)
+
+Indicates all mark's points if type is polygon
+
+Additional restrictions:
+
+* Minimum items: `1`
+
+### `root` (object)
+
+Properties of the `root` object:
+
+#### `x` (number, required)
+
+Indicates x coordinate
+
+#### `y` (number, required)
+
+Indicates y coordinate
+
+### `edge` (object)
+
+Properties of the `edge` object:
+
+#### `x` (number, required)
+
+Indicates x coordinate
+
+#### `y` (number, required)
+
+Indicates y coordinate
+
+## `Point` (object)
+
+Properties of the `Point` object:
+
+### `x` (number, required)
+
+Indicates x coordinate
+
+### `y` (number, required)
+
+Indicates y coordinate