@pie-element/hotspot 11.1.1 → 11.1.2-next.1

package/docs/pie-schema.json.md

@@ -1,851 +0,0 @@
-Model for the @pie-elements/hotspot Interaction
-
-The schema defines the following properties:
-
-# `prompt` (string)
-
-The question prompt or item stem
-
-# `promptEnabled` (boolean)
-
-Indicates if the prompt is enabled
-
-# `imageUrl` (string)
-
-The image over which hotspots will be drawn
-
-# `shapes` (object, required)
-
-Properties of the `shapes` object:
-
-## `rectangles` (array, required)
-
-the rectangles of the shape
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-### `id` (string)
-
-the id of the rectangle
-
-### `correct` (boolean)
-
-indicates if the rectangle is correct
-
-### `height` (number, required)
-
-the height of the rectangle
-
-### `width` (number, required)
-
-the width of the rectangle
-
-### `x` (number, required)
-
-the x position of the rectangle
-
-### `y` (number, required)
-
-the y position of the rectangle
-
-## `polygons` (array, required)
-
-the polygons of the shape
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-### `id` (string)
-
-the id of the polygon
-
-### `correct` (boolean)
-
-indicates if the polygon is correct
-
-### `points` (array, required)
-
-the points of the polygon
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `x` (number, required)
-
-the x position
-
-#### `y` (number, required)
-
-the y position
-
-# `multipleCorrect` (boolean, required)
-
-Indicates if the item supports multiple correct answers
-
-# `partialScoring` (boolean, required)
-
-Indicates if the item should use partial scoring
-
-# `dimensions` (array, required)
-
-The dimensions of the drawable section
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-## `height` (number, required)
-
-the height of the section
-
-## `width` (number, required)
-
-the width of the section
-
-# `hotspotColor` (string)
-
-The color that fills the hotspot
-
-# `selectedHotspotColor` (string)
-
-The color that fills the hotspot
-
-# `hoverOutlineColor` (string)
-
-The color of the rectangular outline
-
-# `hotspotList` (array)
-
-The filling hotspot color options
-
-The object is an array with all elements of the type `string`.
-
-# `outlineColor` (string)
-
-The outline color of the hotspot
-
-# `outlineList` (array)
-
-The outline hotspot color options
-
-The object is an array with all elements of the type `string`.
-
-# `rationale` (string)
-
-Indicates the value for rationale
-
-# `rationaleEnabled` (boolean, required)
-
-Indicates if Rationale are enabled
-
-# `studentInstructionsEnabled` (boolean, required)
-
-Indicates if Student Instructions are enabled
-
-# `spellCheckEnabled` (boolean, required)
-
-Indicates if spellcheck is enabled for the author. Default value is true
-
-# `strokeWidth` (number, required)
-
-Indicates the width of the outline for a selection
-
-# `teacherInstructionsEnabled` (boolean, required)
-
-Indicates if Teacher Instructions are enabled
-
-# `toolbarEditorPosition` (string, enum)
-
-Indicates the editor's toolbar position which can be 'bottom' or 'top'
-
-This element must be one of the following enum values:
-
-* `bottom`
-* `top`
-
-Default: `": 'bottom'"`
-
-# `rubricEnabled` (boolean, required)
-
-Indicates if Rubric is enabled
-
-# `language` (string)
-
-Indicates the language of the component
-Supported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX
-
-# `fontSizeFactor` (number)
-
-Indicates font size adjustment factor
-
-# `autoplayAudioEnabled` (boolean)
-
-Indicates if the audio for the prompt should autoplay
-
-# `completeAudioEnabled` (boolean)
-
-Indicates if the audio should reach the end before the item can be marked as 'complete'
-
-# `customAudioButton` (object)
-
-Indicates if the audio should be replaced with a custom audio button
-  playImage: image url for the play state
-  pauseImage: image url for the pause state
-
-Properties of the `customAudioButton` object:
-
-## `playImage` (string, required)
-
-## `pauseImage` (string, required)
-
-# `id` (string, required)
-
-Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
-
-# `element` (string, required)
-
-The html Element tag name
-
----
-
-# Sub Schemas
-
-The schema defines the following additional types:
-
-## `EditableHtmlConfigureProp` (object)
-
-Properties of the `EditableHtmlConfigureProp` object:
-
-### `math` (object)
-
-Properties of the `math` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `audio` (object)
-
-Properties of the `audio` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `video` (object)
-
-Properties of the `video` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `image` (object)
-
-Properties of the `image` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `customPlugins` (array)
-
-An array of objects that determine custom plugins.
-A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `event` (string, required)
-
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-
-#### `iconAlt` (string, required)
-
-The alt for the custom button icon
-
-#### `iconType` (string, required)
-
-The icon type.
-Currently, only "SVG" is supported.
-
-#### `icon` (string, required)
-
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-
-### `blockquote` (object)
-
-Properties of the `blockquote` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `h3` (object)
-
-Properties of the `h3` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `characters` (object)
-
-Properties of the `characters` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `bold` (object)
-
-Properties of the `bold` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `html` (object)
-
-Properties of the `html` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `italic` (object)
-
-Properties of the `italic` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `ol_list` (object)
-
-Properties of the `ol_list` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `redo` (object)
-
-Properties of the `redo` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `strikethrough` (object)
-
-Properties of the `strikethrough` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `sub` (object)
-
-Properties of the `sub` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `sup` (object)
-
-Properties of the `sup` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `table` (object)
-
-Properties of the `table` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `ul_list` (object)
-
-Properties of the `ul_list` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `underline` (object)
-
-Properties of the `underline` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `undo` (object)
-
-Properties of the `undo` object:
-
-#### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-## `EditableHtmlButtonConfigure` (object)
-
-Properties of the `EditableHtmlButtonConfigure` object:
-
-### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-## `CustomPlugin` (object)
-
-Properties of the `CustomPlugin` object:
-
-### `event` (string, required)
-
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-
-### `iconAlt` (string, required)
-
-The alt for the custom button icon
-
-### `iconType` (string, required)
-
-The icon type.
-Currently, only "SVG" is supported.
-
-### `icon` (string, required)
-
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-
-## `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
-
-## `EditableHtmlPluginConfigureRequired` (object)
-
-Properties of the `EditableHtmlPluginConfigureRequired` object:
-
-### `inputConfiguration` (object)
-
-Properties of the `inputConfiguration` object:
-
-#### `math` (object)
-
-Properties of the `math` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `audio` (object)
-
-Properties of the `audio` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `video` (object)
-
-Properties of the `video` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `image` (object)
-
-Properties of the `image` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `customPlugins` (array)
-
-An array of objects that determine custom plugins.
-A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-##### `event` (string, required)
-
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-
-##### `iconAlt` (string, required)
-
-The alt for the custom button icon
-
-##### `iconType` (string, required)
-
-The icon type.
-Currently, only "SVG" is supported.
-
-##### `icon` (string, required)
-
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-
-#### `blockquote` (object)
-
-Properties of the `blockquote` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `h3` (object)
-
-Properties of the `h3` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `characters` (object)
-
-Properties of the `characters` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `bold` (object)
-
-Properties of the `bold` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `html` (object)
-
-Properties of the `html` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `italic` (object)
-
-Properties of the `italic` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `ol_list` (object)
-
-Properties of the `ol_list` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `redo` (object)
-
-Properties of the `redo` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `strikethrough` (object)
-
-Properties of the `strikethrough` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `sub` (object)
-
-Properties of the `sub` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `sup` (object)
-
-Properties of the `sup` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `table` (object)
-
-Properties of the `table` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `ul_list` (object)
-
-Properties of the `ul_list` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `underline` (object)
-
-Properties of the `underline` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-#### `undo` (object)
-
-Properties of the `undo` object:
-
-##### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-### `required` (boolean)
-
-Indicates if the item is required and the value cannot be empty
-
-### `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
-
-## `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
-
-## `ConfigureMathMLProp` (object)
-
-Properties of the `ConfigureMathMLProp` object:
-
-### `mmlOutput` (number)
-
-Indicates if model should have mathML output instead of latex
-
-### `mmlEditing` (number)
-
-Indicates if mathML that's already in model should be editable
-
-## `ConfigurePropWithEnabled` (object)
-
-Properties of the `ConfigurePropWithEnabled` object:
-
-### `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)
-
-### `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
-
-## `ConfigureLanguageOptionsProp` (object)
-
-Properties of the `ConfigureLanguageOptionsProp` object:
-
-### `value` (string, required)
-
-Value of the language option
-
-### `label` (string, required)
-
-Label of the language option
-
-## `Shape` (object)
-
-Properties of the `Shape` object:
-
-### `rectangles` (array, required)
-
-the rectangles of the shape
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `id` (string)
-
-the id of the rectangle
-
-#### `correct` (boolean)
-
-indicates if the rectangle is correct
-
-#### `height` (number, required)
-
-the height of the rectangle
-
-#### `width` (number, required)
-
-the width of the rectangle
-
-#### `x` (number, required)
-
-the x position of the rectangle
-
-#### `y` (number, required)
-
-the y position of the rectangle
-
-### `polygons` (array, required)
-
-the polygons of the shape
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `id` (string)
-
-the id of the polygon
-
-#### `correct` (boolean)
-
-indicates if the polygon is correct
-
-#### `points` (array, required)
-
-the points of the polygon
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-##### `x` (number, required)
-
-the x position
-
-##### `y` (number, required)
-
-the y position
-
-## `Rectangle` (object)
-
-Properties of the `Rectangle` object:
-
-### `id` (string)
-
-the id of the rectangle
-
-### `correct` (boolean)
-
-indicates if the rectangle is correct
-
-### `height` (number, required)
-
-the height of the rectangle
-
-### `width` (number, required)
-
-the width of the rectangle
-
-### `x` (number, required)
-
-the x position of the rectangle
-
-### `y` (number, required)
-
-the y position of the rectangle
-
-## `Polygon` (object)
-
-Properties of the `Polygon` object:
-
-### `id` (string)
-
-the id of the polygon
-
-### `correct` (boolean)
-
-indicates if the polygon is correct
-
-### `points` (array, required)
-
-the points of the polygon
-
-The object is an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `x` (number, required)
-
-the x position
-
-#### `y` (number, required)
-
-the y position
-
-## `Point` (object)
-
-Properties of the `Point` object:
-
-### `x` (number, required)
-
-the x position
-
-### `y` (number, required)
-
-the y position
-
-## `Dimension` (object)
-
-Properties of the `Dimension` object:
-
-### `height` (number, required)
-
-the height of the section
-
-### `width` (number, required)
-
-the width of the section