kibana/docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.expressionrenderdefinition.md
2020-09-30 09:10:28 +02:00

1.9 KiB

Home > kibana-plugin-plugins-expressions-server > ExpressionRenderDefinition

ExpressionRenderDefinition interface

Signature:

export interface ExpressionRenderDefinition<Config = unknown> 

Properties

Property Type Description
displayName string A user friendly name of the renderer as will be displayed to user in UI.
help string Help text as will be displayed to user. A sentence or few about what this element does.
name string 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 type: render object.
render (domNode: HTMLElement, config: Config, handlers: IInterpreterRenderHandlers) => void | Promise<void> The function called to render the output data of an expression.
reuseDomNode boolean Tell the renderer if the dom node should be reused, it's recreated each time by default.
validate () => undefined | Error Used to validate the data before calling the render function.