API Docs for: 1.0.0
Show:

TAG_embed Class

Defined in: LADS/TAG-embed.js:1

The end user should include this file in their website. Calling TAG_embed with the appropriate inputs will create the TAG embedding in an iframe, using the demo.html file as the iframe source.

Constructor

TAG_embed

(
  • tagInput
  • path
  • containerId
  • serverIp
  • width
  • height
  • allowServerChange
  • hiddenCollections
)

Defined in LADS/TAG-embed.js:1

Parameters:

  • tagInput Object

    the following property inputs are the properties of tagInput

  • path Property

    relative path from your html file to the TAG directory (e.g., './a/b/TAG')

  • containerId Property

    the id of the div in which you want to embed TAG

  • serverIp Property

    the ip adress of the server to which you want to connect

  • width Property

    the desired width of TAG

  • height Property

    the desired height of TAG

  • allowServerChange Property

    should a button be shown on the splash screen that allows server change?

  • hiddenCollections Property

    a list of collection IDs for published collections to be hidden

Methods

browserVersion

()

Defined in LADS/telemetry/telemetry.js:9

Get the current browser version Borrowed from http://stackoverflow.com/questions/5916900/detect-version-of-browser

registerTelemetry

(
  • element
  • etype
  • ttype
)

Defined in LADS/telemetry/telemetry.js:26

Register an element with the telemetry module

Parameters:

  • element JQuery Obj

    the element to which we'll attach a telemetry event handler

  • etype String

    the type of event (e.g., 'mousedown') for which we'll create the handler

  • ttype String

    the type of telemetry request to log

telemetryRequests

()

Defined in LADS/telemetry/telemetry.js:50

Make a request to the telemetry server using the requests variable