kibana/api_docs/expression_repeat_image.json
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -04:00

463 lines
15 KiB
JSON

{
"id": "expressionRepeatImage",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-public.repeatImageRenderer",
"type": "Function",
"tags": [],
"label": "repeatImageRenderer",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
{
"pluginId": "expressionRepeatImage",
"scope": "common",
"docId": "kibExpressionRepeatImagePluginApi",
"section": "def-common.RepeatImageRendererConfig",
"text": "RepeatImageRendererConfig"
},
">"
],
"path": "src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-public.renderers",
"type": "Array",
"tags": [],
"label": "renderers",
"description": [],
"signature": [
"(() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
{
"pluginId": "expressionRepeatImage",
"scope": "common",
"docId": "kibExpressionRepeatImagePluginApi",
"section": "def-common.RepeatImageRendererConfig",
"text": "RepeatImageRendererConfig"
},
">)[]"
],
"path": "src/plugins/expression_repeat_image/public/expression_renderers/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "expressionRepeatImage",
"id": "def-public.ExpressionRepeatImagePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionRepeatImagePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_repeat_image/public/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "expressionRepeatImage",
"id": "def-server.ExpressionRepeatImagePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionRepeatImagePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_repeat_image/server/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.repeatImageFunction",
"type": "Function",
"tags": [],
"label": "repeatImageFunction",
"description": [],
"signature": [
"() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; max: { types: (\"number\" | \"null\")[]; help: string; default: number; }; size: { types: \"number\"[]; default: number; help: string; }; }; fn: (count: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string | null; emptyImage: string | null; size: number; max: number | null; count: number; }; }>; }"
],
"path": "src/plugins/expression_repeat_image/common/expression_functions/repeat_image_function.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.NodeDimensions",
"type": "Interface",
"tags": [],
"label": "NodeDimensions",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.NodeDimensions.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.NodeDimensions.height",
"type": "number",
"tags": [],
"label": "height",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.RepeatImageRendererConfig",
"type": "Interface",
"tags": [],
"label": "RepeatImageRendererConfig",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.RepeatImageRendererConfig.max",
"type": "number",
"tags": [],
"label": "max",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.RepeatImageRendererConfig.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.RepeatImageRendererConfig.emptyImage",
"type": "string",
"tags": [],
"label": "emptyImage",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.RepeatImageRendererConfig.image",
"type": "string",
"tags": [],
"label": "image",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.RepeatImageRendererConfig.size",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.Return",
"type": "Interface",
"tags": [],
"label": "Return",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.Return.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.Return.image",
"type": "string",
"tags": [],
"label": "image",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.Return.size",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.Return.max",
"type": "number",
"tags": [],
"label": "max",
"description": [],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.Return.emptyImage",
"type": "CompoundType",
"tags": [],
"label": "emptyImage",
"description": [],
"signature": [
"string | null"
],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.BASE64",
"type": "string",
"tags": [],
"label": "BASE64",
"description": [],
"signature": [
"\"`base64`\""
],
"path": "src/plugins/expression_repeat_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.CONTEXT",
"type": "string",
"tags": [],
"label": "CONTEXT",
"description": [],
"signature": [
"\"_context_\""
],
"path": "src/plugins/expression_repeat_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.ExpressionRepeatImageFunction",
"type": "Type",
"tags": [],
"label": "ExpressionRepeatImageFunction",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"repeatImage\", number, Arguments, Promise<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"render\", { as: string; value: Arguments; }>>, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>"
],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
"deprecated": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.functions",
"type": "Array",
"tags": [],
"label": "functions",
"description": [],
"signature": [
{
"pluginId": "expressionRepeatImage",
"scope": "common",
"docId": "kibExpressionRepeatImagePluginApi",
"section": "def-common.ExpressionRepeatImageFunction",
"text": "ExpressionRepeatImageFunction"
},
"[]"
],
"path": "src/plugins/expression_repeat_image/common/expression_functions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.OriginString",
"type": "Type",
"tags": [],
"label": "OriginString",
"description": [],
"signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\""
],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionRepeatImage\""
],
"path": "src/plugins/expression_repeat_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionRepeatImage\""
],
"path": "src/plugins/expression_repeat_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRepeatImage",
"id": "def-common.URL",
"type": "string",
"tags": [],
"label": "URL",
"description": [],
"signature": [
"\"URL\""
],
"path": "src/plugins/expression_repeat_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}