Create the PhET-iO Examples

[KatieWoe]

A bit late, but for phetsims/qa#798. Noticed during a more recent phet-io test.

In studio there are two links (PhET-iO Guide, and Examples) that don't lead to anything. These links are on the right hand side of Studio.

[amanda-phet]

My guess is that these don't work because we didn't create this documentation! @catherinecarter will probably be the one to do that when this sim gets published :)

[catherinecarter]

Making a checklist of things to remember to include in examples.md:

All screens

• Get and set an array of balls to be placed (magically without kicking) at specific locations on the number line (Need an easy way to get the array of all current ball position values for what’s visible in the scene #259)
  • two types of arrays: one has 15 places in it, and the user sets the number of balls at each of the 15 locations on the number line. Second is to list the positions of each kick and what number line value for where you want the ball to land
• Choose from a list of pre-set frequency distributions: skewed right/left, unimodal and symmetric (large/small spread), uniform, top hat, bimodal
  • note: these are frequency distributions. the probabilities are calculated in the code
• Customize the name of the screens, the accordion box labels, and the question at the top
• Customize checkbox labels, such as changing mean to average
• Visible and enabled properties on all checkboxes, the accordion box, the question, the balls on the whole, each individual ball
• Accordion box will shift upwards when the question bar is hidden
• Change location of cueing arrow on balls (all screens)
• refer to this for language to put in examples.md centerAndVariability.medianScreen.model.sceneModel.kickDistributionStrategy
• put how to find the visibility of the mean/median readouts in the accordion box for screens 1/2 since the strings are not instrumented
• soccerBallValueProperty - write that this will have a value if the ball is active on the field. Otherwise, this will be null.
• add documentation to indicate the drag indicator on the soccer balls will be buggy if visibleProperty is turned on before the last kick is kicked or before any balls have been kicked

Median Screen

• Can listen to an indicator telling whether the cards (Median screen) have been sorted or not
• Set the location of the predict median slider
• even though maxKicks can be set to any value from 5-30 in increments of 5, Median screen has a max of 15
• add documentation for listening for students manually sorted (hide checkbox), then listen to areCardsSortedProperty = true
• Be able to hide a card on Median Screen - no longer supporting
• For the cards, include a "null" which will show a number, and create "alternative text" if not null for a client to customize the card contents, such as A or something else in case they want to hide the value, or put a "?" - no longer supporting

Mean & Median Screen

• Visible and enabled properties for the mean/median indicators
• Set the location of the predict sliders (mean/median)
• Be able to hide the data points in the accordion box

Variability Screen

• hide the drag handles of the interval tool, one or both
• get the location of each handle of the interval tool (if width is desired, encourage client to calculate)
• visible/enabled properties for one or more radio buttons for measures of spread
• visible/enabled properties for info button
• set distribution for each player
• be able to hide the data points in the accordion box

[samreid]

To show the card hand drag indicator centerAndVariability.medianScreen.model.distanceAccordionBox.cardContainerModel.cardDragIndicatorProperty 'setValue`

  "phetioID": "centerAndVariability.medianScreen.model.distanceAccordionBox.cardContainerModel.cards.card1"
}

[samreid]

I feel the design and API has stabilized to a point where this issue and #151 can be worked on. I'll remove the hold.

[samreid]

New command to get the cards in order await phetioClient.invokeAsync('centerAndVariability.medianScreen.model.distanceAccordionBox.cardContainerModel','getData')

[catherinecarter]

@arouinfar checked the examples file, and confirmed all looks good. Closing.