Skip to content

URL Parameters and Modes

Jump to bottom
William Finzer edited this page Jan 22, 2024 · 14 revisions

CODAP makes use of a number of URL parameters to cause actions to take place or to enter certain modes.

General

The following query parameters may be useful or may once have been useful for general users. Those that are no longer useful have been marked "deprecated".

  • componentMode -- Opens a CODAP document without a navigational bar or file manager bar with the scope of the display narrowed to a single component. It is used to present a single CODAP graph or table in an IFrame in an HTML document.
  • di -- Opens codap with a ("data interactive") plugin as specified by the URL that is the value of the parameter.
  • di-override -- Takes a string value that specifies the name (or part of the name) of data interactive in the CODAP document to replace. It is used in conjunction with the di param, which specifies the data interactive to load in place of the named one using the di-override param.
  • embeddedMode, embeddedServer Opens CODAP with no file manager bar with optional capability to communicate with the hosting page. Intended to be used to embed CODAP in a page of lesson sequence.
  • gaussianFit -- When a histogram is showing, replaces the Normal Curve option with Gaussian Fit.
  • guideIndex -- Opens a CODAP document with specific Guide Page made visible.
  • ICI -- Makes available a boxplot option to display an "informal confidence interval" as used in New Zealand's secondary mathematics curriculum.
  • inbounds -— When opening a CODAP document, makes sure that all components are positioned within the visible workspace without scrolling.
  • standalone -- Opens CODAP in standalone mode. This mode is one of the ways of using the features of CODAP with CODAP in a subordinate role. A plugin is made to occupy the entire CODAP workspace. CODAP graphs, tables, and other components can be opened and positioned where the standalone plugin desires.
  • url -- Opens a CODAP Document or CSV document as specified by URL that is the value of the parameter.
  • app(deprecated): Enabled specific specially built features.
  • moreGames(deprecated): an older way to open CODAP with a plugin. Replaced by the di query parameter.

Developer

The following query parameters are intended to facilitate development of CODAP features or plugins.

  • boundarySpec: specifies the URL of an alternate index file for standard Boundary files.
  • cfmBaseURL: specifies the URL of an alternate file manager library.
  • exampleURL: specifies the URL of an alternate index file for CODAP example documents.
  • hideSplashScreen: if "true", omits display of splash screen when CODAP opens.
  • hideUndoRedoInComponent: In certain modes, undo and redo buttons are displayed in component title bars. Suppresses this.
  • hideWebViewLoading: TBD
  • pluginURL: specifies the URL of an alternate index file for standard CODAP plugins.
Clone this wiki locally