Exhibit/API/2.2.0/Exhibit

From SIMILE Widgets
Jump to: navigation, search

Predefined variables

These can be set by the user before Exhibit is loaded.

  • Exhibit_isCompiled (boolean): Deprecated.
  • Exhibit_urlPrefix (String): Where Exhibit should look to continue loading itself; usually set automatically, setting this will short circuit autosetting.
  • Exhibit_parameters (Object): Default parameter values, see next section

Parameters

Used in the containing page URL:

  • exhibit-use-local-resources (takes no value): Look to a locally running service regardless of where exhibit-api is loaded from

Used in script tag URL:

  • bundle (boolean; true): Use the one-file compressed version of Exhibit instead of loading all files
  • safe (boolean; false): Prevent any scripting present in the data from being injected into the display
  • debug (boolean; undefined): Turn on Exhibit debugging
  • autoCreate (boolean; true): Automatically load Exhibit when the page is loaded
  • js (String Array; empty array): Load the listed scripts before loading Exhibit, URLs relative to the page
  • css (String Array; empty array): Load the listed styles before loading Exhibit, URLs relative to the page
  • locale (String - any valid locale; undefined): Force usage of the provided locale
  • gmapkey (String - any valid Google API key; undefined): Use this key when loading Google Maps. Should be deprecated, Google no longer requires a key
  • views (String - "map" or "timeline"; undefined): Load the scripts associated with these extension views
  • callback (String - function name; undefined): Run this function instead of the normal Exhibit auto-creation method. Should be deprecated in favor of listening for an event

Non-canonical

Used in the containing page URL:

  • exhibit-no-authentication (takes no value)

Used in script tag URL:

  • log (boolean; undefined)
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox