[OCR] 플러그인 API

목차

• EVENT_TYPE
• on(eventType, listener)
• off(eventType, listener)
• getHTMLByOCRData(ocrData, type, tableRecognition)

EVENT_TYPE

3.0.2401 버전부터 지원, 2.18.2401 버전부터 지원

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

이벤트에 대한 리스너를 추가하거나 제거하려면 on() 및 off()를 사용합니다.

리스너 매개변수

{
    type: {string},
    editor: {object},
    isSync: {boolean},
    requestData: { url: {string}, file: {file}, page: {number} },
    responseData: { response: {object} },
    cached: {boolean}
}

• type — 이벤트 타입
• editor — Synap Editor 객체
• isSync — 리스너가 동기식인지 여부
• 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;
var options = { sync: true }

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

on(eventType, listener)

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

매개변수

예시

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

ocr.on(EVENT_TYPE.OCR_DATA_CHANGED, eventListener, options);

off(eventType, listener)

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

매개변수

예시

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)

3.0.0 버전부터 지원, 2.18.0 버전부터 지원

OCR로 추출된 이미지 데이터에서 HTML을 생성하고 문자열로 반환합니다.

매개변수

반환값

예시

var ocrData = { /* image data extracted by OCR */ };

// 'line' type
var htmlResultLine = editor.plugins.ocr.getHTMLByOCRData(ocrData, 'line', false);

// 'block' type
var htmlResultBlock = editor.plugins.ocr.getHTMLByOCRData(ocrData, 'block', false);

// with tableRecognition set to true
var htmlResultTable = editor.plugins.ocr.getHTMLByOCRData(ocrData, 'block', true);