API reference

You can use the following URL parameters when addressing to eSeeCode to customize its appearance:

• grid
  Display or hide the grid
  Valid values: true|yes|1, false|no|0
• gridstep
  Pixels between lines in the grid
  Valid values: Any number >= 1
• griddivisions
  Number of lines in the grid
  Valid values: Any number >= 0
• guide
  Display or hide the guide
  Valid values: true|yes|1, false|no|0
• guideimage
  Image to display instead of the default guide
  Valid values: Relative path file or URL
• guidesize
  Size in pixels of the guide Valid values: Any number >= 0
• background
  Image to display as background in all layers Valid values: Relative path or URL
• viewtabs
  Which views to display
  Valid values: Comma separated list of views (amount "touch", "drag", "build" and "code")
• filemenu
  Display or hide the filemenu
  Valid values: true|yes|1, false|no|0
• lang
  Language to load into the interface
  Valid values: language code (ie. ca, es, en)
• translations
  Display or hide the translations menu
  Valid values: true|yes|1, false|no|0
• theme
  Switch active theme
  Valid values: Installed theme name
• themes
  Display or hide the theme sleector
  Valid values: true|yes|1, false|no|0
• maximize
  Maximize the code console
  Valid values: true|yes|1, false|no|0
• style
  Style of blocks display
  Valid values: blocks, flow
• styletabs
  Display or hide the blocks style selector
  Valid values: true|yes|1, false|no|0
• multiselect
  Display or hide the blocks multiselect toggle
  Valid values: true|yes|1, false|no|0
• input
  Text to load into the input (in I/O)
  Valid values: any text
• axis
  Seconds to wait for the program to complete its execution
  Valid values: name or index of the predefined axis systems (ie. "Computer console", "Mathematical simple", "Mathematical centered")
• view
  Initial view to load
  Valid values: Name or index of a view (ie. "touch", "drag", "build", "code")
• dialog
  Initial dialog tab to display
  Valid values: Name or index of a dialog (ie. "debug", "io", "pieces", "setup")
• instructions
  Instructions to load in the dialog window (all other instructions will be hidden)
  Valid values: instruction1Name;parameter1Value;parameter2Value;...;Instructions2Name;...
• custominstructions
  Sets definitions of custom instructions
  Valid values: JSON or object defining an instruction using set.js structure plus an optional "run" property with the body of the function code and an "icon" property with the URL or relative path of the icon representing the instruction
• forceblocksetup
  Sets if block setup is forced in Drag mode
  Valid values: true|yes|1, false|no|0
• blocksetup
  Sets the default block setup style
  Valid values: "visual" or "text"
• basepath
  Sets the base path for loading images and sounds
  Valid values: Relative path or URL
• fullscreenmenu
  Display or hide the fullscreen button
  Valid values: true|yes|1, false|no|0
• preventexit
  Prevent or not to leave the page without confirmation
  Valid values: true|yes|1, false|no|0
• precode
  Hidden code to run always before the user's code
  Valid values: *
• postcode
  Hidden code to run always after the user's code
  Valid values: *
• code
  Code to load to be user's initial code
  Valid values: *
• execute
  Immediately execute the code once loaded
  Valid values: "visual" or "text"
• delay
  Delay between running two instructions when running the user's code (in milliseconds)
  Valid values: Any value >= 0
• pause
  Pause between the end of an instruction and the next instruction when running the user's code (in milliseconds)
  Valid values: Any value >= 0
• autosave
  Interval in which to autosave code (in seconds). 0 to disable
  Valid values: Any value >= 0
• autosaveexpire
  Time after which an autosaved code will not be restored (in seconds). 0 to never expire
  Valid values: Any value >= 0
• autorestore
  Restore the last autosaved code
  Valid values: true|yes|1, false|no|0
• exercise
  Id of the exercise so only autosaved code for this exercise will be restored
  Valid values: true|yes|1, false|no|0
• step
  Display or hide the step execution buttons
  Valid values: true|yes|1, false|no|0
• stepsize
  Number of instructions to run on each step execution
  Valid values: "visual" or "text"
• breakpoints
  Breakpoints to pause execution when a code line is reached or a variable has changed is value
  Valid values: Comma separated list of code line numbers and/or variables names
• watches
  Variables to monitor in the debug dialog to see changes in their values
  Valid values: Comma separated list of variables names
• whiteboardresolution
  Height & width of the whiteboard
  Valid values: Any value >= 0

 

Additionally, you can use the following JavaScript functions to interact with eSeeCode. You may do so through the postMessage method: