@pie-element/complex-rubric 0.0.2-next.4424

package/docs/pie-schema.json.md

@@ -0,0 +1,660 @@
+Model for the ComplexRubricPie Interaction
+
+The schema defines the following properties:
+
+# `rubricType` (string, enum, required)
+
+This element must be one of the following enum values:
+
+* `multiTraitRubric`
+* `simpleRubric`
+
+# `rubrics` (object, required)
+
+Properties of the `rubrics` object:
+
+## `simpleRubric` (object, required)
+
+Model for the RubricPie Interaction
+
+Properties of the `simpleRubric` object:
+
+### `points` (array)
+
+Indicates the score points labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+### `sampleAnswers` (array)
+
+Indicates the sample answers labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+### `maxPoints` (number)
+
+Indicates the max limit for scoring points
+
+### `excludeZeros` (boolean)
+
+Indicates if point 0 should be shown
+
+### `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
+
+## `multiTraitRubric` (object, required)
+
+Model for the MultiTraitRubric Interaction
+
+Properties of the `multiTraitRubric` object:
+
+### `halfScoring` (boolean)
+
+Indicates if half scoring is enabled
+
+### `pointLabels` (boolean)
+
+Indicates if point labels should be shown
+
+### `visibleToStudent` (boolean)
+
+Indicates if should be visible to student
+
+### `description` (boolean)
+
+Indicates if description should be shown
+
+### `standards` (boolean)
+
+Indicates if standards should be shown
+
+### `excludeZero` (boolean)
+
+Indicates if scoring should start at 0 or 1
+
+### `spellCheckEnabled` (boolean, required)
+
+Indicates if spellcheck is enabled for the author. Default value is true
+
+### `scales` (array, required)
+
+scales
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `maxPoints` (number, required)
+
+Indicates max limit for scoring points
+
+#### `scorePointsLabels` (array, required)
+
+Score labels. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+#### `traitLabel` (string, required)
+
+Trait label
+
+#### `traits` (array, required)
+
+Traits
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+##### `name` (string, required)
+
+Trait name
+
+##### `standards` (array, required)
+
+Trait standards
+
+The object is an array with all elements of the type `string`.
+
+##### `description` (string, required)
+
+Trait description
+
+##### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+### `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
+
+# `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:
+
+## `MultiTraitRubricConfigure` (object)
+
+Config Object for @pie-elements/multi-trait-rubric
+
+Properties of the `MultiTraitRubricConfigure` object:
+
+### `excludeZeroDialogBoxContent` (object)
+
+Properties of the `excludeZeroDialogBoxContent` object:
+
+#### `title` (string)
+
+Dialog box title
+
+#### `text` (string)
+
+Dialog box text
+
+### `includeZeroDialogBoxContent` (object)
+
+Properties of the `includeZeroDialogBoxContent` object:
+
+#### `title` (string)
+
+Dialog box title
+
+#### `text` (string)
+
+Dialog box text
+
+### `deleteTraitDialogBoxContent` (object)
+
+Properties of the `deleteTraitDialogBoxContent` object:
+
+#### `title` (string)
+
+Dialog box title
+
+#### `text` (string)
+
+Dialog box text
+
+### `deleteScaleDialogBoxContent` (object)
+
+Properties of the `deleteScaleDialogBoxContent` object:
+
+#### `title` (string)
+
+Dialog box title
+
+#### `text` (string)
+
+Dialog box text
+
+### `maxPointsDialogBoxContent` (object)
+
+Properties of the `maxPointsDialogBoxContent` object:
+
+#### `title` (string)
+
+Dialog box title
+
+#### `text` (string)
+
+Dialog box text
+
+### `showExcludeZero` (object)
+
+Properties of the `showExcludeZero` 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
+
+### `showScorePointLabels` (object)
+
+Properties of the `showScorePointLabels` 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
+
+### `showDescription` (object)
+
+Properties of the `showDescription` 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
+
+### `showVisibleToStudent` (object)
+
+Properties of the `showVisibleToStudent` 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
+
+### `showHalfScoring` (object)
+
+Properties of the `showHalfScoring` 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
+
+### `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
+
+### `width` (string, required)
+
+How large (in px) should multi-trait-rubric be
+
+## `DialogContent` (object)
+
+Properties of the `DialogContent` object:
+
+### `title` (string)
+
+Dialog box title
+
+### `text` (string)
+
+Dialog box text
+
+## `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
+
+## `RubricType` (string)
+
+## `RubricModels` (object)
+
+Properties of the `RubricModels` object:
+
+### `simpleRubric` (object, required)
+
+Model for the RubricPie Interaction
+
+Properties of the `simpleRubric` object:
+
+#### `points` (array)
+
+Indicates the score points labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `sampleAnswers` (array)
+
+Indicates the sample answers labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `maxPoints` (number)
+
+Indicates the max limit for scoring points
+
+#### `excludeZeros` (boolean)
+
+Indicates if point 0 should be shown
+
+#### `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
+
+### `multiTraitRubric` (object, required)
+
+Model for the MultiTraitRubric Interaction
+
+Properties of the `multiTraitRubric` object:
+
+#### `halfScoring` (boolean)
+
+Indicates if half scoring is enabled
+
+#### `pointLabels` (boolean)
+
+Indicates if point labels should be shown
+
+#### `visibleToStudent` (boolean)
+
+Indicates if should be visible to student
+
+#### `description` (boolean)
+
+Indicates if description should be shown
+
+#### `standards` (boolean)
+
+Indicates if standards should be shown
+
+#### `excludeZero` (boolean)
+
+Indicates if scoring should start at 0 or 1
+
+#### `spellCheckEnabled` (boolean, required)
+
+Indicates if spellcheck is enabled for the author. Default value is true
+
+#### `scales` (array, required)
+
+scales
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+##### `maxPoints` (number, required)
+
+Indicates max limit for scoring points
+
+##### `scorePointsLabels` (array, required)
+
+Score labels. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+##### `traitLabel` (string, required)
+
+Trait label
+
+##### `traits` (array, required)
+
+Traits
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+###### `name` (string, required)
+
+Trait name
+
+###### `standards` (array, required)
+
+Trait standards
+
+The object is an array with all elements of the type `string`.
+
+###### `description` (string, required)
+
+Trait description
+
+###### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+#### `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
+
+## `RubricPie` (object)
+
+Model for the RubricPie Interaction
+
+Properties of the `RubricPie` object:
+
+### `points` (array)
+
+Indicates the score points labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+### `sampleAnswers` (array)
+
+Indicates the sample answers labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+### `maxPoints` (number)
+
+Indicates the max limit for scoring points
+
+### `excludeZeros` (boolean)
+
+Indicates if point 0 should be shown
+
+### `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
+
+## `MultiTraitRubricPie` (object)
+
+Model for the MultiTraitRubric Interaction
+
+Properties of the `MultiTraitRubricPie` object:
+
+### `halfScoring` (boolean)
+
+Indicates if half scoring is enabled
+
+### `pointLabels` (boolean)
+
+Indicates if point labels should be shown
+
+### `visibleToStudent` (boolean)
+
+Indicates if should be visible to student
+
+### `description` (boolean)
+
+Indicates if description should be shown
+
+### `standards` (boolean)
+
+Indicates if standards should be shown
+
+### `excludeZero` (boolean)
+
+Indicates if scoring should start at 0 or 1
+
+### `spellCheckEnabled` (boolean, required)
+
+Indicates if spellcheck is enabled for the author. Default value is true
+
+### `scales` (array, required)
+
+scales
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `maxPoints` (number, required)
+
+Indicates max limit for scoring points
+
+#### `scorePointsLabels` (array, required)
+
+Score labels. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+#### `traitLabel` (string, required)
+
+Trait label
+
+#### `traits` (array, required)
+
+Traits
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+##### `name` (string, required)
+
+Trait name
+
+##### `standards` (array, required)
+
+Trait standards
+
+The object is an array with all elements of the type `string`.
+
+##### `description` (string, required)
+
+Trait description
+
+##### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+### `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
+
+## `Scale` (object)
+
+Properties of the `Scale` object:
+
+### `maxPoints` (number, required)
+
+Indicates max limit for scoring points
+
+### `scorePointsLabels` (array, required)
+
+Score labels. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+### `traitLabel` (string, required)
+
+Trait label
+
+### `traits` (array, required)
+
+Traits
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `name` (string, required)
+
+Trait name
+
+#### `standards` (array, required)
+
+Trait standards
+
+The object is an array with all elements of the type `string`.
+
+#### `description` (string, required)
+
+Trait description
+
+#### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+## `Trait` (object)
+
+Properties of the `Trait` object:
+
+### `name` (string, required)
+
+Trait name
+
+### `standards` (array, required)
+
+Trait standards
+
+The object is an array with all elements of the type `string`.
+
+### `description` (string, required)
+
+Trait description
+
+### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.