Document toolboxDocument toolbox

Private & Confidential

(1.0.0) Workspace API

Description

URI message

Arguments

Description

URI message

Arguments

 

The path segment of the message

 

Workspace messages

New workspace

workspace/new

"name"
"tags"

Load Workspace

workspace/load

"name"

import Xml

workspace/import

"path"

export Xml

workspace/export

"name"

 

workspace/save

"overwrite" (boolean string)

 

workspace/loadSession

"id"
"append”

 

workspace/loadTemplate

"id"
”type”
”path”

 

workspace/loadFile

"id"
”type”
”path”

 

workspace/clear

-

Open canvas UI lib

workspace/openContentLib

 

Close Canvas UI Lib

workspace/closeContentLib

 

 

layout/opened

-

 

layout/finished

-

 

layout/selectLayout

"index"

 

layout/selectRegion

"index"

Workspace view messages

 

layout/selectRegion

"index"

Apply cursor interaction to the current workspace

"cursor/moved" -x,y
"cursor/pressed" - button,x,y
"cursor/released" - button,x,y
"cursor/dragged"- button,x,y
"cursor/key" - msg,wParam,lParam
"cursor/scrolled" - value,x,y

 

Manipulate the toolbar on the canvas UI. Mostly used for the backend to update the frontend

toolbar/updateCursorSize - “value”- Boolean
toolbar/updateCursorSens -“value”- Boolean
toolbar/canvasShareEdit - “value”- Boolean
toolbar/canvasShareVisible - “value”- Boolean

 

Enter or cancel canvas share marquee mode

toolbar/canvasShareMarqueeMode

“value” - Boolean

Shows the share area for a few seconds, only works if isVisible and edit mode is false.

toolbar/canvasSharePingArea

none

 

(c) Igloo Vision 2020