kibana/api_docs/expression_reveal_image.devdocs.json

{
  "id": "expressionRevealImage",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-public.getRevealImageRenderer",
        "type": "Function",
        "tags": [],
        "label": "getRevealImageRenderer",
        "description": [],
        "signature": [
          "(core: ",
          "CoreStart",
          ") => () => ",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.ExpressionRenderDefinition",
            "text": "ExpressionRenderDefinition"
          },
          "<",
          "RevealImageRendererConfig",
          ">"
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "expressionRevealImage",
            "id": "def-public.getRevealImageRenderer.$1",
            "type": "Object",
            "tags": [],
            "label": "core",
            "description": [],
            "signature": [
              "CoreStart"
            ],
            "path": "src/platform/plugins/shared/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-public.revealImageRendererFactory",
        "type": "Function",
        "tags": [],
        "label": "revealImageRendererFactory",
        "description": [],
        "signature": [
          "(core: ",
          "CoreStart",
          ") => () => ",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.ExpressionRenderDefinition",
            "text": "ExpressionRenderDefinition"
          },
          "<",
          "RevealImageRendererConfig",
          ">"
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "expressionRevealImage",
            "id": "def-public.revealImageRendererFactory.$1",
            "type": "Object",
            "tags": [],
            "label": "core",
            "description": [],
            "signature": [
              "CoreStart"
            ],
            "path": "src/platform/plugins/shared/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "start": {
      "parentPluginId": "expressionRevealImage",
      "id": "def-public.ExpressionRevealImagePluginStart",
      "type": "Type",
      "tags": [],
      "label": "ExpressionRevealImagePluginStart",
      "description": [],
      "signature": [
        "void"
      ],
      "path": "src/platform/plugins/shared/expression_reveal_image/public/plugin.ts",
      "deprecated": false,
      "trackAdoption": false,
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "start": {
      "parentPluginId": "expressionRevealImage",
      "id": "def-server.ExpressionRevealImagePluginStart",
      "type": "Type",
      "tags": [],
      "label": "ExpressionRevealImagePluginStart",
      "description": [],
      "signature": [
        "void"
      ],
      "path": "src/platform/plugins/shared/expression_reveal_image/server/plugin.ts",
      "deprecated": false,
      "trackAdoption": false,
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-common.revealImageFunction",
        "type": "Function",
        "tags": [],
        "label": "revealImageFunction",
        "description": [],
        "signature": [
          "() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; origin: { types: \"string\"[]; help: string; default: string; options: ",
          "Origin",
          "[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ",
          "Origin",
          "; percent: number; }; }>; }"
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/common/expression_functions/reveal_image_function.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-common.BASE64",
        "type": "string",
        "tags": [],
        "label": "BASE64",
        "description": [],
        "signature": [
          "\"`base64`\""
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/common/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-common.functions",
        "type": "Array",
        "tags": [],
        "label": "functions",
        "description": [],
        "signature": [
          "ExpressionRevealImageFunction",
          "[]"
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/common/expression_functions/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-common.PLUGIN_ID",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_ID",
        "description": [],
        "signature": [
          "\"expressionRevealImage\""
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/common/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-common.PLUGIN_NAME",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_NAME",
        "description": [],
        "signature": [
          "\"expressionRevealImage\""
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/common/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "expressionRevealImage",
        "id": "def-common.URL",
        "type": "string",
        "tags": [],
        "label": "URL",
        "description": [],
        "signature": [
          "\"URL\""
        ],
        "path": "src/platform/plugins/shared/expression_reveal_image/common/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}