Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 9.8 KB

readme.md

File metadata and controls

97 lines (62 loc) · 9.8 KB

pie-player

The pie-player component will load pie content for rendering.

Showing a Loader

This component loads the bundled JS assets from the build service. While these assets are loading The class pie-loading will be added to the element while assets are being loaded from the server.

Notes

hosted property / attribute

| false | true
|BundleType = clientPlayer(has controller) | BundleType = player
|uses elements controllers when env changes | hosted by hosting system, only does pieEl.model = model calls controller.model to initialise pieEl.model |generates bundle urls based on current items config | use bundle url from item config if set

renderStimulus property / attribute

This has effect when we load stimulus items (items that contain passage in config) and is set to true. It is a corner case where we load two instances of . One for passage and one for the other items.

If there are elements in our item config that share the same bundle url, the bundle is loaded in webpage only once for perfomance reasons. (check pie-loader.ts, loadCloudPies method) If pie-player is used from api-components we will always have a separate bundle for passage and a separate bundle for items PD-4664

Properties

Property Attribute Description Type Default
addCorrectResponse add-correct-response Simulates a correct response for the item. This property will only have this effect if the hosted property is false and player is running client-side-only. boolean false
bundleEndpoints -- Provide this property override the default endpoints used by the player to retrieve JS bundles. Must be set before setting the config property. Most users will not need to use this property. BundleEndpoints undefined
bundleHost bundle-host Optionally specifies the back-end that builds and hosts javascript bundles for rendering assessment items. This property lets you choose which environment to use, from 'dev' , 'stage' or 'prod' environments. Until 1.0 will default to 'stage'. Starting v2.0.3, it will temporarily redirect to production only string undefined
config -- The Pie config model. AdvancedItemConfig | PieContent undefined
disableBundler disable-bundler Allows disabling of the default behaviour which is to look up and load the JS bundle that define the Custom Elements used by the item config. This if for advanced use cases when using the pie-player in a container that is managing loading of Custom Elements and Controllers. boolean false
env -- Describes runtime environment for the player. Object { mode: "gather", role: "student" }
hosted hosted Indicates if player running in the context of a PIE hosting system. Do not modify the default value for this property if you are not implementing a PIE host. If true, the host is responsible for all model updates. boolean false
renderStimulus render-stimulus If the item contains a stimulus, the player will render it by default. Set this property to false to not render stimulus. boolean true
session -- The Pie Session { id: string; data: any[]; } { id: "", data: [] }
version version string VERSION

Events

Event Description Type
load-complete Emitted when the content in the config has been loaded. CustomEvent<any>
player-error Emmitted if there is an error encountered while rendering. event.detail will be a string containing a message about the error. CustomEvent<any>
responseCompleted TODO - Emmitted when any all interactions in a PIE Assessment Item have reported that a user has provided a response to the interaction. CustomEvent<any>
session-changed Emmitted when any interaction in the set of interactions being rendered has been mutated by user action. The Event.detail property contains a complete property. If true, this indicates that enough data has been gathered by the interaciton to constitute a response. For example, in a plot line questsion where a user had to plot three points to plot the line, the complete propery would be false if 1 or 2 points had been added, but true if all three had. CustomEvent<any>

Methods

updateElementModel(update: PieModel) => Promise<void>

For previewing changes to an item. Updates the model for one question in the item model.

Returns

Type: Promise<void>

Dependencies

Used by

Depends on

Graph

graph TD;
  pie-player --> pie-player
  pie-preview-layout --> pie-player
  style pie-player fill:#f9f,stroke:#333,stroke-width:4px
Loading

Built with StencilJS