@capacitor-community/image-to-text/dist/docs.json

Image to Text (OCR) Plugin for Capacitor

{
  "api": {
    "name": "CapacitorOcrPlugin",
    "slug": "capacitorocrplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "detectText",
        "signature": "(options: DetectTextFileOptions | DetectTextBase64Options) => Promise<TextDetections>",
        "parameters": [
          {
            "name": "options",
            "docs": "Options for text detection",
            "type": "DetectTextFileOptions | DetectTextBase64Options"
          }
        ],
        "returns": "Promise<TextDetections>",
        "tags": [
          {
            "name": "param",
            "text": "options Options for text detection"
          }
        ],
        "docs": "Detect text in an image",
        "complexTypes": [
          "TextDetections",
          "DetectTextFileOptions",
          "DetectTextBase64Options"
        ],
        "slug": "detecttext"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "TextDetections",
      "slug": "textdetections",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "textDetections",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "TextDetection"
          ],
          "type": "TextDetection[]"
        }
      ]
    },
    {
      "name": "TextDetection",
      "slug": "textdetection",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "bottomLeft",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "[number, number]"
        },
        {
          "name": "bottomRight",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "[number, number]"
        },
        {
          "name": "topLeft",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "[number, number]"
        },
        {
          "name": "topRight",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "[number, number]"
        },
        {
          "name": "text",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "DetectTextFileOptions",
      "slug": "detecttextfileoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "filename",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "orientation",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "ImageOrientation"
          ],
          "type": "ImageOrientation"
        }
      ]
    },
    {
      "name": "DetectTextBase64Options",
      "slug": "detecttextbase64options",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "base64",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "orientation",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "ImageOrientation"
          ],
          "type": "ImageOrientation"
        }
      ]
    }
  ],
  "enums": [
    {
      "name": "ImageOrientation",
      "slug": "imageorientation",
      "members": [
        {
          "name": "Up",
          "value": "'UP'",
          "tags": [],
          "docs": ""
        },
        {
          "name": "Down",
          "value": "'DOWN'",
          "tags": [],
          "docs": ""
        },
        {
          "name": "Left",
          "value": "'LEFT'",
          "tags": [],
          "docs": ""
        },
        {
          "name": "Right",
          "value": "'RIGHT'",
          "tags": [],
          "docs": ""
        }
      ]
    }
  ],
  "typeAliases": [],
  "pluginConfigs": []
}