IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Canvas server functions TinyMath functions »
Elastic Docs ›Kibana User Guide [6.7] ›Canvas ›Canvas function reference

Canvas client functions

edit

Canvas client functions

edit

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

edit

Uses 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

edit

Forces the interpreter to return to the browser.

Accepts: Anything or nothing

Returns: Depends on your input and arguments

filters

edit

Collects element filters on the workpad, usually to provide them to a data source.

Accepts: null

Returns: filter

location

edit

Uses the browser’s location functionality to get your current location. Usually quite slow, but fairly accurate.

Accepts: null

Returns: datatable

urlparam

edit

Accesses URL parameters and use them in expressions. This will always return a string.

Accepts: null

Argument Type Description

Unnamed* (Aliases: var, variable)

string

The URL hash parameter to access

default

string

Return this string if the url parameter is not defined (default: "")

Returns: string

« Canvas server functions TinyMath functions »