[Canvas] Clean up expression function definitions #37305

cqliu1 · 2019-05-29T05:28:04Z

Summary

Related to #37614.

Updating all functions definitions to be more accurate/uniform. The changes in #37614 should reflect any updates made in this PR, so it'd be good to review both side-by-side. I tried my best change as little functionality as possible.

Changes:

added content as an alias for the unnamed arg for markdown
flags required arguments as required: true
explicitly defined context type as null for functions that don't use context or pass it along
fix default values
removed null as valid context/arg type where applicable
added fn, exp, function, expression to all args that had a subset of these aliases to be consistent
removed boolean and null as context types and boolean as value type for gt, gte, lt, and lte because these operations only make sense for numbers and sometimes strings
removed obsolete browser and server functions since the interpreter now runs every function in the browser unless it's a server function

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~- [ ] This was checked for cross-browser compatibility, including a check against IE11~~

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~- [ ] This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

elasticmachine · 2019-05-29T21:14:02Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-05-31T06:48:31Z

Pinging @elastic/kibana-canvas

elasticmachine · 2019-05-31T10:28:30Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

w33ble

The only change I'd say is needed here is the required setting on sort.by, the rest is mostly questions.

x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts

x-pack/plugins/canvas/canvas_plugin_src/functions/common/__tests__/axis_config.js

x-pack/plugins/canvas/canvas_plugin_src/functions/common/containerStyle.ts

x-pack/plugins/canvas/canvas_plugin_src/functions/common/plot/series_style_to_flot.ts

x-pack/plugins/canvas/canvas_plugin_src/functions/common/render.ts

x-pack/plugins/canvas/canvas_plugin_src/functions/common/sort.ts

crob611 · 2019-06-05T13:32:40Z

x-pack/plugins/canvas/canvas_plugin_src/functions/common/font.ts

@@ -63,14 +63,14 @@ export function font(): NullContextFunction<'font', Arguments, Style> {
        types: ['boolean'],
      },
      lHeight: {
-        aliases: ['lineHeight'],
+        aliases: ['lineHeight', 'null'],


I think null was supposed to be added to types instead of aliases?

Nice catch! I meant to put to it on types. I'll fix it.

elasticmachine · 2019-06-07T17:49:18Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-07T18:36:02Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

* Cleaned up common function defs fixed broken tests Remove boolean and null as context/arg valid types in lt, lte, gt, and gte Added 'function' alias Updated comparator tests Added neq to options in compare function null audit * Deleted obsolete 'browser' and 'server' functions * More clean up * Removed server and browser function i18n strings * Fixed broken tests * Addressing feedback * Removed browser and server from function_help * Added ts-ignore for constant import * Fixed help text label * Fixed font

* Synced up docs with function defs * Updated docs with changes from PR elastic#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 elastic#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

* 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

* Synced up docs with function defs * Updated docs with changes from PR elastic#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 elastic#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

* [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 * Fixes Canvas doc headers (#40921)

* [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 * Fixes Canvas doc headers (#40921) * Fixed imports

cqliu1 force-pushed the chore/fn-def-clean-up branch 4 times, most recently from 68f3ccf to 096d145 Compare May 29, 2019 19:42

cqliu1 added the Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas label May 31, 2019

cqliu1 added chore release_note:skip Skip the PR/issue when compiling release notes v7.3.0 v8.0.0 labels May 31, 2019

cqliu1 mentioned this pull request May 31, 2019

[Canvas][Docs] Updates Canvas function reference #37614

Closed

3 tasks

cqliu1 force-pushed the chore/fn-def-clean-up branch from 8361fb4 to effaf61 Compare May 31, 2019 09:19

kibanamachine mentioned this pull request May 31, 2019

[Canvas] Canvas documentation #23109

Closed

21 tasks

cqliu1 force-pushed the chore/fn-def-clean-up branch 2 times, most recently from 761a8b7 to ead8fdf Compare June 4, 2019 22:35

cqliu1 requested review from w33ble and crob611 June 4, 2019 22:35

cqliu1 added the review label Jun 4, 2019

cqliu1 marked this pull request as ready for review June 4, 2019 22:35

cqliu1 requested a review from a team as a code owner June 4, 2019 22:35

cqliu1 added release_note:deprecation and removed release_note:skip Skip the PR/issue when compiling release notes labels Jun 4, 2019

w33ble suggested changes Jun 4, 2019

View reviewed changes

crob611 reviewed Jun 5, 2019

View reviewed changes

cqliu1 force-pushed the chore/fn-def-clean-up branch 3 times, most recently from 65bd457 to 125d17c Compare June 6, 2019 17:10

cqliu1 added a commit to cqliu1/kibana that referenced this pull request Jun 6, 2019

Updated docs with changes from PR elastic#37305

43eca25

cqliu1 added 9 commits June 7, 2019 10:33

Deleted obsolete 'browser' and 'server' functions

76aa33f

More clean up

de4ac83

Removed server and browser function i18n strings

bf669e9

Fixed broken tests

ed1ec7d

Addressing feedback

84afcda

Removed browser and server from function_help

1ff55c4

Added ts-ignore for constant import

6f05a61

Fixed help text label

9737e47

Fixed font

91f010d

cqliu1 force-pushed the chore/fn-def-clean-up branch from 6757897 to 91f010d Compare June 7, 2019 17:34

cqliu1 merged commit 3c9182f into elastic:master Jun 7, 2019

cqliu1 deleted the chore/fn-def-clean-up branch June 7, 2019 21:32

cqliu1 mentioned this pull request Jun 7, 2019

[7.x] [Canvas] Clean up expression function definitions (#37305) #38476

Merged

cqliu1 added a commit to cqliu1/kibana that referenced this pull request Jun 20, 2019

Updated docs with changes from PR elastic#37305

20fa578

cqliu1 mentioned this pull request Jul 8, 2019

[Canvas][Docs] Merge Canvas function references #38300

Merged

4 tasks

cqliu1 mentioned this pull request Jul 12, 2019

[Canvas] Comparison Canvas Functions have wonky comparison operators #35433

Closed

KOTungseth mentioned this pull request Apr 30, 2021

[DOCS] Update the Canvas function reference #98934

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Canvas] Clean up expression function definitions #37305

[Canvas] Clean up expression function definitions #37305

cqliu1 commented May 29, 2019 •

edited

Loading

elasticmachine commented May 29, 2019

elasticmachine commented May 31, 2019

elasticmachine commented May 31, 2019

w33ble left a comment

crob611 Jun 5, 2019

cqliu1 Jun 5, 2019

elasticmachine commented Jun 7, 2019

elasticmachine commented Jun 7, 2019

[Canvas] Clean up expression function definitions #37305

[Canvas] Clean up expression function definitions #37305

Conversation

cqliu1 commented May 29, 2019 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented May 29, 2019

💚 Build Succeeded

elasticmachine commented May 31, 2019

elasticmachine commented May 31, 2019

💚 Build Succeeded

w33ble left a comment

Choose a reason for hiding this comment

crob611 Jun 5, 2019

Choose a reason for hiding this comment

cqliu1 Jun 5, 2019

Choose a reason for hiding this comment

elasticmachine commented Jun 7, 2019

💚 Build Succeeded

elasticmachine commented Jun 7, 2019

💚 Build Succeeded

cqliu1 commented May 29, 2019 •

edited

Loading