목차

EVENT_TYPE

OCR 플러그인에서 사용할 수 있는 이벤트 타입입니다.

on(), off() 메소드를 활용해 이벤트에 대한 리스너를 설정하거나 제거할 수 있습니다.

이벤트 타입설명
OCR_DATA_CHANGED
  • OCR Data가 변경되었을 때 발생합니다.
  • 리스너의 parameter로 전달되는 값:
NameTypeDescription
eventobject


{
    type: {string},
    editor: {object},
    requestData: { url: {string}, file: {file}, page: {number} },
    responseData: { response: {object} },
    cached: {boolean}
}
  • type: 이벤트 타입
  • editor: 사이냅 에디터 객체
  • requestData: OCR 요청 데이터
    • url: OCR 요청 URL
    • file: OCR 요청 파일
    • page: OCR 요청 파일 페이지 넘버 
  • responseData: OCR 응답 데이터
    • response: OCR 서버 응답 데이터
  • cached: 캐시 여부


var editor = new SynapEditor(id, synapEditorConfig);
var ocr = editor.plugins.ocr;
var EVENT_TYPE = ocr.EVENT_TYPE;

ocr.on(EVENT_TYPE.OCR_DATA_CHANGED, function (event) {
    console.log(event)
});


on(eventType, listener)

OCR 플러그인에서 발생하는 이벤트에 대한 리스너를 설정합니다.

parameters:

NameTypeDescription
eventTypestring이벤트 타입입니다.
listenerfunction이벤트 리스너입니다.


var editor = new SynapEditor(id, synapEditorConfig);
var ocr = editor.plugins.ocr;
var EVENT_TYPE = ocr.EVENT_TYPE;
var eventListener = function () {};

ocr.on(EVENT_TYPE.OCR_DATA_CHANGED, eventListener);


off(eventType, listener)

OCR 플러그인에서 발생하는 이벤트에 대한 리스너를 제거합니다.

parameters:

NameTypeDescription
eventTypestring이벤트 타입입니다.
listenerfunction이벤트 리스너입니다.


var editor = new SynapEditor(id, synapEditorConfig);
var ocr = editor.plugins.ocr;
var EVENT_TYPE = ocr.EVENT_TYPE;
var eventListener = function () {};

ocr.off(EVENT_TYPE.OCR_DATA_CHANGED, eventListener);

getHTMLByOCRData(ocrData, type, tableRecognition)

OCR을 통해 추출된 이미지 데이터를 기반으로 HTML을 생성하여 문자열로 반환합니다.

Parameters:

Name

Type

Default

Description

ocrData

object

기본값: 없음 (필수 매개변수)

OCR을 통해 추출된 이미지 데이터입니다.

typestring

기본값: 'block'

결과 Box는 좌표 표시 유형입니다.

  • 'line': OCR 데이터가 각 줄(line) 별로 분리되어 HTML로 변환됩니다.
  • 'block': OCR 데이터가 블록(block) 단위로 구분되어 HTML로 변환됩니다.
tableRecognitionboolean기본값: false

인식된 표 영역에 대한 정보 반환 여부입니다.

  • true: 표가 포함된 문서에서 표 구조를 인식하고 이를 table 태그로 반환합니다.
  • false: 표 구조를 별도로 인식하지 않고, 일반 텍스트처럼 처리합니다.

Return:

TypeDescription
string생성된 HTML을 문자열 형태로 반환합니다.

Example:

var ocrData = { /* OCR을 통해 추출된 이미지 데이터 */ };

// 'line' 타입의 경우
var htmlResultLine = editor.plugins.ocr.getHTMLByOCRData(ocrData, 'line', false);

// 'block' 타입의 경우
var htmlResultBlock = editor.plugins.ocr.getHTMLByOCRData(ocrData, 'block', false);

// tableRecognition을 true로 설정한 경우
var htmlResultTable = editor.plugins.ocr.getHTMLByOCRData(ocrData, 'block', true);