kibana/api_docs/expression_image.json

{
  "id": "expressionImage",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "expressionImage",
        "id": "def-public.imageRenderer",
        "type": "Function",
        "tags": [],
        "label": "imageRenderer",
        "description": [],
        "signature": [
          "() => ",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.ExpressionRenderDefinition",
            "text": "ExpressionRenderDefinition"
          },
          "<",
          {
            "pluginId": "expressionImage",
            "scope": "common",
            "docId": "kibExpressionImagePluginApi",
            "section": "def-common.ImageRendererConfig",
            "text": "ImageRendererConfig"
          },
          ">"
        ],
        "path": "src/plugins/expression_image/public/expression_renderers/image_renderer.tsx",
        "deprecated": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "expressionImage",
        "id": "def-public.renderers",
        "type": "Array",
        "tags": [],
        "label": "renderers",
        "description": [],
        "signature": [
          "(() => ",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.ExpressionRenderDefinition",
            "text": "ExpressionRenderDefinition"
          },
          "<",
          {
            "pluginId": "expressionImage",
            "scope": "common",
            "docId": "kibExpressionImagePluginApi",
            "section": "def-common.ImageRendererConfig",
            "text": "ImageRendererConfig"
          },
          ">)[]"
        ],
        "path": "src/plugins/expression_image/public/expression_renderers/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "start": {
      "parentPluginId": "expressionImage",
      "id": "def-public.ExpressionImagePluginStart",
      "type": "Type",
      "tags": [],
      "label": "ExpressionImagePluginStart",
      "description": [],
      "signature": [
        "void"
      ],
      "path": "src/plugins/expression_image/public/plugin.ts",
      "deprecated": false,
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "start": {
      "parentPluginId": "expressionImage",
      "id": "def-server.ExpressionImagePluginStart",
      "type": "Type",
      "tags": [],
      "label": "ExpressionImagePluginStart",
      "description": [],
      "signature": [
        "void"
      ],
      "path": "src/plugins/expression_image/server/plugin.ts",
      "deprecated": false,
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.ImageRendererConfig",
        "type": "Interface",
        "tags": [],
        "label": "ImageRendererConfig",
        "description": [],
        "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "expressionImage",
            "id": "def-common.ImageRendererConfig.dataurl",
            "type": "CompoundType",
            "tags": [],
            "label": "dataurl",
            "description": [],
            "signature": [
              "string | null"
            ],
            "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "expressionImage",
            "id": "def-common.ImageRendererConfig.mode",
            "type": "CompoundType",
            "tags": [],
            "label": "mode",
            "description": [],
            "signature": [
              {
                "pluginId": "expressionImage",
                "scope": "common",
                "docId": "kibExpressionImagePluginApi",
                "section": "def-common.ImageMode",
                "text": "ImageMode"
              },
              " | null"
            ],
            "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.NodeDimensions",
        "type": "Interface",
        "tags": [],
        "label": "NodeDimensions",
        "description": [],
        "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "expressionImage",
            "id": "def-common.NodeDimensions.width",
            "type": "number",
            "tags": [],
            "label": "width",
            "description": [],
            "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "expressionImage",
            "id": "def-common.NodeDimensions.height",
            "type": "number",
            "tags": [],
            "label": "height",
            "description": [],
            "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.Return",
        "type": "Interface",
        "tags": [],
        "label": "Return",
        "description": [],
        "path": "src/plugins/expression_image/common/types/expression_functions.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "expressionImage",
            "id": "def-common.Return.type",
            "type": "string",
            "tags": [],
            "label": "type",
            "description": [],
            "signature": [
              "\"image\""
            ],
            "path": "src/plugins/expression_image/common/types/expression_functions.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "expressionImage",
            "id": "def-common.Return.mode",
            "type": "string",
            "tags": [],
            "label": "mode",
            "description": [],
            "path": "src/plugins/expression_image/common/types/expression_functions.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "expressionImage",
            "id": "def-common.Return.dataurl",
            "type": "string",
            "tags": [],
            "label": "dataurl",
            "description": [],
            "path": "src/plugins/expression_image/common/types/expression_functions.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.ImageMode",
        "type": "Enum",
        "tags": [],
        "label": "ImageMode",
        "description": [],
        "path": "src/plugins/expression_image/common/types/expression_functions.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "misc": [
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.BASE64",
        "type": "string",
        "tags": [],
        "label": "BASE64",
        "description": [],
        "signature": [
          "\"`base64`\""
        ],
        "path": "src/plugins/expression_image/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.CONTEXT",
        "type": "string",
        "tags": [],
        "label": "CONTEXT",
        "description": [],
        "signature": [
          "\"_context_\""
        ],
        "path": "src/plugins/expression_image/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.ExpressionImageFunction",
        "type": "Type",
        "tags": [],
        "label": "ExpressionImageFunction",
        "description": [],
        "signature": [
          "() => ",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.ExpressionFunctionDefinition",
            "text": "ExpressionFunctionDefinition"
          },
          "<\"image\", null, Arguments, Promise<",
          {
            "pluginId": "expressionImage",
            "scope": "common",
            "docId": "kibExpressionImagePluginApi",
            "section": "def-common.Return",
            "text": "Return"
          },
          ">, ",
          {
            "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_image/common/types/expression_functions.ts",
        "deprecated": false,
        "returnComment": [],
        "children": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.OriginString",
        "type": "Type",
        "tags": [],
        "label": "OriginString",
        "description": [],
        "signature": [
          "\"top\" | \"bottom\" | \"left\" | \"right\""
        ],
        "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.PLUGIN_ID",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_ID",
        "description": [],
        "signature": [
          "\"expressionImage\""
        ],
        "path": "src/plugins/expression_image/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.PLUGIN_NAME",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_NAME",
        "description": [],
        "signature": [
          "\"expressionImage\""
        ],
        "path": "src/plugins/expression_image/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionImage",
        "id": "def-common.URL",
        "type": "string",
        "tags": [],
        "label": "URL",
        "description": [],
        "signature": [
          "\"URL\""
        ],
        "path": "src/plugins/expression_image/common/constants.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}