Skip to content

API.Util

Jump to bottom
Redgoose edited this page Oct 11, 2017 · 8 revisions

그 밖에 나머지 기능들을 사용하는 메서드들의 모음입니다.

API 섹션에서 ple 이름으로 인스턴스 변수를 만들어 접근할 수 있다는걸 참고하세요.

toggleSide

사이드 패널을 열거나 닫습니다.

  • @param {Boolean} sw : 이 값을 이용해 열고 닫을 수 있지만 값이 없으면 토글링 됩니다.

Usage

ple.api.util.toggleSide(true); // open side
ple.api.util.toggleSide(false); // close side
ple.api.util.toggleSide(); // toggle side

export

모든 설정값을 내보냅니다.

  • @param {String} type (side,grid,preference,all) : 설정값을 내보낼 부분
    • side: side
    • grid: grid
    • preference: grid preference
    • all: everyone
  • @param {Boolean} isInsertImage : 이미지를 포함할지 결정합니다.
  • @return {Object|Array} : type값에 따라 결과물이 달라집니다.

import

모든 설정값을 가져옵니다. 이전 섹션인 export에서 내보낸 값을 불러오기를 할 수 있습니다.

  • @param {Object} value : 가져올 데이터 값
  • @param {Boolean} replace : value값으로 덮어씌울지에 대한 값

makeImage

이미지를 만듭니다.

  • @param {String} format (jpg|png) : 이미지 포맷
  • @param {Number} quality (.75) : jpg 이미지 퀄리티 0~1
  • @param {Number} sampling (2) : 리샘플링 횟수. 너무 높이면 속도가 급격하게 떨어지니 주의!
  • @param {String} output (canvas|base64) : 출력형식
  • @return {Promise}

Usage

let makeImage = ple.api.util.makeImage('jpg', .75, 1, 'base64');
makeImage.progress(function(total, current, image) {
	console.log('PROGRESS', total, current);
});
makeImage.done(function(src) {
	console.warn('DONE');
	let output = document.getElementById('makeImageArea');
	output.innerHTML = `<img src="${src}" alt="output image"/>`;
});
makeImage.fail(function() {
	console.error('ERROR');
});

Methods

progress

블럭이 한개씩 처리가 끝났으면 한번씩 호출됩니다. 다음 표는 콜백으로 호출되는 함수의 인자값입니다.

  • @param {Number} total : 이미지 총 용량
  • @param {Number} current : 업로드한 이미지 용량
  • @param {HTMLElement} image : 이미지 블럭 Canvas

done

모든 블럭의 처리가 끝났으면 호출됩니다.

  • @param {String|HTMLElement} src : output인자값에서 canvas로 넣었으면 Canvas, base64로 넣었으면 base64 문자코드로 나옵니다.

fail

작업을 하다 오류가 나면 호출됩니다.

  • @param {String} error : Error message

Clone this wiki locally