Catherine Liu
b5e8ab7e67
[Canvas] Update function reference docs ( #156409 )
...
## Summary
Closes #141526 .
This updates the function reference docs for Canvas expressions. The
main update here is the deprecation message added to `filters` function.
I'm also removing an expression example that doesn't work.
<img width="866" alt="Screenshot 2023-05-02 at 9 26 54 AM"
src="https://user-images.githubusercontent.com/1697105/235727031-8ece820e-3db5-42c7-ba11-e94d647a8b84.png ">
@KOTungseth These changes impact as early as v8.4. Should I backport all
the way back through 8.4?
### Checklist
Delete any items that are not applicable to this PR.
- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing ), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md )
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html )
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/ ))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/ ),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US ))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker )
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server ))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers )
### Risk Matrix
Delete this section if it is not applicable to this PR.
Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.
When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:
| Risk | Probability | Severity | Mitigation/Notes |
|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx ) |
### For maintainers
- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process )
---------
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2023-05-03 11:24:47 -07:00
Corey Robertson
933f43d166
[Canvas] Update canvas function docs to match in app and vice versa ( #125259 )
...
* Update canvas function docs to match in app and vice versa
* Update src/plugins/expressions/common/expression_functions/specs/math_column.ts
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
* Update src/plugins/expressions/common/expression_functions/specs/math_column.ts
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
* Fix translations
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-03-01 15:55:11 -05:00
Kaarina Tungseth
97b4ada296
[DOCS] Updates {data-source} in Canvas ( #121216 )
2021-12-14 15:04:21 -06:00
Wylie Conlon
0ef3cbe6ed
[Expressions] Introduce createTable expression function, and use in Lens ( #103788 )
...
* [Expressions] Introduce createTable expression function, and use in Lens
* Fix test
* Fix code style
* Fix typo
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-07-08 10:01:50 -04:00
Wylie Conlon
bdc87409ba
[Lens] Create mathColumn function to improve performance ( #101908 )
...
* [Lens] Create mathColumn function to improve performance
* Fix empty formula case
* Fix tinymath memoization
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-16 10:35:55 -04:00
Michael Dokolin
bde81c2090
[Expressions] Create expressions function to get UI settings ( #101317 )
2021-06-10 15:17:52 +02:00
Kaarina Tungseth
63a177e3fd
Adds canvas clog function ( #96418 )
...
* Add canvas `clog` function in the doc
* Add basic example to the `clog` canvcas function
* clog canvas function: switch definition/purpose
Co-authored-by: Laurent HUET <laurent.huet@gmail.com>
2021-04-07 10:19:29 -05:00
Marco Liberati
019473948f
[Expressions] [Lens] Add id and copyMetaFrom arg to mapColumn fn + add configurable onError argument to math fn ( #90481 )
...
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-02-25 09:43:15 +01:00
Catherine Liu
7c2eb85a7d
[Canvas][Docs] Adds var and var_set to expression function reference ( #74291 )
2020-08-24 15:55:53 -07:00
Catherine Liu
3256992b35
[Canvas] Adds function reference docs generator ( #49402 )
...
Co-authored-by: Corey Robertson <corey.robertson@elastic.co>
2020-08-24 14:28:50 -07:00
Catherine Liu
058044065c
[Canvas] Updates function reference docs ( #64741 )
2020-05-04 10:07:23 -07:00
Kaarina Tungseth
84f6885c36
[DOCS] Removed spatial references ( #59595 )
...
* [DOCS] Removed ss above spatial references
* Removed above from n numeral formatting page
2020-03-09 10:29:25 -05:00
Wylie Conlon
07fec2f725
Documentation for numeral pattern formatting ( #57616 )
...
* Documentation for Elastic Numeral formatting
* Tweaks from feedback
* Updates from feedback
* Fix and update examples
* Add TODOs
* Fix typo
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-02-26 14:17:59 -05:00
Catherine Liu
bcd0c09899
[Canvas][Docs] Updates function reference ( #50393 )
...
* Updates Canvas function reference doc
* Added context examples
* Addressed feedback
* escapes curly braces
* Updated location help text
* Fixes doc build error
2019-11-22 16:05:09 -07:00
Catherine Liu
9482ba5765
Fixed typo in formatnumber example ( #49379 )
2019-10-26 06:25:09 -07:00
Tim Schnell
a4d2638d48
[skip ci] Function Reference Docs Update ( #48791 )
...
* setting up function reference pattern
* adding functions A-F
* grammar fixes
* Apply suggestions from code review
Co-Authored-By: Catherine Liu <catherineqliu@outlook.com>
* more review updates
2019-10-25 12:27:11 -05:00
Catherine Liu
1b477672c2
[Canvas] Format argument for the metric element ( #42007 )
...
* Added numberFormat arg type and metricFormat arg to metric function
Updated function reference doc
Fixed default arg value
* Added stories for NumberFormatArgInput
* Added arg alias
* Added stories for metric renderer
* Fixed ts errors and added comments
* Updated comments
* Removed extra test
* Added snapshots
* Addressing feedback
* Fixed typo
* Updated metricFormat help text
* Removed redundant help prop
2019-08-06 14:47:45 -07:00
Catherine Liu
a90ba21fea
[Canvas] Removes doc links from backticks. ( #41601 )
2019-07-22 10:15:32 -07:00
Catherine Liu
e356de8cd6
[Canvas] Updates esdocs default count to 1000 ( #41604 )
2019-07-19 16:52:10 -07:00
Catherine Liu
b87cc7d27b
[Canvas][Docs]Fixes multi arg annotation ( #40934 )
2019-07-11 17:31:16 -07:00
Catherine Liu
5103e5bee0
Fixes Canvas doc headers ( #40921 )
2019-07-11 15:36:28 -07:00
Catherine Liu
0166246fb8
[Canvas][Docs] Merge Canvas function references ( #38300 )
...
* Synced up docs with function defs
* Updated docs with changes from PR #37305
* Merged canvas function ref into a single doc
* Fixed arg order
* Fixed typo
* Added alphabet links
* Added alphabet headers
* Removed B header
* Added missing args from
* Added edits from PR #37614
* Updated containerStyle
* Removed metafields. ESSQL doesn't support retrieving metafields
* Edits to function copy
* More edits
* More edits
* Final round of edits
* Fixed i18n errors
* Addressing feedback
* Fixed jest test
* Fixed missing import
* Fixed i18n error
* Restored metaFields arg in esdocs
* Extracted i18n string constants
* Fixed i18n errors
* Updated translation files
2019-07-11 14:47:56 -07:00
Lisa Cawley
2af3f7a430
[DOCS] Adds X-Pack icon for Canvas ( #34173 )
2019-04-01 11:26:32 -07:00
gchaps
c52ca4c8b1
[DOCS] Removes beta tag from Canvas docs ( #33630 )
2019-03-21 07:53:14 -07:00
Sarah Hersh
8b304217b5
[DOCS] Adds Kibana docs for Canvas functions ( #26467 )
...
* [DOCS] Migrates Canvas function docs to Kibana docs
* [DOCS] Add docs for TinyMath Canvas functions
2018-12-05 16:02:44 -05:00
