mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
23 lines
1.9 KiB
Markdown
23 lines
1.9 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) > [ExpressionRenderDefinition](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.md)
|
|
|
|
## ExpressionRenderDefinition interface
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export interface ExpressionRenderDefinition<Config = unknown>
|
|
```
|
|
|
|
## Properties
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [displayName](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.displayname.md) | <code>string</code> | A user friendly name of the renderer as will be displayed to user in UI. |
|
|
| [help](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.help.md) | <code>string</code> | Help text as will be displayed to user. A sentence or few about what this element does. |
|
|
| [name](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.name.md) | <code>string</code> | Technical name of the renderer, used as ID to identify renderer in expression renderer registry. This must match the name of the expression function that is used to create the <code>type: render</code> object. |
|
|
| [render](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.render.md) | <code>(domNode: HTMLElement, config: Config, handlers: IInterpreterRenderHandlers) => void | Promise<void></code> | The function called to render the output data of an expression. |
|
|
| [reuseDomNode](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.reusedomnode.md) | <code>boolean</code> | Tell the renderer if the dom node should be reused, it's recreated each time by default. |
|
|
| [validate](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.validate.md) | <code>() => undefined | Error</code> | Used to validate the data before calling the render function. |
|
|
|