Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Parameters

  • fileUrl: URl to the file to open. Read only access

  • file: Identifier of designated file in backend system (instead of fileUrl; if both are passed file is taken with priority)

  • server: Url of the API server if one is used as data backend (see https://graebert.atlassian.net/wiki/x/SIAuRg)

  • sessionId: id send with each API request if API server is used as data backend (see https://graebert.atlassian.net/wiki/x/SIAuRg)

  • locale: Set the user interface language

  • access: Set the editing or view UIĀ  (edit or view)

    • Note: access=view blocks storing any changes the user makes back to the storage. access=edit will automatically store changes on fixed intervals and on session close.

  • mobile: Load a mobile friendly UI (false or true)

  • debug: Provide debugging output and features (false or true)

  • workspace: Overwrite the default UI workspace used for editing UI (see https://graebert.atlassian.net/wiki/x/DAFgRg)

  • viewerWorkspace: Overwrite the default UI workspace used for view UI (see https://graebert.atlassian.net/wiki/x/DAFgRg)

  • autosavedisabled: Disable automatic saving in edit session. Changes made to the drawing are not saved unless SAVE command is executed explicitly.

Additional Saas Version Parameters

  • auth: application id associated with the partner

  • userId: partner defined user id

Note: If using SaaS version, you need to enclose the parameters in a generated apitoken that will be passed as query parameter (see Token Authentication).