kibana/api_docs/expression_shape.json
Stacey Gammon 283223101d
Improve deprecated API list, and update api docs (#106942)
* Code to adjust deprecated api list

* updated docs

* fix and update tests
2021-07-28 12:44:17 -04:00

1739 lines
53 KiB
JSON

{
"id": "expressionShape",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionShape",
"id": "def-public.getDefaultShapeData",
"type": "Function",
"tags": [],
"label": "getDefaultShapeData",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.SvgConfig",
"text": "SvgConfig"
}
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/utils.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.LazyShapeDrawer",
"type": "Function",
"tags": [],
"label": "LazyShapeDrawer",
"description": [],
"signature": [
"React.ExoticComponent<Pick<Pick<",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeDrawerProps",
"text": "ShapeDrawerProps"
},
", \"ref\" | \"shapeType\" | \"shapeAttributes\" | \"shapeContentAttributes\">, \"shapeType\" | \"shapeAttributes\" | \"shapeContentAttributes\"> & React.RefAttributes<",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeRef",
"text": "ShapeRef"
},
">> & { readonly _result: React.ForwardRefExoticComponent<Pick<Pick<",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeDrawerProps",
"text": "ShapeDrawerProps"
},
", \"ref\" | \"shapeType\" | \"shapeAttributes\" | \"shapeContentAttributes\">, \"shapeType\" | \"shapeAttributes\" | \"shapeContentAttributes\"> & React.RefAttributes<",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeRef",
"text": "ShapeRef"
},
">>; }"
],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/index.ts",
"lineNumber": 12
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"source": {
"path": "node_modules/@types/react/index.d.ts",
"lineNumber": 359
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.shapeRenderer",
"type": "Function",
"tags": [],
"label": "shapeRenderer",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.ShapeRendererConfig",
"text": "ShapeRendererConfig"
},
">"
],
"source": {
"path": "src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx",
"lineNumber": 30
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "expressionShape",
"id": "def-public.Dimensions",
"type": "Interface",
"tags": [],
"label": "Dimensions",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/types.ts",
"lineNumber": 18
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.Dimensions.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/types.ts",
"lineNumber": 19
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.Dimensions.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/types.ts",
"lineNumber": 20
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.NodeDimensions",
"type": "Interface",
"tags": [],
"label": "NodeDimensions",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.NodeDimensions.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.NodeDimensions.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 21
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.Output",
"type": "Interface",
"tags": [],
"label": "Output",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.Output",
"text": "Output"
},
" extends Arguments"
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.Output.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"shape\""
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 38
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ParentNodeParams",
"type": "Interface",
"tags": [],
"label": "ParentNodeParams",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ParentNodeParams.borderOffset",
"type": "number",
"tags": [],
"label": "borderOffset",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ParentNodeParams.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ParentNodeParams.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 27
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes",
"type": "Interface",
"tags": [],
"label": "ShapeAttributes",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes.fill",
"type": "string",
"tags": [],
"label": "fill",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes.stroke",
"type": "string",
"tags": [],
"label": "stroke",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes.width",
"type": "CompoundType",
"tags": [],
"label": "width",
"description": [],
"signature": [
"string | number | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes.height",
"type": "CompoundType",
"tags": [],
"label": "height",
"description": [],
"signature": [
"string | number | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 29
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes.viewBox",
"type": "Object",
"tags": [],
"label": "viewBox",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.ViewBoxParams",
"text": "ViewBoxParams"
},
" | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes.overflow",
"type": "CompoundType",
"tags": [],
"label": "overflow",
"description": [],
"signature": [
"string | number | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeAttributes.preserveAspectRatio",
"type": "string",
"tags": [],
"label": "preserveAspectRatio",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 32
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeComponentProps",
"type": "Interface",
"tags": [],
"label": "ShapeComponentProps",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeComponentProps",
"text": "ShapeComponentProps"
},
" extends ",
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.ShapeRendererConfig",
"text": "ShapeRendererConfig"
}
],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/types.ts",
"lineNumber": 13
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeComponentProps.onLoaded",
"type": "Function",
"tags": [],
"label": "onLoaded",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/types.ts",
"lineNumber": 14
},
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeComponentProps.parentNode",
"type": "Object",
"tags": [],
"label": "parentNode",
"description": [],
"signature": [
"HTMLElement"
],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/types.ts",
"lineNumber": 15
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeContentAttributes",
"type": "Interface",
"tags": [],
"label": "ShapeContentAttributes",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 35
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeContentAttributes.strokeWidth",
"type": "CompoundType",
"tags": [],
"label": "strokeWidth",
"description": [],
"signature": [
"string | number | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 36
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeContentAttributes.stroke",
"type": "string",
"tags": [],
"label": "stroke",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 37
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeContentAttributes.fill",
"type": "string",
"tags": [],
"label": "fill",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 38
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeContentAttributes.vectorEffect",
"type": "CompoundType",
"tags": [],
"label": "vectorEffect",
"description": [],
"signature": [
"string | number | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 39
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeContentAttributes.strokeMiterlimit",
"type": "CompoundType",
"tags": [],
"label": "strokeMiterlimit",
"description": [],
"signature": [
"string | number | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 40
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeProps",
"type": "Interface",
"tags": [],
"label": "ShapeProps",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 13
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeProps.shapeAttributes",
"type": "Object",
"tags": [],
"label": "shapeAttributes",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeAttributes",
"text": "ShapeAttributes"
},
" | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 14
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeProps.shapeContentAttributes",
"type": "Object",
"tags": [],
"label": "shapeContentAttributes",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeContentAttributes",
"text": "ShapeContentAttributes"
},
" | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 15
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRef",
"type": "Interface",
"tags": [],
"label": "ShapeRef",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 79
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRef.getData",
"type": "Function",
"tags": [],
"label": "getData",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.SvgConfig",
"text": "SvgConfig"
}
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 80
},
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRendererConfig",
"type": "Interface",
"tags": [],
"label": "ShapeRendererConfig",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRendererConfig.border",
"type": "string",
"tags": [],
"label": "border",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 12
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRendererConfig.borderWidth",
"type": "number",
"tags": [],
"label": "borderWidth",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 13
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRendererConfig.shape",
"type": "Enum",
"tags": [],
"label": "shape",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.Shape",
"text": "Shape"
}
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 14
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRendererConfig.fill",
"type": "string",
"tags": [],
"label": "fill",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 15
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeRendererConfig.maintainAspect",
"type": "boolean",
"tags": [],
"label": "maintainAspect",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.SvgConfig",
"type": "Interface",
"tags": [],
"label": "SvgConfig",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 67
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.SvgConfig.shapeType",
"type": "CompoundType",
"tags": [],
"label": "shapeType",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.SvgElementTypes",
"text": "SvgElementTypes"
},
" | undefined"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 68
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.SvgConfig.viewBox",
"type": "Object",
"tags": [],
"label": "viewBox",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.ViewBoxParams",
"text": "ViewBoxParams"
}
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 69
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.SvgConfig.shapeProps",
"type": "CompoundType",
"tags": [],
"label": "shapeProps",
"description": [],
"signature": [
"(",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeContentAttributes",
"text": "ShapeContentAttributes"
},
" & CircleParams) | (",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeContentAttributes",
"text": "ShapeContentAttributes"
},
" & RectParams) | (",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeContentAttributes",
"text": "ShapeContentAttributes"
},
" & PathParams) | (",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeContentAttributes",
"text": "ShapeContentAttributes"
},
" & PolygonParams)"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 70
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ViewBoxParams",
"type": "Interface",
"tags": [],
"label": "ViewBoxParams",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 30
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ViewBoxParams.minX",
"type": "number",
"tags": [],
"label": "minX",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ViewBoxParams.minY",
"type": "number",
"tags": [],
"label": "minY",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ViewBoxParams.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ViewBoxParams.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 34
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "expressionShape",
"id": "def-public.Shape",
"type": "Enum",
"tags": [],
"label": "Shape",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.SvgElementTypes",
"type": "Enum",
"tags": [],
"label": "SvgElementTypes",
"description": [],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 18
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "expressionShape",
"id": "def-public.ExpressionShapeFunction",
"type": "Type",
"tags": [],
"label": "ExpressionShapeFunction",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"shape\", number | null, Arguments, ",
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.Output",
"text": "Output"
},
", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableState",
">>"
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 41
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.OriginString",
"type": "Type",
"tags": [],
"label": "OriginString",
"description": [],
"signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\""
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.renderers",
"type": "Array",
"tags": [],
"label": "renderers",
"description": [],
"signature": [
"(() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.ShapeRendererConfig",
"text": "ShapeRendererConfig"
},
">)[]"
],
"source": {
"path": "src/plugins/expression_shape/public/expression_renderers/index.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeDrawerComponentProps",
"type": "Type",
"tags": [],
"label": "ShapeDrawerComponentProps",
"description": [],
"signature": [
"{ ref: React.Ref<",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeRef",
"text": "ShapeRef"
},
">; shapeType: string; shapeAttributes?: ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeAttributes",
"text": "ShapeAttributes"
},
" | undefined; shapeContentAttributes?: ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeContentAttributes",
"text": "ShapeContentAttributes"
},
" | undefined; }"
],
"source": {
"path": "src/plugins/expression_shape/public/components/shape/types.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeDrawerProps",
"type": "Type",
"tags": [],
"label": "ShapeDrawerProps",
"description": [],
"signature": [
"{ shapeType: string; getShape: (shapeType: string) => { Component: ({ shapeAttributes, shapeContentAttributes }: ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeProps",
"text": "ShapeProps"
},
") => JSX.Element; data: ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.SvgConfig",
"text": "SvgConfig"
},
"; } | undefined; ref: React.Ref<",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeRef",
"text": "ShapeRef"
},
">; } & ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeProps",
"text": "ShapeProps"
}
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"lineNumber": 73
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-public.ShapeType",
"type": "Type",
"tags": [],
"label": "ShapeType",
"description": [],
"signature": [
"{ Component: ({ shapeAttributes, shapeContentAttributes }: ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.ShapeProps",
"text": "ShapeProps"
},
") => JSX.Element; data: ",
{
"pluginId": "expressionShape",
"scope": "public",
"docId": "kibExpressionShapePluginApi",
"section": "def-public.SvgConfig",
"text": "SvgConfig"
},
"; }"
],
"source": {
"path": "src/plugins/expression_shape/public/components/reusable/shape_factory.tsx",
"lineNumber": 49
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "expressionShape",
"id": "def-public.ExpressionShapePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionShapePluginStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "src/plugins/expression_shape/public/plugin.ts",
"lineNumber": 23
},
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionShape",
"id": "def-common.getAvailableShapes",
"type": "Function",
"tags": [],
"label": "getAvailableShapes",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.Shape",
"text": "Shape"
},
"[]"
],
"source": {
"path": "src/plugins/expression_shape/common/lib/available_shapes.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "expressionShape",
"id": "def-common.NodeDimensions",
"type": "Interface",
"tags": [],
"label": "NodeDimensions",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-common.NodeDimensions.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 20
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.NodeDimensions.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 21
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.Output",
"type": "Interface",
"tags": [],
"label": "Output",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.Output",
"text": "Output"
},
" extends Arguments"
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-common.Output.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"shape\""
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 38
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ParentNodeParams",
"type": "Interface",
"tags": [],
"label": "ParentNodeParams",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-common.ParentNodeParams.borderOffset",
"type": "number",
"tags": [],
"label": "borderOffset",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ParentNodeParams.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 26
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ParentNodeParams.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 27
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ShapeRendererConfig",
"type": "Interface",
"tags": [],
"label": "ShapeRendererConfig",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-common.ShapeRendererConfig.border",
"type": "string",
"tags": [],
"label": "border",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 12
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ShapeRendererConfig.borderWidth",
"type": "number",
"tags": [],
"label": "borderWidth",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 13
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ShapeRendererConfig.shape",
"type": "Enum",
"tags": [],
"label": "shape",
"description": [],
"signature": [
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.Shape",
"text": "Shape"
}
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 14
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ShapeRendererConfig.fill",
"type": "string",
"tags": [],
"label": "fill",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 15
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ShapeRendererConfig.maintainAspect",
"type": "boolean",
"tags": [],
"label": "maintainAspect",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ViewBoxParams",
"type": "Interface",
"tags": [],
"label": "ViewBoxParams",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 30
},
"deprecated": false,
"children": [
{
"parentPluginId": "expressionShape",
"id": "def-common.ViewBoxParams.minX",
"type": "number",
"tags": [],
"label": "minX",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 31
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ViewBoxParams.minY",
"type": "number",
"tags": [],
"label": "minY",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ViewBoxParams.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.ViewBoxParams.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 34
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "expressionShape",
"id": "def-common.Shape",
"type": "Enum",
"tags": [],
"label": "Shape",
"description": [],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "expressionShape",
"id": "def-common.ExpressionShapeFunction",
"type": "Type",
"tags": [],
"label": "ExpressionShapeFunction",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"shape\", number | null, Arguments, ",
{
"pluginId": "expressionShape",
"scope": "common",
"docId": "kibExpressionShapePluginApi",
"section": "def-common.Output",
"text": "Output"
},
", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
"SerializableState",
">>"
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
"lineNumber": 41
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.OriginString",
"type": "Type",
"tags": [],
"label": "OriginString",
"description": [],
"signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\""
],
"source": {
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionShape\""
],
"source": {
"path": "src/plugins/expression_shape/common/constants.ts",
"lineNumber": 9
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionShape\""
],
"source": {
"path": "src/plugins/expression_shape/common/constants.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionShape",
"id": "def-common.SVG",
"type": "string",
"tags": [],
"label": "SVG",
"description": [],
"signature": [
"\"SVG\""
],
"source": {
"path": "src/plugins/expression_shape/common/constants.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}