mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
126 lines
15 KiB
Markdown
126 lines
15 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)
|
|
|
|
## kibana-plugin-plugins-expressions-public package
|
|
|
|
## Classes
|
|
|
|
| Class | Description |
|
|
| --- | --- |
|
|
| [Execution](./kibana-plugin-plugins-expressions-public.execution.md) | |
|
|
| [ExecutionContract](./kibana-plugin-plugins-expressions-public.executioncontract.md) | <code>ExecutionContract</code> is a wrapper around <code>Execution</code> class. It provides the same functionality but does not expose Expressions plugin internals. |
|
|
| [Executor](./kibana-plugin-plugins-expressions-public.executor.md) | |
|
|
| [ExpressionFunction](./kibana-plugin-plugins-expressions-public.expressionfunction.md) | |
|
|
| [ExpressionFunctionParameter](./kibana-plugin-plugins-expressions-public.expressionfunctionparameter.md) | |
|
|
| [ExpressionRenderer](./kibana-plugin-plugins-expressions-public.expressionrenderer.md) | |
|
|
| [ExpressionRendererRegistry](./kibana-plugin-plugins-expressions-public.expressionrendererregistry.md) | |
|
|
| [ExpressionRenderHandler](./kibana-plugin-plugins-expressions-public.expressionrenderhandler.md) | |
|
|
| [ExpressionsPublicPlugin](./kibana-plugin-plugins-expressions-public.expressionspublicplugin.md) | |
|
|
| [ExpressionsService](./kibana-plugin-plugins-expressions-public.expressionsservice.md) | <code>ExpressionsService</code> class is used for multiple purposes:<!-- -->1. It implements the same Expressions service that can be used on both: (1) server-side and (2) browser-side. 2. It implements the same Expressions service that users can fork/clone, thus have their own instance of the Expressions plugin. 3. <code>ExpressionsService</code> defines the public contracts of \*setup\* and \*start\* Kibana Platform life-cycles for ease-of-use on server-side and browser-side. 4. <code>ExpressionsService</code> creates a bound version of all exported contract functions. 5. Functions are bound the way there are:<!-- -->\`\`\`<!-- -->ts registerFunction = (...args: Parameters<!-- --><<!-- -->Executor\['registerFunction'\]<!-- -->> ): ReturnType<!-- --><<!-- -->Executor\['registerFunction'\]<!-- -->> =<!-- -->> this.executor.registerFunction(...args); \`\`\`<!-- -->so that JSDoc appears in developers IDE when they use those <code>plugins.expressions.registerFunction(</code>. |
|
|
| [ExpressionType](./kibana-plugin-plugins-expressions-public.expressiontype.md) | |
|
|
| [FunctionsRegistry](./kibana-plugin-plugins-expressions-public.functionsregistry.md) | |
|
|
| [TypesRegistry](./kibana-plugin-plugins-expressions-public.typesregistry.md) | |
|
|
|
|
## Enumerations
|
|
|
|
| Enumeration | Description |
|
|
| --- | --- |
|
|
| [FontStyle](./kibana-plugin-plugins-expressions-public.fontstyle.md) | Enum of supported CSS <code>font-style</code> properties. |
|
|
| [FontWeight](./kibana-plugin-plugins-expressions-public.fontweight.md) | Enum of supported CSS <code>font-weight</code> properties. |
|
|
| [Overflow](./kibana-plugin-plugins-expressions-public.overflow.md) | Enum of supported CSS <code>overflow</code> properties. |
|
|
| [TextAlignment](./kibana-plugin-plugins-expressions-public.textalignment.md) | Enum of supported CSS <code>text-align</code> properties. |
|
|
| [TextDecoration](./kibana-plugin-plugins-expressions-public.textdecoration.md) | Enum of supported CSS <code>text-decoration</code> properties. |
|
|
|
|
## Functions
|
|
|
|
| Function | Description |
|
|
| --- | --- |
|
|
| [buildExpression(initialState)](./kibana-plugin-plugins-expressions-public.buildexpression.md) | Makes it easy to progressively build, update, and traverse an expression AST. You can either start with an empty AST, or provide an expression string, AST, or array of expression function builders to use as initial state. |
|
|
| [buildExpressionFunction(fnName, initialArgs)](./kibana-plugin-plugins-expressions-public.buildexpressionfunction.md) | Manages an AST for a single expression function. The return value can be provided to <code>buildExpression</code> to add this function to an expression.<!-- -->Note that to preserve type safety and ensure no args are missing, all required arguments for the specified function must be provided up front. If desired, they can be changed or removed later. |
|
|
| [format(ast, type)](./kibana-plugin-plugins-expressions-public.format.md) | |
|
|
| [formatExpression(ast)](./kibana-plugin-plugins-expressions-public.formatexpression.md) | Given expression pipeline AST, returns formatted string. |
|
|
| [isExpressionAstBuilder(val)](./kibana-plugin-plugins-expressions-public.isexpressionastbuilder.md) | Type guard that checks whether a given value is an <code>ExpressionAstExpressionBuilder</code>. This is useful when working with subexpressions, where you might be retrieving a function argument, and need to know whether it is an expression builder instance which you can perform operations on. |
|
|
| [parse(expression, startRule)](./kibana-plugin-plugins-expressions-public.parse.md) | |
|
|
| [parseExpression(expression)](./kibana-plugin-plugins-expressions-public.parseexpression.md) | Given expression pipeline string, returns parsed AST. |
|
|
| [plugin(initializerContext)](./kibana-plugin-plugins-expressions-public.plugin.md) | |
|
|
|
|
## Interfaces
|
|
|
|
| Interface | Description |
|
|
| --- | --- |
|
|
| [Datatable](./kibana-plugin-plugins-expressions-public.datatable.md) | A <code>Datatable</code> in Canvas is a unique structure that represents tabulated data. |
|
|
| [DatatableColumn](./kibana-plugin-plugins-expressions-public.datatablecolumn.md) | This type represents the shape of a column in a <code>Datatable</code>. |
|
|
| [ExecutionContext](./kibana-plugin-plugins-expressions-public.executioncontext.md) | <code>ExecutionContext</code> is an object available to all functions during a single execution; it provides various methods to perform side-effects. |
|
|
| [ExecutionParams](./kibana-plugin-plugins-expressions-public.executionparams.md) | |
|
|
| [ExecutionState](./kibana-plugin-plugins-expressions-public.executionstate.md) | |
|
|
| [ExecutorState](./kibana-plugin-plugins-expressions-public.executorstate.md) | |
|
|
| [ExpressionAstExpressionBuilder](./kibana-plugin-plugins-expressions-public.expressionastexpressionbuilder.md) | |
|
|
| [ExpressionAstFunctionBuilder](./kibana-plugin-plugins-expressions-public.expressionastfunctionbuilder.md) | |
|
|
| [ExpressionExecutor](./kibana-plugin-plugins-expressions-public.expressionexecutor.md) | |
|
|
| [ExpressionFunctionDefinition](./kibana-plugin-plugins-expressions-public.expressionfunctiondefinition.md) | <code>ExpressionFunctionDefinition</code> is the interface plugins have to implement to register a function in <code>expressions</code> plugin. |
|
|
| [ExpressionFunctionDefinitions](./kibana-plugin-plugins-expressions-public.expressionfunctiondefinitions.md) | A mapping of <code>ExpressionFunctionDefinition</code>s for functions which the Expressions services provides out-of-the-box. Any new functions registered by the Expressions plugin should have their types added here. |
|
|
| [ExpressionImage](./kibana-plugin-plugins-expressions-public.expressionimage.md) | |
|
|
| [ExpressionRenderDefinition](./kibana-plugin-plugins-expressions-public.expressionrenderdefinition.md) | |
|
|
| [ExpressionRendererEvent](./kibana-plugin-plugins-expressions-public.expressionrendererevent.md) | |
|
|
| [ExpressionRenderError](./kibana-plugin-plugins-expressions-public.expressionrendererror.md) | |
|
|
| [ExpressionsServiceStart](./kibana-plugin-plugins-expressions-public.expressionsservicestart.md) | The public contract that <code>ExpressionsService</code> provides to other plugins in Kibana Platform in \*start\* life-cycle. |
|
|
| [ExpressionsStart](./kibana-plugin-plugins-expressions-public.expressionsstart.md) | Expressions public start contrect, extends |
|
|
| [ExpressionTypeDefinition](./kibana-plugin-plugins-expressions-public.expressiontypedefinition.md) | A generic type which represents a custom Expression Type Definition that's registered to the Interpreter. |
|
|
| [ExpressionTypeStyle](./kibana-plugin-plugins-expressions-public.expressiontypestyle.md) | An object that represents style information, typically CSS. |
|
|
| [Font](./kibana-plugin-plugins-expressions-public.font.md) | An interface representing a font in Canvas, with a textual label and the CSS <code>font-value</code>. |
|
|
| [IExpressionLoaderParams](./kibana-plugin-plugins-expressions-public.iexpressionloaderparams.md) | |
|
|
| [IInterpreterRenderHandlers](./kibana-plugin-plugins-expressions-public.iinterpreterrenderhandlers.md) | |
|
|
| [IRegistry](./kibana-plugin-plugins-expressions-public.iregistry.md) | |
|
|
| [PointSeriesColumn](./kibana-plugin-plugins-expressions-public.pointseriescolumn.md) | Column in a PointSeries |
|
|
| [Range](./kibana-plugin-plugins-expressions-public.range.md) | |
|
|
| [ReactExpressionRendererProps](./kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.md) | |
|
|
| [SerializedDatatable](./kibana-plugin-plugins-expressions-public.serializeddatatable.md) | |
|
|
| [SerializedFieldFormat](./kibana-plugin-plugins-expressions-public.serializedfieldformat.md) | JSON representation of a field formatter configuration. Is used to carry information about how to format data in a data table as part of the column definition. |
|
|
|
|
## Variables
|
|
|
|
| Variable | Description |
|
|
| --- | --- |
|
|
| [ReactExpressionRenderer](./kibana-plugin-plugins-expressions-public.reactexpressionrenderer.md) | |
|
|
|
|
## Type Aliases
|
|
|
|
| Type Alias | Description |
|
|
| --- | --- |
|
|
| [AnyExpressionFunctionDefinition](./kibana-plugin-plugins-expressions-public.anyexpressionfunctiondefinition.md) | Type to capture every possible expression function definition. |
|
|
| [AnyExpressionTypeDefinition](./kibana-plugin-plugins-expressions-public.anyexpressiontypedefinition.md) | |
|
|
| [ArgumentType](./kibana-plugin-plugins-expressions-public.argumenttype.md) | This type represents all of the possible combinations of properties of an Argument in an Expression Function. The presence or absence of certain fields influence the shape and presence of others within each <code>arg</code> in the specification. |
|
|
| [DatatableColumnType](./kibana-plugin-plugins-expressions-public.datatablecolumntype.md) | This type represents the <code>type</code> of any <code>DatatableColumn</code> in a <code>Datatable</code>. its duplicated from KBN\_FIELD\_TYPES |
|
|
| [DatatableRow](./kibana-plugin-plugins-expressions-public.datatablerow.md) | This type represents a row in a <code>Datatable</code>. |
|
|
| [ExecutionContainer](./kibana-plugin-plugins-expressions-public.executioncontainer.md) | |
|
|
| [ExecutorContainer](./kibana-plugin-plugins-expressions-public.executorcontainer.md) | |
|
|
| [ExpressionAstArgument](./kibana-plugin-plugins-expressions-public.expressionastargument.md) | |
|
|
| [ExpressionAstExpression](./kibana-plugin-plugins-expressions-public.expressionastexpression.md) | |
|
|
| [ExpressionAstFunction](./kibana-plugin-plugins-expressions-public.expressionastfunction.md) | |
|
|
| [ExpressionAstNode](./kibana-plugin-plugins-expressions-public.expressionastnode.md) | |
|
|
| [ExpressionRendererComponent](./kibana-plugin-plugins-expressions-public.expressionrenderercomponent.md) | |
|
|
| [ExpressionsServiceSetup](./kibana-plugin-plugins-expressions-public.expressionsservicesetup.md) | The public contract that <code>ExpressionsService</code> provides to other plugins in Kibana Platform in \*setup\* life-cycle. |
|
|
| [ExpressionsSetup](./kibana-plugin-plugins-expressions-public.expressionssetup.md) | Expressions public setup contract, extends [ExpressionsServiceSetup](./kibana-plugin-plugins-expressions-public.expressionsservicesetup.md) |
|
|
| [ExpressionValue](./kibana-plugin-plugins-expressions-public.expressionvalue.md) | |
|
|
| [ExpressionValueBoxed](./kibana-plugin-plugins-expressions-public.expressionvalueboxed.md) | |
|
|
| [ExpressionValueConverter](./kibana-plugin-plugins-expressions-public.expressionvalueconverter.md) | |
|
|
| [ExpressionValueError](./kibana-plugin-plugins-expressions-public.expressionvalueerror.md) | |
|
|
| [ExpressionValueFilter](./kibana-plugin-plugins-expressions-public.expressionvaluefilter.md) | Represents an object that is a Filter. |
|
|
| [ExpressionValueNum](./kibana-plugin-plugins-expressions-public.expressionvaluenum.md) | |
|
|
| [ExpressionValueRender](./kibana-plugin-plugins-expressions-public.expressionvaluerender.md) | Represents an object that is intended to be rendered. |
|
|
| [ExpressionValueUnboxed](./kibana-plugin-plugins-expressions-public.expressionvalueunboxed.md) | |
|
|
| [FontLabel](./kibana-plugin-plugins-expressions-public.fontlabel.md) | This type contains a unions of all supported font labels, or the the name of the font the user would see in a UI. |
|
|
| [FontValue](./kibana-plugin-plugins-expressions-public.fontvalue.md) | This type contains a union of all supported font values, equivalent to the CSS <code>font-value</code> property. |
|
|
| [InterpreterErrorType](./kibana-plugin-plugins-expressions-public.interpretererrortype.md) | |
|
|
| [KnownTypeToString](./kibana-plugin-plugins-expressions-public.knowntypetostring.md) | Map the type of the generic to a string-based representation of the type.<!-- -->If the provided generic is its own type interface, we use the value of the <code>type</code> key as a string literal type for it. |
|
|
| [PointSeries](./kibana-plugin-plugins-expressions-public.pointseries.md) | A <code>PointSeries</code> is a unique structure that represents dots on a chart. |
|
|
| [PointSeriesColumnName](./kibana-plugin-plugins-expressions-public.pointseriescolumnname.md) | Allowed column names in a PointSeries |
|
|
| [PointSeriesColumns](./kibana-plugin-plugins-expressions-public.pointseriescolumns.md) | Represents a collection of valid Columns in a PointSeries |
|
|
| [PointSeriesRow](./kibana-plugin-plugins-expressions-public.pointseriesrow.md) | |
|
|
| [ReactExpressionRendererType](./kibana-plugin-plugins-expressions-public.reactexpressionrenderertype.md) | |
|
|
| [Style](./kibana-plugin-plugins-expressions-public.style.md) | |
|
|
| [TypeString](./kibana-plugin-plugins-expressions-public.typestring.md) | If the type extends a Promise, we still need to return the string representation:<code>someArgument: Promise<boolean | string></code> results in <code>types: ['boolean', 'string']</code> |
|
|
| [TypeToString](./kibana-plugin-plugins-expressions-public.typetostring.md) | This can convert a type into a known Expression string representation of that type. For example, <code>TypeToString<Datatable></code> will resolve to <code>'datatable'</code>. This allows Expression Functions to continue to specify their type in a simple string format. |
|
|
| [UnmappedTypeStrings](./kibana-plugin-plugins-expressions-public.unmappedtypestrings.md) | Types used in Expressions that don't map to a primitive cleanly:<code>date</code> is typed as a number or string, and represents a date |
|
|
|