SDK Expression Editor

[DylanBell]

Hi,

I'm building a custom tool using the UI (Python & React) SDK and wanted to include an Expression Editor in my tool. However, after searching the documentation, a lot of googling, and digging through the SDK files (including the index.js file components are imported from), I can’t find a reference to the Expression Editor anywhere.

I expected to be able to import it by just adding it to this line in my code:

import { AyxAppWrapper, Grid, makeStyles, Theme, Autocomplete, TextField, Button, Box, Card } from '@alteryx/ui';

But as far as I can see it doesn't exist or it's hidden quite well.

Is it possible to use add an Expression Editor in a custom tool? If so I'd appreciate being pointed in the right direction. Otherwise I'd be grateful for any suggestions on workarounds.

Thank you!

[Dean4U]

Hi @DylanBell,

Thank you for reaching out to the community. From what I have read online, the Alteryx UI SDK does not currently provide a pre-built Expression Editor component for direct import into custom tools. However, below are a few links that may help you build an EE in your tool:

- Understanding the structure and behavior of how the existing Alteryx tools implement the Expression Editor can provide valuable insights. Below is the help article to help you with it:

https://help.alteryx.com/2020.1/Reference/expressionbox.htm

- I read that Alteryx allows the creation of custom formula functions accessible across tools that utilize the Expression Editor by writing an XML file or a C-style DLL. Below are a couple of links that may help you:

https://downloads.alteryx.com/betadeveloper/SDK/BuildCustomFormulaFunctions.htm

https://github.com/suren-atoyan/monaco-react

- Check out the Alteryx Platform SDK Quickstart Guide for broader guidance on developing custom tools. It offers comprehensive instructions on setting up your development environment, using the AYX Plugin CLI, and building custom plugins.

https://help.alteryx.com/current/en/developer-help/platform-sdk/platform-sdk-quickstart-guide.html

https://help.alteryx.com/current/en/developer-help.html

Hope some of it helps you out. Reach out to us if you have any further questions or if you found something better. We are here to learn together. :)

Take care.