maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/docs/canvas/canvas-function-reference.asciidoc
Catherine Liu a90ba21fea
[Canvas] Removes doc links from backticks. (#41601)
2019-07-22 10:15:32 -07:00

2189 lines
52 KiB
Plaintext
Raw Blame History

[role="xpack"]
[[canvas-function-reference]]
== Canvas function reference
Behind the scenes, Canvas is driven by a powerful expression language,
with dozens of functions and other capabilities, including table transforms,
type casting, and sub-expressions.
The Canvas expression language also supports <<canvas-tinymath-functions>>, which
perform complex math calculations.
A *** denotes a required argument.
A † denotes an argument can be passed multiple times.
<<a_fns>> | B | <<c_fns>> | <<d_fns>> | <<e_fns>> | <<f_fns>> | <<g_fns>> | <<h_fns>> | <<i_fns>> | <<j_fns>> | K | <<l_fns>> | <<m_fns>> | <<n_fns>> | O | <<p_fns>> | Q | <<r_fns>> | <<s_fns>> | <<t_fns>> | <<u_fns>> | V | W | X | Y | Z
[float]
[[a_fns]]
== A
[float]
[[all_fn]]
=== `all`
Returns `true` if all of the conditions are met. See also <<any_fn>>.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ *** †
Alias: `condition`
|`boolean`
|The conditions to check.
|===
*Returns:* `boolean`
[float]
[[alterColumn_fn]]
=== `alterColumn`
Converts between core types, including `string`, `number`, `null`, `boolean`, and `date`, and renames columns. See also <<mapColumn_fn>> and <<staticColumn_fn>>.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `column`
|`string`
|The name of the column to alter.
|`name`
|`string`
|The resultant column name. Leave blank to not rename.
|`type`
|`string`
|The type to convert the column to. Leave blank to not change the type.
|===
*Returns:* `datatable`
[float]
[[any_fn]]
=== `any`
Returns `true` if at least one of the conditions is met. See also <<all_fn>>.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ *** †
Alias: `condition`
|`boolean`
|The conditions to check.
|===
*Returns:* `boolean`
[float]
[[as_fn]]
=== `as`
Creates a `datatable` with a single value. See also <<getCell_fn>>.
*Accepts:* `string`, `boolean`, `number`, `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `name`
|`string`
|The name to give the column.
Default: `"value"`
|===
*Returns:* `datatable`
[float]
[[asset_fn]]
=== `asset`
Retrieves Canvas workpad asset objects to provide as argument values. Usually images.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `id`
|`string`
|The ID of the asset to retrieve.
|===
*Returns:* `string`
[float]
[[axisConfig_fn]]
=== `axisConfig`
Configures the axis of a visualization. Only used with <<plot_fn>>.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|`max`
|`number`, `string`, `null`
|The maximum value displayed in the axis. Must be a `number`, a date in milliseconds since epoch, or an ISO8601 `string`
|`min`
|`number`, `string`, `null`
|The minimum value displayed in the axis. Must be a `number`, a date in milliseconds since epoch, or an ISO8601 `string`
|`position`
|`string`
|The position of the axis labels. For example, `"top"`, `"bottom"`, `"left"`, or `"right"`.
Default: `"left"`
|`show`
|`boolean`
|Show the axis labels?
Default: `true`
|`tickSize`
|`number`, `null`
|The increment size between each tick. Use for `number` axes only.
|===
*Returns:* `axisConfig`
[float]
[[c_fns]]
== C
[float]
[[case_fn]]
=== `case`
Builds a `case` (including a condition/result) to pass to the <<switch_fn>> function.
*Accepts:* `any`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `when`
|`any`
|The value compared to the _context_ to see if they are equal. The `when` argument is ignored when the `if` argument is also specified.
|`if`
|`boolean`
|This value indicates whether the condition is met. The `if` argument overrides the `when` argument when both are provided.
|`then` ***
|`any`
|The value returned if the condition is met.
|===
*Returns:* `case`
[float]
[[clear_fn]]
=== `clear`
Clears the _context_, and returns `null`.
*Accepts:* `null`
*Returns:* `null`
[float]
[[columns_fn]]
=== `columns`
Includes or excludes columns from a data table. If you specify both, this will exclude first.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `include`
|`string`
|A comma-separated list of column names to keep in the `datatable`.
|`exclude`
|`string`
|A comma-separated list of column names to remove from the `datatable`.
|===
*Returns:* `datatable`
[float]
[[compare_fn]]
=== `compare`
Compares the _context_ to specified value to determine `true` or `false`.
Usually used in combination with <<if_fn>> or <<case_fn>>. This only works with primitive types,
such as `number`, `string`, and `boolean`. See also <<eq_fn>>, <<gt_fn>>, <<gte_fn>>, <<lt_fn>>, <<lte_fn>>, and <<neq_fn>>.
*Accepts:* `string`, `number`, `boolean`, `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `op`
|`string`
|The operator to use in the comparison: `eq` (equal to), `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), `ne` or `neq` (not equal to).
Default: `"eq"`
|`to`
Alias: `this`, `b`
|`any`
|The value compared to the _context_.
|===
*Returns:* `boolean`
[float]
[[containerStyle_fn]]
=== `containerStyle`
Creates an object used for styling an element's container, including background, border, and opacity.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|`backgroundColor`
|`string`
|A valid CSS background color.
|`backgroundImage`
|`string`
|A valid CSS background image.
|`backgroundRepeat`
|`string`
|A valid CSS background repeat.
Default: `"no-repeat"`
|`backgroundSize`
|`string`
|A valid CSS background size.
Default: `"contain"`
|`border`
|`string`
|A valid CSS border.
|`borderRadius`
|`string`
|The number of pixels to use when rounding the corners.
|`opacity`
|`number`
|A number between 0 and 1 that represents the degree of transparency of the element.
|`overflow`
|`string`
|A valid CSS overflow.
Default: `"hidden"`
|`padding`
|`string`
|The distance of the content, in pixels, from the border.
|===
*Returns:* `containerStyle`
[float]
[[context_fn]]
=== `context`
Returns whatever you pass into it. This can be useful when you need to use the
_context_ as an argument to a function as a sub-expression.
*Accepts:* `any`
*Returns:* Original _context_
[float]
[[csv_fn]]
=== `csv`
Creates a `datatable` from CSV input.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `data`
|`string`
|The CSV data to use.
|`delimiter`
|`string`
|The data separation character.
|`newLine`
|`string`
|The row separation character.
|===
*Returns:* `datatable`
[float]
[[d_fns]]
== D
[float]
[[date_fn]]
=== `date`
Returns the current time, or a time parsed from a `string`, as milliseconds since epoch.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `value`
|`string`
|A date string to be parsed into milliseconds since epoch. The date string be either a valid JavaScript Date input or a string to parse
using the `format` argument. Must be an ISO8601 string or you must provide the format.
|`format`
|`string`
|The MomentJS format for parsing the optional date
`string`. See the https://momentjs.com/docs/#/displaying/[MomentJS documentation].
|===
*Returns:* `number`
[float]
[[demodata_fn]]
=== `demodata`
A mock data set that includes project CI times with usernames, countries, and run phases.
*Accepts:* `filter`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `type`
|`string`
|The name of the demo data set to use.
Default: `"ci"`
|===
*Returns:* `datatable`
[float]
[[do_fn]]
=== `do`
Executes multiple sub-expressions, then returns the original _context_. Use for running functions that produce an action or side effect without changing the original _context_.
*Accepts:* `any`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ †
Aliases: `expression`, `exp`, `fn`, `function`
|`any`
|The sub-expressions to execute. The return values of these sub-expressions are not available in the root pipeline as this function simply returns the _context_.
|===
*Returns:* Original _context_
[float]
[[dropdownControl_fn]]
=== `dropdownControl`
Configures a dropdown filter control element.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|`filterColumn` ***
|`string`
|The column or field that you want to filter.
|`valueColumn` ***
|`string`
|The column or field to extract the unique values for the drop-down control.
|`filterGroup`
|`string`
|The group name for the filter.
|===
*Returns:* `render`
[float]
[[e_fns]]
== E
[float]
[[eq_fn]]
=== `eq`
Returns whether the _context_ is equal to the argument.
*Accepts:* `boolean`, `number`, `string`, `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `value`
|`boolean`, `number`, `string`, `null`
|The value compared to the _context_.
|===
*Returns:* `boolean`
[float]
[[escount_fn]]
=== `escount`
Queries {es} for the number of hits matching the specified query.
*Accepts:* `filter`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `q`, `query`
|`string`
|A Lucene query string.
Default: `"-_index:.kibana"`
|`index`
|`string`
|An index or index pattern. For example, `"logstash-*"`.
Default: `_all`
|===
*Returns:* `number`
[float]
[[esdocs_fn]]
=== `esdocs`
Queries {es} for raw documents. Specify the fields you want to retrieve,
especially if you are asking for a lot of rows.
*Accepts:* `filter`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Aliases: `q`, `query`
|`string`
|A Lucene query string.
Default: `"-_index:.kibana"`
|`count`
|`number`
|The number of documents to retrieve. For better performance, use a smaller data set.
Default: `1000`
|`fields`
|`string`
|A comma-separated list of fields. For better performance, use fewer fields.
|`index`
|`string`
|An index or index pattern. For example, `"logstash-*"`.
Default: `"_all"`
|`sort`
|`string`
|The sort direction formatted as `"field, direction"`. For example, `"@timestamp, desc"` or `"bytes, asc"`.
|===
*Returns:* `datatable`
[float]
[[essql_fn]]
=== `essql`
Queries {es} using {es} SQL.
*Accepts:* `filter`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `q`, `query`
|`string`
|An {es} SQL query.
|`count`
|`number`
|The number of documents to retrieve. Smaller numbers perform better.
Default: `1000`
|`timezone`
|`string`
|The timezone to use for date operations. Valid ISO8601 formats and UTC offsets both work.
Default: `UTC`
|===
*Returns:* `datatable`
[float]
[[exactly_fn]]
=== `exactly`
Creates a filter that matches a given column to an exact value.
*Accepts:* `filter`
[cols="3*^<"]
|===
|Argument |Type |Description
|`column` ***
Aliases: `field`, `c`
|`string`
|The column or field that you want to filter.
|`value` ***
Aliases: `v`, `val`
|`string`
|The value to match exactly, including white space and
capitalization.
|`filterGroup`
|`string`
|The group name for the filter.
|===
*Returns:* `filter`
[float]
[[f_fns]]
== F
[float]
[[filterrows_fn]]
=== `filterrows`
Filters rows in a `datatable` based on the return value of a sub-expression.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Aliases: `fn`, `exp`, `expression`
|`boolean`
|An expression to pass into each row in the `datatable.`
The expression should return a `boolean`. A `true` value preserves the row,
and a `false` value removes it.
|===
*Returns:* `datatable`
[float]
[[filters_fn]]
=== `filters`
Aggregates element filters from the workpad for use elsewhere, usually a data source.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ †
Alias: `group`
|`string`
|The name of the filter group to use.
|`ungrouped`
Alias: `nogroup`, `nogroups`
|`boolean`
|Exclude filters that belong to a filter group?
Default: `false`
|===
*Returns:* `filter`
[float]
[[font_fn]]
=== `font`
Creates a font style.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|`align`
|`string`
|The horizontal alignment of text.
Default: `left`
|`color`
|`string`
|The text color.
|`family`
|`string`
|An acceptable CSS web font string.
Default: `"'Open Sans', Helvetica, Arial, sans-serif"`
|`italic`
|`boolean`
|Italicize the text?
Default: `false`
|`lHeight`
Alias: `lineHeight`
|`number`, `null`
|The line height in pixels.
|`size`
|`number`
|The font size in pixels.
Default: `14`
|`underline`
|`boolean`
|Underline the text?
Default: `false`
|`weight`
|`string`
|The font weight. For example, `"normal"`, `"bold"`, `"bolder"`, `"lighter"`, `"100"`, `"200"`, `"300"`, `"400"`, `"500"`, `"600"`, `"700"`, `"800"`, or `"900"`.
Default: `"normal"`
|===
*Returns:* `style`
[float]
[[formatdate_fn]]
=== `formatdate`
Formats an ISO8601 date string or a date in milliseconds since epoch using MomentJS. See https://momentjs.com/docs/#/displaying/.
*Accepts:* `number`, `string`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `format`
|`string`
|A MomentJS format. For example, `"MM/DD/YYYY"`. See https://momentjs.com/docs/#/displaying/.
|===
*Returns:* `string`
[float]
[[formatnumber_fn]]
=== `formatnumber`
Formats a `number` into a formatted `string` using NumeralJS. See http://numeraljs.com/#format.
*Accepts:* `number`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `format`
|`string`
|A NumeralJS format string. For example, `"0.0a"` or `"0%"`. See http://numeraljs.com/#format.
|===
*Returns:* `string`
[float]
[[g_fns]]
== G
[float]
[[getCell_fn]]
=== `getCell`
Fetches a single cell from a `datatable`.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Aliases: `column`, `c`
|`string`
|The name of the column to fetch the value from. If not provided, the value is retrieved from the first column.
|`row`
Alias: `r`
|`number`
|The row number, starting at 0.
Default: `0`
|===
*Returns:* Depends on the data in the cell
[float]
[[gt_fn]]
=== `gt`
Returns whether the _context_ is greater than the argument.
*Accepts:* `number`, `string`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `value`
|`number`, `string`
|The value compared to the _context_.
|===
*Returns:* `boolean`
[float]
[[gte_fn]]
=== `gte`
Returns whether the _context_ is greater or equal to the argument.
*Accepts:* `number`, `string`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `value`
|`number`, `string`
|The value compared to the _context_.
|===
*Returns:* `boolean`
[float]
[[h_fns]]
== H
[float]
[[head_fn]]
=== `head`
Retrieves the first N rows from the `datatable`. See also <<tail_fn>>.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `count`
|`number`
|The number of rows to retrieve from the beginning of the `datatable`.
Default: `1`
|===
*Returns:* `datatable`
[float]
[[i_fns]]
== I
[float]
[[if_fn]]
=== `if`
Performs conditional logic.
*Accepts:* `any`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `condition`
|`boolean`
|A `true` or `false` indicating whether a condition is met, usually returned by a sub-expression. When unspecified, the original _context_ is returned.
|`then`
|`any`
|The return value when the condition is `true`. When unspecified and the condition is met, the original _context_ is returned.
|`else`
|`any`
|The return value when the condition is `false`. When unspecified and the condition is not met, the original _context_ is returned.
|===
*Returns:* Depends on your _context_ and arguments
[float]
[[image_fn]]
=== `image`
Displays an image. Provide an image asset as a `base64` data URL, or pass in a sub-expression.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Aliases: `dataurl`, `url`
|`string`, `null`
|The HTTP(S) URL or `base64` data URL of an image.
|`mode`
|`string`
|`"contain"` shows the entire image, scaled to fit.
`"cover"` fills the container with the image, cropping from the sides or bottom as needed.
`"stretch"` resizes the height and width of the image to 100% of the container.
Default: `"contain"`
|===
Example value for the `dataurl` argument, formatted as a `base64` data URL:
[source, url]
-------------
data:image/svg+xml;`base64`,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcKICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIgogICB4bWxuczpjYz0iaHR0cDovL2NyZWF0aXZlY29tbW9ucy5vcmcvbnMjIgogICB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgdmlld0JveD0iMCAwIDI3MC42MDAwMSAyNjkuNTQ2NjYiCiAgIGhlaWdodD0iMjY5LjU0NjY2IgogICB3aWR0aD0iMjcwLjYwMDAxIgogICB4bWw6c3BhY2U9InByZXNlcnZlIgogICBpZD0ic3ZnMiIKICAgdmVyc2lvbj0iMS4xIj48bWV0YWRhdGEKICAgICBpZD0ibWV0YWRhdGE4Ij48cmRmOlJERj48Y2M6V29yawogICAgICAgICByZGY6YWJvdXQ9IiI+PGRjOmZvcm1hdD5pbWFnZS9zdmcreG1sPC9kYzpmb3JtYXQ+PGRjOnR5cGUKICAgICAgICAgICByZGY6cmVzb3VyY2U9Imh0dHA6Ly9wdXJsLm9yZy9kYy9kY21pdHlwZS9TdGlsbEltYWdlIiAvPjwvY2M6V29yaz48L3JkZjpSREY+PC9tZXRhZGF0YT48ZGVmcwogICAgIGlkPSJkZWZzNiIgLz48ZwogICAgIHRyYW5zZm9ybT0ibWF0cml4KDEuMzMzMzMzMywwLDAsLTEuMzMzMzMzMywwLDI2OS41NDY2NykiCiAgICAgaWQ9ImcxMCI+PGcKICAgICAgIHRyYW5zZm9ybT0ic2NhbGUoMC4xKSIKICAgICAgIGlkPSJnMTIiPjxwYXRoCiAgICAgICAgIGlkPSJwYXRoMTQiCiAgICAgICAgIHN0eWxlPSJmaWxsOiNmZmZmZmY7ZmlsbC1vcGFjaXR5OjE7ZmlsbC1ydWxlOm5vbnplcm87c3Ryb2tlOm5vbmUiCiAgICAgICAgIGQ9Im0gMjAyOS40OCw5NjIuNDQxIGMgMCwxNzAuMDk5IC0xMDUuNDYsMzE4Ljc5OSAtMjY0LjE3LDM3Ni42NTkgNi45OCwzNS44NiAxMC42Miw3MS43MSAxMC42MiwxMDkuMDUgMCwzMTYuMTkgLTI1Ny4yNCw1NzMuNDMgLTU3My40Nyw1NzMuNDMgLTE4NC43MiwwIC0zNTYuNTU4LC04OC41OSAtNDY0LjUzLC0yMzcuODUgLTUzLjA5LDQxLjE4IC0xMTguMjg1LDYzLjc1IC0xODYuMzA1LDYzLjc1IC0xNjcuODM2LDAgLTMwNC4zODMsLTEzNi41NCAtMzA0LjM4MywtMzA0LjM4IDAsLTM3LjA4IDYuNjE3LC03Mi41OCAxOS4wMzEsLTEwNi4wOCBDIDEwOC40ODgsMTM4MC4wOSAwLDEyMjcuODkgMCwxMDU4Ljg4IDAsODg3LjkxIDEwNS45NzcsNzM4LjUzOSAyNjUuMzk4LDY4MS4wOSBjIC02Ljc2OSwtMzUuNDQyIC0xMC40NiwtNzIuMDIgLTEwLjQ2LC0xMDkgQyAyNTQuOTM4LDI1Ni42MjEgNTExLjU2NiwwIDgyNy4wMjcsMCAxMDEyLjIsMCAxMTgzLjk0LDg4Ljk0MTQgMTI5MS4zLDIzOC44MzIgYyA1My40NSwtNDEuOTYxIDExOC44LC02NC45OTIgMTg2LjU2LC02NC45OTIgMTY3LjgzLDAgMzA0LjM4LDEzNi40OTIgMzA0LjM4LDMwNC4zMzIgMCwzNy4wNzggLTYuNjIsNzIuNjI5IC0xOS4wMywxMDYuMTI5IDE1Ny43OCw1Ni44NzkgMjY2LjI3LDIwOS4xMjkgMjY2LjI3LDM3OC4xNCIgLz48cGF0aAogICAgICAgICBpZD0icGF0aDE2IgogICAgICAgICBzdHlsZT0iZmlsbDojZmFjZjA5O2ZpbGwtb3BhY2l0eToxO2ZpbGwtcnVsZTpub256ZXJvO3N0cm9rZTpub25lIgogICAgICAgICBkPSJtIDc5Ny44OTgsMTE1MC45MyA0NDQuMDcyLC0yMDIuNDUgNDQ4LjA1LDM5Mi41OCBjIDYuNDksMzIuMzkgOS42Niw2NC42NyA5LjY2LDk4LjQ2IDAsMjc2LjIzIC0yMjQuNjgsNTAwLjk1IC01MDAuOSw1MDAuOTUgLTE2NS4yNCwwIC0zMTkuMzcsLTgxLjM2IC00MTMuMDUzLC0yMTcuNzkgbCAtNzQuNTI0LC0zODYuNjQgODYuNjk1LC0xODUuMTEiIC8+PHBhdGgKICAgICAgICAgaWQ9InBhdGgxOCIKICAgICAgICAgc3R5bGU9ImZpbGw6IzQ5YzFhZTtmaWxsLW9wYWNpdHk6MTtmaWxsLXJ1bGU6bm9uemVybztzdHJva2U6bm9uZSIKICAgICAgICAgZD0ibSAzMzguMjIzLDY4MC42NzIgYyAtNi40ODksLTMyLjM4MyAtOS44MDksLTY1Ljk4MSAtOS44MDksLTk5Ljk3MyAwLC0yNzYuOTI5IDIyNS4zMzYsLTUwMi4yNTc2IDUwMi4zMTMsLTUwMi4yNTc2IDE2Ni41OTMsMCAzMjEuNDczLDgyLjExNzYgNDE1LjAxMywyMTkuOTQ5NiBsIDczLjk3LDM4NS4zNDcgLTk4LjcyLDE4OC42MjEgTCA3NzUuMTU2LDEwNzUuNTcgMzM4LjIyMyw2ODAuNjcyIiAvPjxwYXRoCiAgICAgICAgIGlkPSJwYXRoMjAiCiAgICAgICAgIHN0eWxlPSJmaWxsOiNlZjI5OWI7ZmlsbC1vcGFjaXR5OjE7ZmlsbC1ydWxlOm5vbnplcm87c3Ryb2tlOm5vbmUiCiAgICAgICAgIGQ9Im0gMzM1LjQxLDE0NDkuMTggMzA0LjMzMiwtNzEuODYgNjYuNjgsMzQ2LjAyIGMgLTQxLjU4NiwzMS43OCAtOTIuOTMsNDkuMTggLTE0NS43MzEsNDkuMTggLTEzMi4yNSwwIC0yMzkuODEyLC0xMDcuNjEgLTIzOS44MTIsLTIzOS44NyAwLC0yOS4yMSA0Ljg3OSwtNTcuMjIgMTQuNTMxLC04My40NyIgLz48cGF0aAogICAgICAgICBpZD0icGF0aDIyIgogICAgICAgICBzdHlsZT0iZmlsbDojNGNhYmU0O2ZpbGwtb3BhY2l0eToxO2ZpbGwtcnVsZTpub256ZXJvO3N0cm9rZTpub25lIgogICAgICAgICBkPSJNIDMwOC45OTIsMTM3Ni43IEMgMTczLjAyLDEzMzEuNjQgNzguNDgwNSwxMjAxLjMgNzguNDgwNSwxMDU3LjkzIDc4LjQ4MDUsOTE4LjM0IDE2NC44Miw3OTMuNjggMjk0LjQwNiw3NDQuMzUyIGwgNDI2Ljk4MSwzODUuOTM4IC03OC4zOTUsMTY3LjUxIC0zMzQsNzguOSIgLz48cGF0aAogICAgICAgICBpZD0icGF0aDI0IgogICAgICAgICBzdHlsZT0iZmlsbDojODVjZTI2O2ZpbGwtb3BhY2l0eToxO2ZpbGwtcnVsZTpub256ZXJvO3N0cm9rZTpub25lIgogICAgICAgICBkPSJtIDEzMjMuOCwyOTguNDEgYyA0MS43NCwtMzIuMDkgOTIuODMsLTQ5LjU5IDE0NC45OCwtNDkuNTkgMTMyLjI1LDAgMjM5LjgxLDEwNy41NTkgMjM5LjgxLDIzOS44MjEgMCwyOS4xNiAtNC44OCw1Ny4xNjggLTE0LjUzLDgzLjQxOCBsIC0zMDQuMDgsNzEuMTYgLTY2LjE4LC0zNDQuODA5IiAvPjxwYXRoCiAgICAgICAgIGlkPSJwYXRoMjYiCiAgICAgICAgIHN0eWxlPSJmaWxsOiMzMTc3YTc7ZmlsbC1vcGFjaXR5OjE7ZmlsbC1ydWxlOm5vbnplcm87c3Ryb2tlOm5vbmUiCiAgICAgICAgIGQ9Im0gMTM4NS42Nyw3MjIuOTMgMzM0Ljc2LC03OC4zMDEgYyAxMzYuMDIsNDQuOTYxIDIzMC41NiwxNzUuMzUxIDIzMC41NiwzMTguNzYyIDAsMTM5LjMzOSAtODYuNTQsMjYzLjg1OSAtMjE2LjM4LDMxMy4wMzkgbCAtNDM3Ljg0LC0zODMuNTkgODguOSwtMTY5LjkxIiAvPjwvZz48L2c+PC9zdmc+
-------------
*Returns:* `image`
[float]
[[j_fns]]
== J
[float]
[float]
[[joinRows_fn]]
=== `joinRows`
Concatenates values from rows in a `datatable` into a single string.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `column`
|`string`
|The column or field from which to extract the values.
|distinct
|`boolean`
|Extract only unique values?
Default: `true`
|quote
|`string`
|The quote character to wrap around each extracted value.
Default: `"'"`
|separator
Aliases: `sep`, `delimiter`
|`string`
|The delimiter to insert between each extracted value.
Default: `", "`
|===
*Returns:* `string`
[float]
[[l_fns]]
== L
[float]
[float]
[[location_fn]]
=== `location`
Find your current location using the Geolocation API of the browser. Performance can vary, but is fairly accurate.
See: https://developer.mozilla.org/en-US/docs/Web/API/Navigator/geolocation.
*Accepts:* `null`
*Returns:* `datatable`
[float]
[[lt_fn]]
=== `lt`
Returns whether the _context_ is less than the argument.
*Accepts:* `number`, `string`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `value`
|`number`, `string`
|The value compared to the _context_.
|===
*Returns:* `boolean`
[float]
[[lte_fn]]
=== `lte`
Returns whether the _context_ is less than or equal to the argument.
*Accepts:* `number`, `string`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `value`
|`number`, `string`
|The value compared to the _context_.
|===
*Returns:* `boolean`
[float]
[[m_fns]]
== M
[float]
[[mapColumn_fn]]
=== `mapColumn`
Adds a column calculated as the result of other columns. Changes are made only when you provide arguments. See also <<alterColumn_fn>> and <<staticColumn_fn>>.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `column`
|`string`
|The name of the resulting column.
|`expression` ***
Alias: `exp`, `fn`, `function`
|`boolean`, `number`, `string`, `null`
|A Canvas expression that is passed to each row as a single row `datatable`.
|===
*Returns:* `datatable`
[float]
[[markdown_fn]]
=== `markdown`
Adds an element that renders Markdown text. TIP: Use the <<markdown_fn>> function for single numbers, metrics, and paragraphs of text.
*Accepts:* `datatable`, `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ †
Alias: `expression`, `content`
|`string`
|A string of text that contains Markdown. To concatenate, pass the <<string_fn>> function multiple times.
Default: `""`
|`font`
|`style`
|The CSS font properties for the content. For example, `font-family` or `font-weight`.
Default: `{font}`
|===
*Returns:* `render`
[float]
[[math_fn]]
=== `math`
Interprets a `TinyMath` math expression using a `number` or `datatable` as _context_. The `datatable` columns are available by their column name. If the _context_ is a `number`, it is available as `value`.
*Accepts:* `number`, `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `expression`
|`string`
|An evaluated TinyMath expression. See <<canvas-tinymath-functions>>.
|===
*Returns:* `number`
[float]
[[metric_fn]]
=== `metric`
Displays a number over a label.
*Accepts:* `number`, `string`, `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Aliases: `label`, `text`, `description`
|`string`
|The text describing the metric.
Default: `""`
|`metricFont`
|`style`
|The CSS font properties for the metric. For example, `font-family` or `font-weight`.
Default: `{font size=48 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center lHeight=48}`.
|`labelFont`
|`style`
|The CSS font properties for the label. For example, `font-family` or `font-weight`.
Default: `{font size=14 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center}`.
|===
*Returns:* `render`
[float]
[[n_fns]]
== N
[float]
[[neq_fn]]
=== `neq`
Returns whether the _context_ is not equal to the argument.
*Accepts:* `boolean`, `number`, `string`, `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `value`
|`boolean`, `number`, `string`, `null`
|The value compared to the _context_.
|===
*Returns:* `boolean`
[float]
[[p_fns]]
== P
[float]
[[palette_fn]]
=== `palette`
Creates a color palette.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ *** †
Alias: `color`
|`string`
|The palette colors. Accepts an HTML color name, HEX, HSL, HSLA, RGB, or RGBA.
|`gradient`
|`boolean`
|Make a gradient where supported?
Default: `false`
|`reverse`
|`boolean`
|Reverse the palette?
Default: `false`
|===
*Returns:* `palette`
[float]
[[pie_fn]]
=== `pie`
Configures a pie chart element.
*Accepts:* `pointseries`
[cols="3*^<"]
|===
|Argument |Type |Description
|`font`
|`style`
|The CSS font properties for the labels. For example, `font-family` or `font-weight`.
Default: `{font}`
|`hole`
|`number`
|Draws a hole in the pie, 0-100, as a percentage of the pie radius.
Default: `0`
|`labelRadius`
|`number`
|The percentage of the container area to use as a radius for the label circle.
Default: `100`
|`labels`
|`boolean`
|Display the pie labels?
Default: `true`
|`legend`
|`string`, `boolean`
|The legend position. For example, `"nw"`, `"sw"`, `"ne"`, `"se"`. When `false`, the legend is hidden.
Default: `false`
|`palette`
|`palette`
|A `palette` object for describing the colors to use in this pie chart
Default: `{palette}`
|`radius`
|`string`, `number`
|The radius of the pie as a percentage (between 0 and 1) of the available space. To automatically set radius, use `"auto"`.
Default: `"auto"`
|`seriesStyle` †
|`seriesStyle`
|A style of a specific series
|`tilt`
|`number`
|The percentage of tilt, where 1 is fully vertical, and 0 is completely flat.
Default: `1`
|===
*Returns:* `render`
[float]
[[plot_fn]]
=== `plot`
Configures a plot element.
*Accepts:* `pointseries`
[cols="3*^<"]
|===
|Argument |Type |Description
|`defaultStyle`
|`seriesStyle`
|The default style to use for every series.
Default: `{seriesStyle points=5}`
|`font`
|`style`
|The CSS font properties for the labels. For example, `font-family` or `font-weight`.
Default: `{font}`
|`legend`
|`string`, `boolean`
|The legend position. For example, `"nw"`, `"sw"`, `"ne"`, `"se"`, or `false`. When `false`, the legend is hidden.
Default: `"ne"`
|`palette`
|`palette`
|A `palette` object for describing the colors to use in this chart
Default: `{palette}`
|`seriesStyle` †
|`seriesStyle`
|A style of a specific series
|`xaxis`
|`boolean`, `axisConfig`
|The axis configuration. When `false`, the axis is hidden.
Default: `true`
|`yaxis`
|`boolean`, `axisConfig`
|The axis configuration. When `false`, the axis is hidden.
Default: `true`
|===
*Returns:* `render`
[float]
[[ply_fn]]
=== `ply`
Subdivides a `datatable` by the unique values of the specified columns, and passes the resulting tables into an expression, then merges the outputs of each expression.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|`by` *** †
|`string`
|The column to subdivide the `datatable`.
|`expression` *** †
Alias: `fn`, `exp`, `function`
|`datatable`
|An expression to pass into each resulting data table. Expressions must return a `datatable`. Use `as` to turn literals into `datatable`s. Multiple expressions must return the same number of rows. If you need to return a different row count, pipe into another instance of <<ply_fn>>. If multiple expressions return `datatable`s with the same column names, the last one wins.
|===
*Returns:* `datatable`
[float]
[[pointseries_fn]]
=== `pointseries`
Turns a `datatable` into a point series model. Currently we differentiate measure from dimensions by looking for a <<canvas-tinymath-functions, Tiny Math function>>. If you enter a TinyMath
expression in your argument, Canvas treats that argument as a measure. Otherwise, it is a dimension. Dimensions are combined to create unique keys. Measures are then deduplicated by those keys using the specified TinyMath function.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|`color`
|`string`
|An expression to use in determining the mark's color.
|`size`
|`string`
|The size of the marks. Only applicable to supported elements.
|`text`
|`string`
|The text to show on the mark. Only applicable to supported elements.
|`x`
|`string`
|The values along the X-axis.
|`y`
|`string`
|The values along the Y-axis.
|===
*Returns:* `pointseries`
[float]
[[progress_fn]]
=== `progress`
Configures a progress element
*Accepts:* `number`
[cols="3*^<"]
|===
|Argument |Type |Description
| _Unnamed_
Alias: `shape`
|`string`
|Select `"gauge"`, `"horizontalBar"`, `"horizontalPill"`, `"semicircle"`, `"unicorn"`, `"verticalBar"`, `"verticalPill"`, or `"wheel"`.
Default: `"gauge"`
|`barColor`
|`string`
|The color of the background bar.
Default: `"#f0f0f0"`
|`barWeight`
|`number`
|The thickness of the background bar.
Default: `20`
|`font`
|`style`
|The CSS font properties for the label. For example, `font-family` or `font-weight`.
Default: `{font size=24 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center}`
|`label`
|`boolean`, `string`
|To show or hide the value, use `true` or `false`. Alternatively, provide a string to display as a label.
Default: `true`
|`max`
|`number`
|The maximum value of the progress element.
Default: `1`
|`valueColor`
|`string`
|The color of the progress bar.
Default: `"#1785b0"`
|`valueWeight`
|`number`
|The thickness of the progress bar.
Default: `20`
|===
*Returns:* `render`
[float]
[[r_fns]]
== R
[float]
[[render_fn]]
=== `render`
Renders the _context_ as a specific element and sets element level options, such as background and border styling.
*Accepts:* `render`
[cols="3*^<"]
|===
|Argument |Type |Description
|`as`
|`string`
|The element type to render. You might want to use a specialized function instead, such as <<plot_fn>> or <<shape_fn>>.
|`css`
|`string`
|Any block of custom CSS to be scoped to the element
Default: `".canvasRenderEl{\n\n}"`
|`containerStyle`
|`containerStyle`
|The style for the container, including background, border, and opacity.
Default: `{containerStyle}`
|===
*Returns:* `render`
[float]
[[repeatImage_fn]]
=== `repeatImage`
Configures a repeating image element.
*Accepts:* `number`
[cols="3*^<"]
|===
|Argument |Type |Description
|`emptyImage`
|`string`
|Fills the difference between the _context_ and `max` parameter for the element with this image. Provide an image asset as a `base64` data URL, or pass in a sub-expression.
Default: `null`
|`image`
|`string`
|The image to repeat. Provide an image asset as a `base64` data URL, or pass in a sub-expression.
|`max`
|`number`
|The maximum number of times the image can repeat.
Default: `100`
|`size`
|`number`
|The maximum height or width of the image, in pixels. When the image is taller than it is wide, this function limits the height.
Default: `100`
|===
Example value for the `image` argument, formatted as a `base64` data URL:
[source, url]
------------
data:image/svg+xml,%3C%3Fxml%20version%3D%221.0%22%20encoding%3D%22utf-8%22%3F%3E%0A%3Csvg%20viewBox%3D%22-3.948730230331421%20-1.7549896240234375%20245.25946044921875%20241.40370178222656%22%20width%3D%22245.25946044921875%22%20height%3D%22241.40370178222656%22%20style%3D%22enable-background%3Anew%200%200%20686.2%20235.7%3B%22%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%3E%0A%20%20%3Cdefs%3E%0A%20%20%20%20%3Cstyle%20type%3D%22text%2Fcss%22%3E%0A%09.st0%7Bfill%3A%232D2D2D%3B%7D%0A%3C%2Fstyle%3E%0A%20%20%3C%2Fdefs%3E%0A%20%20%3Cg%20transform%3D%22matrix%281%2C%200%2C%200%2C%201%2C%200%2C%200%29%22%3E%0A%20%20%20%20%3Cg%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M329.4%2C160.3l4.7-0.5l0.3%2C9.6c-12.4%2C1.7-23%2C2.6-31.8%2C2.6c-11.7%2C0-20-3.4-24.9-10.2%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-4.9-6.8-7.3-17.4-7.3-31.7c0-28.6%2C11.4-42.9%2C34.1-42.9c11%2C0%2C19.2%2C3.1%2C24.6%2C9.2c5.4%2C6.1%2C8.1%2C15.8%2C8.1%2C28.9l-0.7%2C9.3h-53.8%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc0%2C9%2C1.6%2C15.7%2C4.9%2C20c3.3%2C4.3%2C8.9%2C6.5%2C17%2C6.5C312.8%2C161.2%2C321.1%2C160.9%2C329.4%2C160.3z%20M325%2C124.9c0-10-1.6-17.1-4.8-21.2%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-3.2-4.1-8.4-6.2-15.6-6.2c-7.2%2C0-12.7%2C2.2-16.3%2C6.5c-3.6%2C4.3-5.5%2C11.3-5.6%2C20.9H325z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M354.3%2C171.4V64h12.2v107.4H354.3z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M443.5%2C113.5v41.1c0%2C4.1%2C10.1%2C3.9%2C10.1%2C3.9l-0.6%2C10.8c-8.6%2C0-15.7%2C0.7-20-3.4c-9.8%2C4.3-19.5%2C6.1-29.3%2C6.1%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-7.5%2C0-13.2-2.1-17.1-6.4c-3.9-4.2-5.9-10.3-5.9-18.3c0-7.9%2C2-13.8%2C6-17.5c4-3.7%2C10.3-6.1%2C18.9-6.9l25.6-2.4v-7%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc0-5.5-1.2-9.5-3.6-11.9c-2.4-2.4-5.7-3.6-9.8-3.6l-32.1%2C0V87.2h31.3c9.2%2C0%2C15.9%2C2.1%2C20.1%2C6.4C441.4%2C97.8%2C443.5%2C104.5%2C443.5%2C113.5%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bz%20M393.3%2C146.7c0%2C10%2C4.1%2C15%2C12.4%2C15c7.4%2C0%2C14.7-1.2%2C21.8-3.7l3.7-1.3v-26.9l-24.1%2C2.3c-4.9%2C0.4-8.4%2C1.8-10.6%2C4.2%26%2310%3B%26%239%3B%26%239%3B%26%239%3BC394.4%2C138.7%2C393.3%2C142.2%2C393.3%2C146.7z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M491.2%2C98.2c-11.8%2C0-17.8%2C4.1-17.8%2C12.4c0%2C3.8%2C1.4%2C6.5%2C4.1%2C8.1c2.7%2C1.6%2C8.9%2C3.2%2C18.6%2C4.9%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc9.7%2C1.7%2C16.5%2C4%2C20.5%2C7.1c4%2C3%2C6%2C8.7%2C6%2C17.1c0%2C8.4-2.7%2C14.5-8.1%2C18.4c-5.4%2C3.9-13.2%2C5.9-23.6%2C5.9c-6.7%2C0-29.2-2.5-29.2-2.5%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bl0.7-10.6c12.9%2C1.2%2C22.3%2C2.2%2C28.6%2C2.2c6.3%2C0%2C11.1-1%2C14.4-3c3.3-2%2C5-5.4%2C5-10.1c0-4.7-1.4-7.9-4.2-9.6c-2.8-1.7-9-3.3-18.6-4.8%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-9.6-1.5-16.4-3.7-20.4-6.7c-4-2.9-6-8.4-6-16.3c0-7.9%2C2.8-13.8%2C8.4-17.6c5.6-3.8%2C12.6-5.7%2C20.9-5.7c6.6%2C0%2C29.6%2C1.7%2C29.6%2C1.7%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bv10.7C508.1%2C99%2C498.2%2C98.2%2C491.2%2C98.2z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M581.7%2C99.5h-25.9v39c0%2C9.3%2C0.7%2C15.5%2C2%2C18.4c1.4%2C2.9%2C4.6%2C4.4%2C9.7%2C4.4l14.5-1l0.8%2C10.1%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-7.3%2C1.2-12.8%2C1.8-16.6%2C1.8c-8.5%2C0-14.3-2.1-17.6-6.2c-3.3-4.1-4.9-12-4.9-23.6V99.5h-11.6V88.9h11.6V63.9h12.1v24.9h25.9V99.5z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M598.7%2C78.4V64.3h12.2v14.2H598.7z%20M598.7%2C171.4V88.9h12.2v82.5H598.7z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M663.8%2C87.2c3.6%2C0%2C9.7%2C0.7%2C18.3%2C2l3.9%2C0.5l-0.5%2C9.9c-8.7-1-15.1-1.5-19.2-1.5c-9.2%2C0-15.5%2C2.2-18.8%2C6.6%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-3.3%2C4.4-5%2C12.6-5%2C24.5c0%2C11.9%2C1.5%2C20.2%2C4.6%2C24.9c3.1%2C4.7%2C9.5%2C7%2C19.3%2C7l19.2-1.5l0.5%2C10.1c-10.1%2C1.5-17.7%2C2.3-22.7%2C2.3%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-12.7%2C0-21.5-3.3-26.3-9.8c-4.8-6.5-7.3-17.5-7.3-33c0-15.5%2C2.6-26.4%2C7.8-32.6C643%2C90.4%2C651.7%2C87.2%2C663.8%2C87.2z%22%2F%3E%0A%20%20%20%20%3C%2Fg%3E%0A%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M236.6%2C123.5c0-19.8-12.3-37.2-30.8-43.9c0.8-4.2%2C1.2-8.4%2C1.2-12.7C207%2C30%2C177%2C0%2C140.2%2C0%26%2310%3B%26%239%3B%26%239%3BC118.6%2C0%2C98.6%2C10.3%2C86%2C27.7c-6.2-4.8-13.8-7.4-21.7-7.4c-19.6%2C0-35.5%2C15.9-35.5%2C35.5c0%2C4.3%2C0.8%2C8.5%2C2.2%2C12.4%26%2310%3B%26%239%3B%26%239%3BC12.6%2C74.8%2C0%2C92.5%2C0%2C112.2c0%2C19.9%2C12.4%2C37.3%2C30.9%2C44c-0.8%2C4.1-1.2%2C8.4-1.2%2C12.7c0%2C36.8%2C29.9%2C66.7%2C66.7%2C66.7%26%2310%3B%26%239%3B%26%239%3Bc21.6%2C0%2C41.6-10.4%2C54.1-27.8c6.2%2C4.9%2C13.8%2C7.6%2C21.7%2C7.6c19.6%2C0%2C35.5-15.9%2C35.5-35.5c0-4.3-0.8-8.5-2.2-12.4%26%2310%3B%26%239%3B%26%239%3BC223.9%2C160.9%2C236.6%2C143.2%2C236.6%2C123.5z%20M91.6%2C34.8c10.9-15.9%2C28.9-25.4%2C48.1-25.4c32.2%2C0%2C58.4%2C26.2%2C58.4%2C58.4%26%2310%3B%26%239%3B%26%239%3Bc0%2C3.9-0.4%2C7.7-1.1%2C11.5l-52.2%2C45.8L93%2C101.5L82.9%2C79.9L91.6%2C34.8z%20M65.4%2C29c6.2%2C0%2C12.1%2C2%2C17%2C5.7l-7.8%2C40.3l-35.5-8.4%26%2310%3B%26%239%3B%26%239%3Bc-1.1-3.1-1.7-6.3-1.7-9.7C37.4%2C41.6%2C49.9%2C29%2C65.4%2C29z%20M9.1%2C112.3c0-16.7%2C11-31.9%2C26.9-37.2L75%2C84.4l9.1%2C19.5l-49.8%2C45%26%2310%3B%26%239%3B%26%239%3BC19.2%2C143.1%2C9.1%2C128.6%2C9.1%2C112.3z%20M145.2%2C200.9c-10.9%2C16.1-29%2C25.6-48.4%2C25.6c-32.3%2C0-58.6-26.3-58.6-58.5c0-4%2C0.4-7.9%2C1.1-11.7%26%2310%3B%26%239%3B%26%239%3Bl50.9-46l52%2C23.7l11.5%2C22L145.2%2C200.9z%20M171.2%2C206.6c-6.1%2C0-12-2-16.9-5.8l7.7-40.2l35.4%2C8.3c1.1%2C3.1%2C1.7%2C6.3%2C1.7%2C9.7%26%2310%3B%26%239%3B%26%239%3BC199.2%2C194.1%2C186.6%2C206.6%2C171.2%2C206.6z%20M200.5%2C160.5l-39-9.1l-10.4-19.8l51-44.7c15.1%2C5.7%2C25.2%2C20.2%2C25.2%2C36.5%26%2310%3B%26%239%3B%26%239%3BC227.4%2C140.1%2C216.4%2C155.3%2C200.5%2C160.5z%22%2F%3E%0A%20%20%3C%2Fg%3E%0A%3C%2Fsvg%3E
------------
*Returns:* `render`
[float]
[[replace_fn]]
=== `replace`
Uses a regular expression to replace parts of a string.
*Accepts:* `string`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `pattern`, `regex`
|`string`
|The text or pattern of a JavaScript regular expression. For example, `"[aeiou]"`.
You can use capturing groups here.
|`flags`
Alias: `modifiers`
|`datatable`
|Specify flags. See the
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp[RegExp documentation]
for reference
Default: `"g"`
|`replacement`
|`string`
|The replacement for the matching parts of `string`. Capturing groups can be accessed
by their index. For example, `$1`.
Default: `""`
|===
*Returns:* `string`
[float]
[[revealImage_fn]]
=== `revealImage`
Configures an image reveal element.
*Accepts:* `number`
[cols="3*^<"]
|===
|Argument |Type |Description
|`image`
|`string`
|The image to reveal. Provide an image asset as a `base64` data URL, or pass in a sub-expression.
|`emptyImage`
|`string`
|An optional background image to reveal over. Provide an image asset as a `base64` data URL, or pass in a sub-expression.
|`origin`
|`string`
|The position to start the image fill. For example, `"top"`, `"left"`, `"bottom"`, or `"right"`
Default: `"bottom"`
|===
Example value for the `image` argument, formatted as a `base64` data URL:
[source, url]
------------
data:image/svg+xml,%3C%3Fxml%20version%3D%221.0%22%20encoding%3D%22utf-8%22%3F%3E%0A%3Csvg%20viewBox%3D%22-3.948730230331421%20-1.7549896240234375%20245.25946044921875%20241.40370178222656%22%20width%3D%22245.25946044921875%22%20height%3D%22241.40370178222656%22%20style%3D%22enable-background%3Anew%200%200%20686.2%20235.7%3B%22%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%3E%0A%20%20%3Cdefs%3E%0A%20%20%20%20%3Cstyle%20type%3D%22text%2Fcss%22%3E%0A%09.st0%7Bfill%3A%232D2D2D%3B%7D%0A%3C%2Fstyle%3E%0A%20%20%3C%2Fdefs%3E%0A%20%20%3Cg%20transform%3D%22matrix%281%2C%200%2C%200%2C%201%2C%200%2C%200%29%22%3E%0A%20%20%20%20%3Cg%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M329.4%2C160.3l4.7-0.5l0.3%2C9.6c-12.4%2C1.7-23%2C2.6-31.8%2C2.6c-11.7%2C0-20-3.4-24.9-10.2%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-4.9-6.8-7.3-17.4-7.3-31.7c0-28.6%2C11.4-42.9%2C34.1-42.9c11%2C0%2C19.2%2C3.1%2C24.6%2C9.2c5.4%2C6.1%2C8.1%2C15.8%2C8.1%2C28.9l-0.7%2C9.3h-53.8%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc0%2C9%2C1.6%2C15.7%2C4.9%2C20c3.3%2C4.3%2C8.9%2C6.5%2C17%2C6.5C312.8%2C161.2%2C321.1%2C160.9%2C329.4%2C160.3z%20M325%2C124.9c0-10-1.6-17.1-4.8-21.2%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-3.2-4.1-8.4-6.2-15.6-6.2c-7.2%2C0-12.7%2C2.2-16.3%2C6.5c-3.6%2C4.3-5.5%2C11.3-5.6%2C20.9H325z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M354.3%2C171.4V64h12.2v107.4H354.3z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M443.5%2C113.5v41.1c0%2C4.1%2C10.1%2C3.9%2C10.1%2C3.9l-0.6%2C10.8c-8.6%2C0-15.7%2C0.7-20-3.4c-9.8%2C4.3-19.5%2C6.1-29.3%2C6.1%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-7.5%2C0-13.2-2.1-17.1-6.4c-3.9-4.2-5.9-10.3-5.9-18.3c0-7.9%2C2-13.8%2C6-17.5c4-3.7%2C10.3-6.1%2C18.9-6.9l25.6-2.4v-7%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc0-5.5-1.2-9.5-3.6-11.9c-2.4-2.4-5.7-3.6-9.8-3.6l-32.1%2C0V87.2h31.3c9.2%2C0%2C15.9%2C2.1%2C20.1%2C6.4C441.4%2C97.8%2C443.5%2C104.5%2C443.5%2C113.5%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bz%20M393.3%2C146.7c0%2C10%2C4.1%2C15%2C12.4%2C15c7.4%2C0%2C14.7-1.2%2C21.8-3.7l3.7-1.3v-26.9l-24.1%2C2.3c-4.9%2C0.4-8.4%2C1.8-10.6%2C4.2%26%2310%3B%26%239%3B%26%239%3B%26%239%3BC394.4%2C138.7%2C393.3%2C142.2%2C393.3%2C146.7z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M491.2%2C98.2c-11.8%2C0-17.8%2C4.1-17.8%2C12.4c0%2C3.8%2C1.4%2C6.5%2C4.1%2C8.1c2.7%2C1.6%2C8.9%2C3.2%2C18.6%2C4.9%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc9.7%2C1.7%2C16.5%2C4%2C20.5%2C7.1c4%2C3%2C6%2C8.7%2C6%2C17.1c0%2C8.4-2.7%2C14.5-8.1%2C18.4c-5.4%2C3.9-13.2%2C5.9-23.6%2C5.9c-6.7%2C0-29.2-2.5-29.2-2.5%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bl0.7-10.6c12.9%2C1.2%2C22.3%2C2.2%2C28.6%2C2.2c6.3%2C0%2C11.1-1%2C14.4-3c3.3-2%2C5-5.4%2C5-10.1c0-4.7-1.4-7.9-4.2-9.6c-2.8-1.7-9-3.3-18.6-4.8%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-9.6-1.5-16.4-3.7-20.4-6.7c-4-2.9-6-8.4-6-16.3c0-7.9%2C2.8-13.8%2C8.4-17.6c5.6-3.8%2C12.6-5.7%2C20.9-5.7c6.6%2C0%2C29.6%2C1.7%2C29.6%2C1.7%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bv10.7C508.1%2C99%2C498.2%2C98.2%2C491.2%2C98.2z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M581.7%2C99.5h-25.9v39c0%2C9.3%2C0.7%2C15.5%2C2%2C18.4c1.4%2C2.9%2C4.6%2C4.4%2C9.7%2C4.4l14.5-1l0.8%2C10.1%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-7.3%2C1.2-12.8%2C1.8-16.6%2C1.8c-8.5%2C0-14.3-2.1-17.6-6.2c-3.3-4.1-4.9-12-4.9-23.6V99.5h-11.6V88.9h11.6V63.9h12.1v24.9h25.9V99.5z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M598.7%2C78.4V64.3h12.2v14.2H598.7z%20M598.7%2C171.4V88.9h12.2v82.5H598.7z%22%2F%3E%0A%20%20%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M663.8%2C87.2c3.6%2C0%2C9.7%2C0.7%2C18.3%2C2l3.9%2C0.5l-0.5%2C9.9c-8.7-1-15.1-1.5-19.2-1.5c-9.2%2C0-15.5%2C2.2-18.8%2C6.6%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-3.3%2C4.4-5%2C12.6-5%2C24.5c0%2C11.9%2C1.5%2C20.2%2C4.6%2C24.9c3.1%2C4.7%2C9.5%2C7%2C19.3%2C7l19.2-1.5l0.5%2C10.1c-10.1%2C1.5-17.7%2C2.3-22.7%2C2.3%26%2310%3B%26%239%3B%26%239%3B%26%239%3Bc-12.7%2C0-21.5-3.3-26.3-9.8c-4.8-6.5-7.3-17.5-7.3-33c0-15.5%2C2.6-26.4%2C7.8-32.6C643%2C90.4%2C651.7%2C87.2%2C663.8%2C87.2z%22%2F%3E%0A%20%20%20%20%3C%2Fg%3E%0A%20%20%20%20%3Cpath%20class%3D%22st0%22%20d%3D%22M236.6%2C123.5c0-19.8-12.3-37.2-30.8-43.9c0.8-4.2%2C1.2-8.4%2C1.2-12.7C207%2C30%2C177%2C0%2C140.2%2C0%26%2310%3B%26%239%3B%26%239%3BC118.6%2C0%2C98.6%2C10.3%2C86%2C27.7c-6.2-4.8-13.8-7.4-21.7-7.4c-19.6%2C0-35.5%2C15.9-35.5%2C35.5c0%2C4.3%2C0.8%2C8.5%2C2.2%2C12.4%26%2310%3B%26%239%3B%26%239%3BC12.6%2C74.8%2C0%2C92.5%2C0%2C112.2c0%2C19.9%2C12.4%2C37.3%2C30.9%2C44c-0.8%2C4.1-1.2%2C8.4-1.2%2C12.7c0%2C36.8%2C29.9%2C66.7%2C66.7%2C66.7%26%2310%3B%26%239%3B%26%239%3Bc21.6%2C0%2C41.6-10.4%2C54.1-27.8c6.2%2C4.9%2C13.8%2C7.6%2C21.7%2C7.6c19.6%2C0%2C35.5-15.9%2C35.5-35.5c0-4.3-0.8-8.5-2.2-12.4%26%2310%3B%26%239%3B%26%239%3BC223.9%2C160.9%2C236.6%2C143.2%2C236.6%2C123.5z%20M91.6%2C34.8c10.9-15.9%2C28.9-25.4%2C48.1-25.4c32.2%2C0%2C58.4%2C26.2%2C58.4%2C58.4%26%2310%3B%26%239%3B%26%239%3Bc0%2C3.9-0.4%2C7.7-1.1%2C11.5l-52.2%2C45.8L93%2C101.5L82.9%2C79.9L91.6%2C34.8z%20M65.4%2C29c6.2%2C0%2C12.1%2C2%2C17%2C5.7l-7.8%2C40.3l-35.5-8.4%26%2310%3B%26%239%3B%26%239%3Bc-1.1-3.1-1.7-6.3-1.7-9.7C37.4%2C41.6%2C49.9%2C29%2C65.4%2C29z%20M9.1%2C112.3c0-16.7%2C11-31.9%2C26.9-37.2L75%2C84.4l9.1%2C19.5l-49.8%2C45%26%2310%3B%26%239%3B%26%239%3BC19.2%2C143.1%2C9.1%2C128.6%2C9.1%2C112.3z%20M145.2%2C200.9c-10.9%2C16.1-29%2C25.6-48.4%2C25.6c-32.3%2C0-58.6-26.3-58.6-58.5c0-4%2C0.4-7.9%2C1.1-11.7%26%2310%3B%26%239%3B%26%239%3Bl50.9-46l52%2C23.7l11.5%2C22L145.2%2C200.9z%20M171.2%2C206.6c-6.1%2C0-12-2-16.9-5.8l7.7-40.2l35.4%2C8.3c1.1%2C3.1%2C1.7%2C6.3%2C1.7%2C9.7%26%2310%3B%26%239%3B%26%239%3BC199.2%2C194.1%2C186.6%2C206.6%2C171.2%2C206.6z%20M200.5%2C160.5l-39-9.1l-10.4-19.8l51-44.7c15.1%2C5.7%2C25.2%2C20.2%2C25.2%2C36.5%26%2310%3B%26%239%3B%26%239%3BC227.4%2C140.1%2C216.4%2C155.3%2C200.5%2C160.5z%22%2F%3E%0A%20%20%3C%2Fg%3E%0A%3C%2Fsvg%3E
------------
*Returns:* `render`
[float]
[[rounddate_fn]]
=== `rounddate`
Uses a MomentJS formatting string to round milliseconds since epoch, and returns milliseconds since epoch.
*Accepts:* `number`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `format`
|`string`
|The MomentJS Format to use for bucketing. For example, `"YYYY-MM"` rounds to months. See https://momentjs.com/docs/#/displaying/.
|===
*Returns:* `number`
[float]
[[rowCount_fn]]
=== `rowCount`
Returns the number of rows. Pairs with <<ply_fn>> to get the count of unique column values, or combinations of unique column values.
*Accepts:* `datatable`
*Returns:* `number`
[float]
[[s_fns]]
== S
[float]
[[seriesStyle_fn]]
=== `seriesStyle`
Creates an object used for describing the properties of a series on a chart. Use <<seriesStyle_fn>> inside of a charting function, like <<plot_fn>> or <<pie_fn>>.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|`label`
|`string`
|The name of the series to style.
|`color`
|`string`
|The line color.
|`lines`
|`number`
|The width of the line.
|`bars`
|`number`
|The width of bars.
|`points`
|`number`
|The size of points on line.
|`fill`
|`number`, `boolean`
|Should we fill in the points?
Default: `false`
|`stack`
|`number`, `null`
|Specifies if the series should be stacked. The number is the stack ID. Series with the same stack ID are stacked together.
|`horizontalBars`
|`boolean`
|Sets the orientation of the bars in the chart to horizontal.
Default: `false`
|===
*Returns:* `seriesStyle`
[float]
[[shape_fn]]
=== `shape`
Creates a shape.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `shape`
|`string`
|Pick a shape
Default: `"square"`
|`border`
Alias `stroke`
|`number`
|An SVG color for the border outlining the shape.
|`borderWidth`
Alias: `strokeWidth`
|`number`
|The thickness of the border
Default: `0`
|`fill`
|`string`
|An SVG color to fill the shape.
Default: `"black"`
|`maintainAspect`
|`boolean`
|Maintain the shape's original aspect ratio?
Default: `false`
|===
*Returns:* shape
[float]
[[sort_fn]]
=== `sort`
Sorts a `datatable` by the specified column.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Alias: `column`
|`string`
|The column to sort by. When unspecified, the `datatable` is sorted by the first column.
|`reverse`
|`boolean`
|Reverse the sorting order? When unspecified, the `datatable` is sorted in ascending order.
Default: `false`
|===
*Returns:* `datatable`
[float]
[[staticColumn_fn]]
=== `staticColumn`
Adds a column with the same static value in every row. See also <<alterColumn_fn>> and <<mapColumn_fn>>.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `column`, `name`
|`string`
|The name of the new column.
|`value`
|`string`, `number`, `boolean`, `null`
|The value to insert in each row in the new column. Tip: use a sub-expression to rollup other columns into a static value.
Default: `null`
|===
*Returns:* `datatable`
[float]
[[string_fn]]
=== `string`
Concatenates all of the arguments into a single string.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ *** †
Alias: `value`
|`string`, `number`, `boolean`
|The values to join together into one string. Include spaces where needed.
|===
*Returns:* `string`
[float]
[[switch_fn]]
=== `switch`
Performs conditional logic with multiple conditions. See also <<case_fn>>, which builds a `case` to pass to the <<switch_fn>> function.
*Accepts:* `any`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ *** †
Alias: `case`
|`case`
|The conditions to check.
|`default`
Alias: `finally`
|`any`
|The value returned when no conditions are met. When unspecified and no conditions are met, the original _context_ is returned.
|===
*Returns:* Depends on your arguments
[float]
[[t_fns]]
== T
[float]
[[table_fn]]
=== `table`
Configures a table element.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|`font`
|`style`
|The CSS font properties for the contents of the table. For example, `font-family` or `font-weight`.
Default: `{font}`
|`paginate`
|`boolean`
|Show pagination controls? When `false`, only the first page is displayed.
Default: `true`
|`perPage`
|`number`
|The number of rows to display on each page.
Default: `10`
|`showHeader`
|`boolean`
|Show or hide the header row with titles for each column.
Default: `true`
|===
*Returns:* `render`
[float]
[[tail_fn]]
=== `tail`
Retrieves the last N rows from the end of a `datatable`. See also <<head_fn>>.
*Accepts:* `datatable`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `count`
|`number`
|The number of rows to retrieve from the end of the datatable.
|===
*Returns:* `datatable`
[float]
[[timefilter_fn]]
=== `timefilter`
Creates a time filter for querying a source.
*Accepts:* `filter`
[cols="3*^<"]
|===
|Argument |Type |Description
|`column`
Alias: `field`, `c`
|`string`
|The column or field that you want to filter.
Default: `"@timestamp"`
|`from`
Alias: `f`, `start`
|`string`
|The beginning of the range, in ISO8601 or {es} `datemath` format
|`to`
Alias: `t`, `end`
|`string`
|The end of the range, in ISO8601 or {es} `datemath` format
|`filterGroup`
|`string`
|The group name for the filter
|===
*Returns:* `filter`
[float]
[[timefilterControl_fn]]
=== `timefilterControl`
Configures a time filter control element.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|`column`
Alias: `field`, `c`
|`string`
|The column or field that you want to filter.
Default: `"@timestamp"`
|`compact`
|`boolean`
|Shows the time filter as a button, which triggers a popover.
Default: `true`
|`filterGroup`
|`string`
|The group name for the filter.
|===
*Returns:* `render`
[float]
[[timelion_fn]]
=== `timelion`
Uses Timelion to extract one or more time series from many sources.
*Accepts:* `filter`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_
Aliases: `q`, `query`
|`string`
|A Timelion query
Default: `".es(*)"`
|`interval`
|`string`
|The bucket interval for the time series
Default: `"auto"`
|`from`
|`string`
|The {es} `datemath` string for the beginning of the time range.
Default: `"now-1y"`
|`to`
|`string`
|The {es} `datemath` string for the end of the time range.
Default: `"now"`
|`timezone`
|`string`
|The timezone for the time range. See [Moment Timezone](https://momentjs.com/timezone/).
Default: `"UTC"`
|===
*Returns:* `datatable`
[float]
[[to_fn]]
=== `to`
Explicitly casts the type of the _context_ from one type to the specified type.
*Accepts:* `any`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Alias: `type`
|`string`
|A known type
|===
*Returns:* Depends on your input and arguments
[float]
[[u_fns]]
== U
[float]
[[urlparam_fn]]
=== `urlparam`
Retrieves a URL parameter to use in an expression. The <<urlparam_fn>> function always returns a `string`. For example, you can retrieve the value `"20"` from the parameter `myVar` from the URL `https://localhost:5601/app/canvas?myVar=20`.
*Accepts:* `null`
[cols="3*^<"]
|===
|Argument |Type |Description
|_Unnamed_ ***
Aliases: `var`, `variable`
|`string`
|The URL hash parameter to retrieve.
|`default`
|`string`
|The string returned when the URL parameter is unspecified.
Default: `""`
|===
*Returns:* `string`
Reference in a new issue View git blame Copy permalink