Canvas client functions
editCanvas client functions
edit[beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. These functions must execute in a browser. They are only available from within the Canvas application, not via the Canvas HTTP API. These functions must execute in the browser because they use browser specific APIs, such as location, or interact with the workpad to read filters.
A * denotes a required argument.
asset
editUses Canvas workpad asset objects to provide argument values. Usually images.
Accepts: null
Argument | Type | Description |
---|---|---|
Unnamed* |
string |
The ID of the asset value to return |
Returns: string
browser
editForces the interpreter to return to the browser.
Accepts: Anything or nothing
Returns: Depends on your input and arguments
filters
editCollects element filters on the workpad, usually to provide them to a data source.
Accepts: null
Returns: filter
location
editUses the browser’s location functionality to get your current location. Usually quite slow, but fairly accurate.
Accepts: null
Returns: datatable
urlparam
editAccesses URL parameters and use them in expressions. This will always return a string.
Accepts: null
Argument | Type | Description |
---|---|---|
Unnamed* (Aliases: |
string |
The URL hash parameter to access |
default |
string |
Return this string if the url parameter is not defined (default: |
Returns: string