API Docs for: 0.5.1
Show:

ExpFrameBase Class

Defined in: addon/components/exp-frame-base/component.js:10
Module: frames
Parent Module: exp-player

This provides common base behavior required for any experiment frame. All experiment frames must extend this one. This frame has no configuration options because all of its logic is internal, and is almost never directly used in an experiment. It exports no data. Sample experiment definition usage (provided for completeness):

  "frames": {
     "my-sample-frame": {
       "kind": "exp-base-frame"
     }
  }

As a user you will almost never need to insert a component into a template directly- the platform should handle that by automatically inserting exp-player when your experiment starts. However, a sample template usage is provided below for completeness.

  {{
      component currentFrameTemplate
        frameIndex=frameIndex
        framePage=framePage
        updateFramePage=(action 'updateFramePage')
        frameConfig=currentFrameConfig
        frameContext=currentFrameContext
       session=session
        experiment=experiment
       next=(action 'next')
        previous=(action 'previous')
        saveHandler=(action 'saveFrame')
        skipone=(action 'skipone')
        sessionCompleted=(action 'sessionCompleted')
       extra=extra
    }}

Item Index

Methods

Events

Methods

serializeContent

(
  • eventTimings
)
Object

Defined in addon/components/exp-frame-base/component.js:168

The base class does not define any data to save to the server. It does, however, capture some basic event timing data. (such as when the user clicks the "next" button)

This section slightly breaks YUIDoc conventions- rather than being a literal guide to using the code, the "parameters" here are abstract descriptions of what data is captured.

Each frame that extends ExpFrameBase will send an array eventTimings back to the server upon completion. This array is an ordered list (oldest to newest) of every EVENT that happened during the frame. Each event is represented as an object with at least the properties {'eventType': EVENTNAME, 'timestamp': TIMESTAMP}. Frame-specific events may define additional properties that are sent.

Parameters:

Returns:

Object:

Events

nextFrame

Defined in addon/components/exp-frame-base/component.js:214

Move to next frame