1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목의 상태를 변경한다.

로컬 자원은 업로드가 완료되면 status 값이 "DONE"으로 변경된다. status가 "DONE"인 대상은 다시 업로드가 되지 않는다.

파일 업로드 작업이 없이 바로 "DONE"으로 변경하거나, 업로드가 완료된 대상을 "WAIT" 상태로 변경할 수 있다.

// 주어진 고유 아이디에 해당하는 항목을 "WAIT" 상태로 변경한다.
dx.changeStatus(id, "WAIT");

형식

component.changeStatus(id, status);

파라미터

1.0.0.0 이상

설명

로컬 자원 항목을 가상 파일로 변경한다.

로컬 자원을 가상 파일로 변경하여 사용할 수도 있다.

반대로 가상 파일을 로컬 파일로 변경하는 기능은 제공하지 않는다.

// 로컬 파일 항목을 가상 파일 항목으로 변경한다.
dx.changeToVirtualFile(id, "http://.../...", "http://domain/path/...");
// 다운로드 혹은 열기 URL 정보 없이 사용하는 경우 빈 문자열을 입력한다.
dx.changeToVirtualFile(id, "", "");

형식

component.changeToVirtualFile(id, openUrl, downUrl);

파라미터

1.0.0.0 이상

설명

모든 항목을 체크(또는 해지) 상태로 변경한다.

// 모든 항목을 체크 상태로 변경한다.
dx.checkAll(true);

checkAll 메소드는 파일이 목록에 등록되는 과정 중에 사용을 하면 오류가 발생한다. 가상 파일과 로컬 파일을 등록하는 과정이 내부적으로 비동기로 동작한다. 로컬 파일의 경우에는 파일 등록이 완료되면 onDX5ItemsAdded 콜백 함수가 호출되므로 해당 콜백함수가 실행된 이후에 checkAll을 사용하면 되고, 가상 파일은 addVirtualFile, addVirtualFileList를 사용하여 등록할 때 checked: true 속성을 함께 주면 체크된 상태로 목록에 추가할 수 있다.

형식

component.checkAll(allOrNot);

파라미터

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목을 체크(또는 해지) 상태로 변경한다.

// 주어진 고유 아이디에 해당하는 항목을 체크 상태로 변경한다.
dx.checkById(id, true);
// 주어진 고유 아이디에 해당하는 항목을 체크 해지 상태로 변경한다.
dx.checkById(id, false);

형식

component.checkById(id, checked);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 체크(또는 해지) 상태로 변경한다.

// 주어진 순서에 해당하는 항목을 체크 상태로 변경한다.
dx.checkByIndex(index, true);
// 주어진 순서에 해당하는 항목을 체크 해지 상태로 변경한다.
dx.checkByIndex(index, false);

형식

component.checkByIndex(id, checked);

파라미터

1.0.0.0 이상

설명

중복 검사를 수행할지 여부를 설정한다.

파라미터가 true이면 중복검사를 수행하므로 중복을 허용하지 않는다.

중복이란, 같은 경로의 파일을 추가로 등록할 수 있는 경우에 발생한다.

브라우저 상에서 중복 검사는 로컬 자원의 이름과 크기, 최근 수정 시간을 통해서만 비교가 가능하다.

더불어 가상 파일은 중복 검사 대상이 아니다.

// 항목이 추가될 때마다 중복 검사를 수행한다.
dx.checkDuplication(true);

형식

component.checkDuplication(enable);

파라미터

1.0.0.0 이상

설명

항목을 제거한다.

파라미터가 정해지지 않으면, 모든 항목을 제거한다.

DEXTUploadX5에서 '삭제'와 '제거'는 다르게 구분한다.

삭제하려는 대상이 가상 파일인 경우, 가상 파일은 제거가 되지 않고 내부적으로 삭제된 상태로만 관리가 된다.

clearItems를 사용하면, 관리없이 완전히 제거가 된다.

// 로컬 파일 항목을 모두 제거한다.
dx.clearItems("FILE");
// 모든 항목을 제거한다.
dx.clearItems();

형식

component.clearItems([flag]);

파라미터

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목의 메타 데이터를 삭제한다.

항목은 "이름[구분자]값" 형식의 메타 데이터를 여러개 가질 수 있다.

메타 데이터는 업로드가 될 때, 서버로 전송이 되며, 순수 파일외에 다른 정보를 함께 전달하는 용도로 사용된다.

가상 파일은 업로드가 되지 않으므로 서버로 메타 데이터가 전달되지 않는다.

메타 데이터를 삭제하려면 삭제할 메타 데이터의 이름이 필요한다.

dx.setMetaDataById(id, "userid", "honggildong");
// "honggildong"이 출력된다.
console.log(dx.getMetaDataById(id, "userid"));
// 메타데이터를 삭제한다.
dx.deleteMetaDataById(id, "userid");
						

형식

component.deleteMetaDataById(id, name);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목의 메타 데이터를 삭제한다.

항목은 "이름[구분자]값" 형식의 메타 데이터를 여러개 가질 수 있다.

메타 데이터는 업로드가 될 때, 서버로 전송이 되며, 순수 파일외에 다른 정보를 함께 전달하는 용도로 사용된다.

가상 파일은 업로드가 되지 않으므로 서버로 메타 데이터가 전달되지 않는다.

메타 데이터를 삭제하려면 삭제할 메타 데이터의 이름이 필요한다.

// 6번 째 항목에 메타 데이터를 설정한다.
dx.setMetaDataByindex(5, "userid", "honggildong");
// "honggildong"이 출력된다.
console.log(dx.getMetaDataByIndex(5, "userid"));
// 메타데이터를 삭제한다.
dx.deleteMetaDataByIndex(5, "userid");
						

형식

component.deleteMetaDataByIndex(index, name);

파라미터

1.0.0.0 이상

설명

DEXTUploadX5는 데스크톱 프로그램 실행 기능을 제공하지 않는다.

대신 브라우저로 열 수 있는 파일이라면 새 창으로 대상을 열 수 있다. 일반적으로 브라우저가 열 수 있는 파일은 이미지처럼 한정적이다.

열기가 가능한 대상은 는는시 openUrl 속성 값을 가지고 있는 가상 파일이어야 한다.

// openUrl 속성에 다운로드 웹 경로가 존재해야 한다.
dx.addVirtualFile({ ... name: "서강대교_509147.jpg", openUrl: "http://.../service/common-open.do?key=FID0001" });

컴포넌트 화면에는 대상을 바로 열 수 있는 열기 아이콘이 있다.만약 스크립트를 사용하여 대상을 열려면 executeItem 함수를 사용해야 한다.

// 네 번째 항목(가상 파일)을 연다. 
dx.executeItem(3);

형식

component.executeItem(index);

파라미터

1.0.0.0 이상

설명

인증키 문자열을 반환한다.

인증키는 dextuploadx5-configuration.js 파일의 authkey 속성에 설정되어있다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 인증키를 출력한다.
  console.log(dx.getAuthkey());
}

형식

authkey = component.getAuthkey();

반환

인증키 문자열

1.0.0.0 이상

설명

자동 정렬 방식을 반환한다.

형식

stype = component.getAutoSortingType();

반환

자동 정렬 방식

1.0.0.0 이상

설명

자동 정렬 방식을 설정한다.

설정값이 1, 2이면 항목이 추가될 때마다 자동으로 정렬된다.

// 오름차순으로 자동정렬이 되도록 설정한다.
dx.setAutoSortingType(1);
// 자동정렬 방식을 출력한다.
console.log(dx.getAutoSortingType());

형식

component.setAutoSortingType(stype);

파라미터

1.0.0.0 이상

설명

체크 상태인 항목의 고유 아이디 값을 요소로 갖는 배열을 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 카운트된 값이 반환된다.

// 체크된 항목의 고유 아이디 값을 요소로 갖는 배열을 얻는다.
ids = dx.getCheckedIds();
// 체크된 로컬 자원의 고유 아이디를 얻으려면 파라미터를 true로 설정한다.
ids = dx.getCheckedIds(true);

형식

ids = component.getCheckedIds([onlyLocal]);

파라미터

반환

체크 상태인 항목의 고유 아이디 값을 요소로 갖는 배열

1.0.0.0 이상

설명

체크 상태인 항목을 요소로 갖는 배열을 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 카운트된 값이 반환된다.

// 체크된 항목들만 배열로 묶어 반환한다.
var checkeds = dx.getCheckedItems();

형식

items = component.getCheckedItems([onlyLocal]);

파라미터

반환

체크 상태인 항목을 요소로 갖는 배열

2.0.0.0 이상

설명

주어진 사용자 정의 헤더 이름에 해당하는 값을 반환한다.

형식

value = component.getCustomHeader(name);

파라미터

반환

사용자 정의 헤더의 값. 없을 경우 null을 반환한다.

2.0.0.0 이상

설명

사용자 정의 헤더를 새로 설정하거나, 값을 변경한다.

DEXTUploadX5는 파일을 업로드하거나 다운로드할 때, 사용자 정의 헤더를 HTTP 요청에 함께 실어 보낼 수 있다.

setCustomHeader 메소드를 사용하여 사용자 정의 헤더를 설정할 수 있으며, getCustomHeader 메소드를 사용하여 헤더 값을 확인할 수 있다.

한번 사용자 정의 헤더가 설정되면, 이후 모든 요청에 헤더를 포함하여 보기 때문에, 만일 헤더가 필요하지 않은 상황이라면 removeCustomHeader 메소드를 사용하여 이미 설정된 헤더를 제거할 수 있다.

// 사용자 정의 헤더를 설정한다.
dx.setCustomHeader("X-Third-Party-Name", "DEXTUploadX5");
// 사용자 정의 헤더 값을 확인한다.
value = dx.getCustomHeader("X-Third-Party-Name");
// 대상 헤더를 삭제한다.
dx.removeCustomHeader("X-Third-Party-Name")

헤더 이름과 값은 제품 내부적으로 인코딩 처리를 하지 않기 때문에, 인코딩이 필요한 상황이라면 직접 처리해주어야 한다.

크로스 도메인으로 요청을 하는 상황이라면 CORS(Cross-Origin Resource Sharing) 설정 여부에 따라 사용자 정의 헤더를 서버 측에서 허용하지 않을 수도 있다. 그러므로 사용자 정의 헤더를 성공적으로 전달하기 위해서는 Access-Control-Allow-Headers 응답 헤더를 이용하여 사용자 정의 헤더를 허용하거나, 서버(웹) 플랫폼에 맞도록 설정을 해주어야 한다.

Amazon S3로 업로드를 하거나 다운로드를 할 때에는 사용자 정의 헤더를 전달하지 않는다.

형식

component.getCustomHeader(name, value);

파라미터

1.0.0.0 이상

설명

공백을 대표하는 문자열을 반환한다.

형식

splitter = component.getEmptyString();

반환

공백용 문자열, 기본값은 "[EMPTY]"이다.

1.0.0.0 이상

설명

공백용 문자열을 설정한다.

현재 사용되는 곳은 없다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 공백용 문자를 파이프라인 문자([e])로 설정한다.
  dx.setEmptyString("[e]");
  // 공백용 문자를 출력한다.
  console.log(dx.getEmptyString());
}

형식

component.setEmptyString(str);

파라미터

1.0.0.0 이상

설명

헤더의 칼럼을 클릭하면 정렬 기능이 동작하는지를 반환한다.

형식

enable = component.getEnableColumnSorting();

반환

헤더 정렬이 가능하면 true, 아니면 false

1.0.0.0 이상

설명

헤더의 칼럼을 클릭하면 정렬 기능이 동작하도록 할지를 설정한다.

// 헤더 칼럼을 클릭하면 정렬이 되도록 설정한다.
dx.setEnableColumnSorting(true);
// 칼럼을 클릭하면 정렬이 되는지 출력한다.
console.log(dx.getEnableColumnSorting());

형식

component.setEnableColumnSorting(enable);

파라미터

1.0.0.0 이상

설명

확장자 필터링 처리를 위한 문자열 정보를 반환한다.

형식

strFilter = component.getExtensionFilter([reverse]);

파라미터

반환

확장자 필터링 처리를 위한 문자열

예시: *.jpg;*.jpeg;*.gif;*.bmp;*.txt

1.0.0.0 이상

설명

확장자 필터링 처리를 위한 문자열 정보를 설정한다.

DEXTUploadX5는 파일의 확장자 명을 기반으로 필터 처리가 가능하다.

확장자 기반 필터 처리는 크게 순필터와 역필터로 나눈다.

• 순필터: 필터에 명시된 확장자를 갖는 대상만 추가할 수 있다.
• 역필터: 필터에 명시된 확장자를 갖는 대상은 추가할 수 없다.

function onDX5Created(id) {
    var dx = dx5.get(id);
    // 순필터 적용 예제
    dx.setExtensionFilter("*.jpg;*.jpeg;*.gif;*.bmp;*.txt");
    // 역필터 적용 예제
    dx.setExtensionFilter("*.exe;*.dll;*.js;*.sh;*.com", true);
    // 설정된 확장자 필터 정보를 출력한다.
    console.log("white => " + dx.getExtensionFilter());
    console.log("black => " + dx.getExtensionFilter(true));
}

setExtensionFilter 함수를 다시 호출하면, 기존 필터 정보는 제거되고 새로 덮어쓴다.

형식

component.setExtensionFilter(filterString [, reverse]);

파라미터

3.8.0.0 이상

설명

컴포넌트의 아이디를 반환한다.

var id = dx.getId();
console.log(id);

형식

id = component.getId();

반환

컴포넌트 아이디

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목을 반환한다.

DEXTUploadX5가 가질 수 있는 항목은 로컬 파일, 로컬 폴더, 가상 파일이 있다.

모든 항목은 id 속성을 가지고 있으며, getItemById 함수를 사용하여 항목 객체를 얻을 수 있다.

// 항목을 얻는다.
item = dx.getItemById(id);
// 항목의 이름을 출력한다.
console.log(item.name);

형식

item = component.getItemById(id);

파라미터

반환

항목(복사본)

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 반환한다.

DEXTUploadX5가 가질 수 있는 항목은 로컬 파일, 가상 파일이 있다.

모든 항목은 상대적인 순서를 가지고 있으며, getItemByIndex 함수를 사용하여 항목 객체를 얻을 수 있다.

// 6번 째 항목을 얻는다.
item = dx.getItemByIndex(5);
// 항목의 이름을 출력한다.
console.log(item.name);

형식

item = component.getItemByIndex(index);

파라미터

반환

항목(복사본)

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목의 고유 아이디를 반환한다.

// 네 번째 항목의 고유 아이디 값을 반환한다.
id = dx.getItemId(3);
// 3을 반환한다.
index = dx.getItemIndex(id);

형식

id = component.getItemId(index);

파라미터

반환

주어진 순서에 해당하는 항목의 고유 아이디

1.0.0.0 이상

설명

모든 항목의 고유 아이디 값을 요소로 갖는 배열을 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원(파일)만 카운트된 값이 반환된다.

DEXTUploadX5가 가질 수 있는 항목은 로컬 파일, 가상 파일이 있다.

// 모든 항목의 고유 아이디 값을 요소로 갖는 배열을 얻는다.
ids = dx.getItemIds();
// 로컬 자원의 고유 아이디를 얻으려면 파라미터를 true로 설정한다.
ids = dx.getItemIds(true);

형식

ids = component.getItemIds([onlyLocal]);

파라미터

반환

모든 항목의 고유 아이디 값을 요소로 갖는 배열

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목의 순서를 반환한다.

// 네 번째 항목의 고유 아이디 값을 반환한다.
id = dx.getItemId(3);
// 3을 반환한다.
index = dx.getItemIndex(id);

형식

index = component.getItemIndex(id);

파라미터

반환

주어진 고유 아이디에 해당하는 항목의 순서

1.0.0.0 이상

설명

항목을 배열로 반환한다.

DEXTUploadX5가 가질 수 있는 항목은 로컬 파일, 가상 파일이 있다.

// 모든 항목을 갖는 배열을 반환한다.
var all = dx.getItems();
// 로컬 항목만을 갖는 배열을 반환한다.
var locals = dx.getItems(true);
// 모든 원본 항목을 갖는 배열을 반환한다.
var origins = dx.getItems(false, true);

isOrigin 파라미터 값이 true이면 복사본이 아닌 원본 항목 요소가 반환된다.

이 옵션은 멀티 컴포넌트 업로드에서 사용이 되며, 그 외의 경우에는 항상 복사본을 사용해야 한다.

형식

items = component.getItems([onlyLocal, isOrign]);

파라미터

반환

항목 배열

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 파일의 최대 개수를 반환한다.

형식

maxCount = component.getMaxFileCount();

반환

컴포넌트에 추가할 수 있는 파일의 최대 개수, 기본값은 -1이다.

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 파일의 최대 개수를 설정한다.

업로드할 파일의 개수를 제한하기 위해서 추가할 수 있는 파일의 최대 개수를 제한할 수 있다.

값이 -1이면 제한을 하지 않는다는 의미를 갖는다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 파일을 최대 10까지 등록할 수 있다.
  dx.setMaxFileCount(10);
  // 만일 가상 파일을 포함하여 최대 10까지 등록하려면 두 번째 파라미터 값을 true로 입력한다.
  // 즉 로컬 파일의 개수는 (10 - 가상 파일의 개수) 만큼만 등록이 가능하다.
  dx.setMaxFileCount(10, true);
  // 컴포넌트에 추가할 수 있는 파일의 최대 개수를 출력한다.
  console.log(dx.getMaxFileCount());
}

형식

component.setMaxFileCount(count [, withVF]);

파라미터

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 개별 파일의 최대 크기를 반환한다.

형식

maxSize = component.getMaxFileSize();

반환

컴포넌트에 추가할 수 있는 개별 파일의 최대 크기(바이트), 기본값은 -1이다.

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 개별 파일의 최대 크기를 설정한다.

특정 크기가 넘는 파일을 등록하지 못하도록 설정할 수 있다.

값이 -1이면 제한을 하지 않는다는 의미를 갖는다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 100MB가 넘는 파일은 등록할 수 없다.
  dx.setMaxFileSize(1024 * 1024 * 100);
  // 컴포넌트에 추가할 수 있는 개별 파일의 최대 크기를 출력한다.
  console.log(dx.getMaxFileSize());
}

최댓값을 아무리 높게 잡아도 서버에서 받을 수 없는 크기라면 업로드가 실패한다.

OROF, ORAF 업로드 방식의 경우 개별 파일은 대략 2GB를 넘지 못한다.

큰 파일을 업로드하면, 서버 리소스 점유율이 높아져 동시 처리가 원할하지 못할 수 있다.

일반적으로는 큰 파일을 업로드할 이유가 없으므로, 가능한 용량을 제한하는 것을 권장한다.

형식

component.setMaxFileSize(size);

파라미터

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 전체 파일의 최대 허용 크기를 반환한다.

형식

maxTotalSize = component.getMaxTotalSize();

반환

전체 파일의 최대 허용 크기(바이트), 기본값은 -1이다.

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 전체 파일의 최대 허용 크기를 설정한다.

값이 -1이면 제한을 하지 않는다는 의미를 갖는다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 전체 파일 용량의 합이 300MB가 넘는 경우 등록할 수 없다.
  dx.setMaxTotalSize(1024 * 1024 * 300);
  // 컴포넌트에 추가할 수 있는 전체 파일 허용 크기의 최댓값을 출력한다.
  console.log(dx.getMaxTotalSize());
}

최댓값을 아무리 높게 잡아도 서버에서 받을 수 없는 크기라면 업로드가 실패한다.

OROF, ORAF 업로드 방식의 경우 전체 파일은 허용 크기는 대략 2GB를 넘지 못한다.

업로드할 데이터의 양이 커지면, 서버 리소스 점유율이 높아져 동시 처리가 원할하지 못할 수 있다.

일반적으로는 큰 데이터를 업로드할 이유가 없으므로, 가능한 용량을 제한하는 것을 권장한다.

형식

component.setMaxTotalSize(tsize [, withVF]);

파라미터

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목의 메타 데이터 값을 반환한다.

형식

metaValue = component.getMetaDataById(id, name);

파라미터

반환

주어진 이름이 갖는 메타 데이터 값

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목의 메타 데이터 값을 설정니다.

항목은 "이름[구분자]값" 형식의 메타 데이터를 여러개 가질 수 있다.

메타 데이터는 업로드가 될 때, 서버로 전송이 되며, 순수 파일외에 다른 정보를 함께 전달하는 용도로 사용된다.

가상 파일은 업로드가 되지 않으므로 서버로 메타 데이터가 전달되지 않는다.

dx.setMetaDataById(id, "userid", "honggildong");
// "honggildong"이 출력된다.
console.log(dx.getMetaDataById(id, "userid"));

형식

component.setMetaDataById(id, name, value);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목의 메타 데이터 값을 반환한다.

형식

metaValue = component.getMetaDataByIndex(index, name);

파라미터

반환

주어진 이름이 갖는 메타 데이터 값

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목의 메타 데이터 값을 설정한다.

항목은 "이름[구분자]값" 형식의 메타 데이터를 여러개 가질 수 있다.

메타 데이터는 업로드가 될 때, 서버로 전송이 되며, 순수 파일외에 다른 정보를 함께 전달하는 용도로 사용된다.

가상 파일은 업로드가 되지 않으므로 서버로 메타 데이터가 전달되지 않는다.

// 6번 째 항목에 메타 데이터를 설정한다.
dx.setMetaDataByIndex(5, "userid", "honggildong");
// "honggildong"이 출력된다.
console.log(dx.getMetaDataByIndex(5, "userid"));

형식

component.setMetaDataByIndex(index, name, value);

파라미터

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 개별 파일의 최소 크기를 반환한다.

형식

minSize = component.getMinFileSize();

반환

컴포넌트에 추가할 수 있는 개별 파일의 최소 크기(바이트), 기본값은 -1이다.

1.0.0.0 이상

설명

컴포넌트에 추가할 수 있는 개별 파일의 최소 크기를 설정한다.

특정 크기 아래의 파일을 등록하지 못하도록 설정할 수 있다.

값이 -1이면 제한을 하지 않는다는 의미를 갖는다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 1MB 미만 파일은 등록할 수 없다.
  dx.setMinFileSize(1024 * 1024);
  // 컴포넌트에 추가할 수 있는 개별 파일의 최소 크기를 출력한다.
  console.log(dx.getMinFileSize());
}

형식

component.setMinFileSize(size);

파라미터

1.2.0.0 버전 이상

설명

미리보기 뷰어의 배경 색상을 반환한다.

형식

color = component.getPreviewBackgroundColor();

반환

미리보기 뷰어의 배경 색상 문자열

1.2.0.0 이상

설명

미리보기 뷰어의 배경 색상을 설정한다.

배경색은 16진수 표기법(#FFFFFF)을 따른다.

// true로 설정하면 뷰어를 사용할 수 있다.
dx.setPreviewEnable(true);
// 배경색을 설정한다.
dx.setPreviewBackgroundColor("#ff0000");
// 내장 뷰어를 사용하여 미리보기를 수행하도록 설정한다. (기본값 1)
dx.setPreviewMethod(1);
// 첫 번째 파일이 로컬 이미지 파일이라면 내장 뷰어를 실행한다.
dx.preview(0);

형식

component.setPreviewBackgroundColor(color);

파라미터

1.2.0.0 버전 이상

설명

미리보기 방법을 반환한다.

형식

method = component.getPreviewMethod();

반환

미리보기 방법. 1이면 내장 뷰어, 2이면 이벤트 호출 방식

1.2.0.0 이상

설명

미리보기 방법을 설정한다.

1이면 내장 뷰어를 사용하여 이미지를 화면에 출력한다.

2이며 이벤트를 호출하는 방식이 제공되며, 이 방법은 개발자가 자신 만의 미리보기 화면을 구성하는 용도로 사용할 수 있다.

// true로 설정하면 뷰어를 사용할 수 있다.
dx.setPreviewEnable(true);
// 배경색을 설정한다.
dx.setPreviewBackgroundColor("#ff0000");
// 이벤트 방식으로 설정한다.
dx.setPreviewMethod(2);
// 첫 번째 파일이 로컬 이미지 파일이라면 내장 뷰어를 실행한다.
dx.preview(0);
// 미리보기 이벤트가 발생하면 호출될 콜백함수이다.
function onDX5Preview(id, itemIndex, itemId, itemSource) {
  ...
  if (itemSource) {
    target.src = itemSource;
  }
}

형식

component.setPreviewMethod(method);

파라미터

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 삭제 상태인 가상 파일을 반환한다.

// 삭제 상태인 파일(항목)을 얻는다.
item = dx.getRemovedFileById(id);
// 파일의 이름을 출력한다.
console.log(item.name);

형식

item = component.getRemovedFileById(id);

파라미터

반환

삭제 상태인 가상 파일(복사본)

1.0.0.0 이상

설명

삭제 상태인 가상 파일의 고유 아이디 값을 요소로 갖는 배열을 반환한다.

가상 파일은 삭제가 될 때, 완전히 제거되지 않고 삭제된 상태로 변경되어 보관된다.

// 삭제 상태인 가상 파일의 고유 아이디 값을 요소로 갖는 배열을 얻는다.
ids = dx.getRemovedFileIds();

형식

ids = component.getRemovedFileIds();

반환

삭제 상태인 가상 파일의 고유 아이디 값을 요소로 갖는 배열

1.0.0.0 이상

설명

삭제 상태인 가상 파일을 요소로 갖는 배열을 반환한다.

가상 파일은 삭제가 될 때, 완전히 제거되지 않고 삭제된 상태로 변경되어 보관된다.

// 삭제 상태인 가상 파일을 요소로 갖는 배열을 반환한다.
removeds = dx.getRemovedFiles();

형식

removeds = component.getRemovedFiles();

반환

삭제 상태인 가상 파일을 요소로 갖는 배열

1.0.0.0 이상

설명

업로드 후 서버로부터 받은 응답 데이터를 반환한다.

응답 데이터는 onDX5UploadCompleted 콜백 함수가 호출된 후에 얻을 수 있다.

로컬 자원이 업로드가 되면, 서버는 응답 데이터를 기록하며, 모든 업로드가 완료되면 onDX5UploadCompleted 함수가 호출된다. 업로드가 완료된 이벤트가 발생한 후에 getResponses 함수를 사용하여 응답 데이터를 얻을 수 있다.

응답 데이터는 문자열이다.

"ORAF" 업로드 방식일 때는, 단 하나의 문자열만 반환되므로, 반환되는 배열의 길이는 1이다.

"OROF", "EXTS", "AWSS3" 업로드 방식일 때는, 업로드된 파일의 개수만큼 반환되므로, 반환되는 배열의 길이는 파일의 개수와 동일한다.

파라미터가 주어진다면, 배열이 아닌 파라미터 순서에 해당하는 응답 문자열을 반환한다.

function onDX5UploadCompleted(id) {
  // 첫 번째 응답 문자열을 반환한다.
  var response = dx.getResponses(0);
  console.log(response);
}

형식

responses = component.getResponses([index]);

파라미터

반환

• 파라미터가 주어지면: 주어진 순서에 해당하는 응답 문자열
• 파라미터가 없으면: 모든 응답 문자열을 갖는 배열

1.0.0.0 이상

설명

선택된 항목의 개수를 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 카운트된 값이 반환된다.

// 선택된 항목의 개수를 얻는다.
count = dx.getSelectedCount();
// 선택된 로컬 자원의 개수를 얻으려면 파라미터를 true로 설정한다.
count = dx.getSelectedCount(true);

형식

count = component.getSelectedCount([onlyLocal]);

파라미터

반환

선택된 항목의 개수

1.0.0.0 이상

설명

선택된 항목의 순서 값을 요소로 갖는 배열을 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 카운트된 값이 반환된다.

// 선택된 항목의 순서 값을 요소로 갖는 배열을 얻는다.
indices = dx.getSelectedIndices();
// 선택된 로컬 자원의 순서를 얻으려면 파라미터를 true로 설정한다.
indices = dx.getSelectedIndices(true);

형식

indices = component.getSelectedIndices([onlyLocal]);

파라미터

반환

선택된 항목의 순서 값을 요소로 갖는 배열

1.0.0.0 이상

설명

선택된 항목의 고유 아이디 값을 요소로 갖는 배열을 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 카운트된 값이 반환된다.

// 선택된 항목의 고유 아이디 값을 요소로 갖는 배열을 얻는다.
ids = dx.getSelectedItemIds();
// 선택된 로컬 자원의 고유 아이디를 얻으려면 파라미터를 true로 설정한다.
ids = dx.getSelectedItemIds(true);

형식

ids = component.getSelectedItemIds([onlyLocal]);

파라미터

반환

선택된 항목의 고유 아이디 값을 요소로 갖는 배열

1.0.0.0 이상

설명

선택된 항목을 요소로 갖는 배열을 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 카운트된 값이 반환된다.

// 선택된 항목들만 배열로 묶어 반환한다.
var selecteds = dx.getSelectedItems();

형식

items = component.getSelectedItems([onlyLocal]);

파라미터

반환

선택된 항목을 요소로 갖는 배열

1.0.0.0 이상

설명

구분자 문자열을 반환한다.

형식

splitter = component.getSplitString();

반환

구분자 문자열, 기본값은 "[SPLT]"이다.

1.0.0.0 이상

설명

구분자 문자열을 설정한다.

DEXTUploadX5는 서버로 메타데이터를 보낼 때, 구분자 문자열을 포함한 문자열 데이터를 전송한다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 구분자용 문자를 파이프라인 문자(|)로 설정한다.
  dx.setSplitString("|");
  // 구분자용 문자를 출력한다.
  console.log(dx.getSplitString());
}

형식

component.setSplitString(str);

파라미터

1.0.0.0 이상

설명

PHP 환경을 지원할지를 반환한다.

형식

enable = component.getSupportPHP();

반환

PHP 환경을 지원할지 여부

1.0.0.0 이상

설명

PHP 지원 여부를 설정한다.

DEXTUploadX5 제품은 파일을 'DEXTUploadX5_FileData' 폼 이름으로 전송한다.

ORAF 전송 방식을 사용하는 경우, 여러 파일을 동시에 업로드하더라도 폼 이름은 동일한다.

그러나 PHP의 경우에는 동일한 폼 이름으로 여러 파일을 동시에 올리려면 폼 이름을 배열처럼 설정해야 한다.

즉 'DEXTUploadX5_FileData[]' 처럼 배열 형식으로 폼 이름을 지어야 한다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // PHP라면 true로 설정한다.
  dx.setSupportPHP(true);
}

기본 업로드 방식인 ORAF인 경우는 PHP환경임을 설정해야 한다. 그러나 OROF, EXTS 업로드 방식은 한 요청에 하나의 파일 정보만 전달하므로 setSupportPHP 함수를 사용할 필요가 없다.

형식

component.setSupportPHP(enable);

파라미터

1.0.0.0 이상

설명

컴포넌트에 추가된 파일의 크기를 합한 값을 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 계산된 값이 반환된다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 전체 파일 크기의 합을 출력한다.
  console.log(dx.getTotalFileSize());
}

형식

totalSize = component.getTotalFileSize([onlyLocal]);

파라미터

반환

전체 파일 크기의 합

1.0.0.0 이상

설명

컴포넌트에 추가된 항목의 개수를 반환한다.

파라미터 값이 true이면 가상 파일을 제외한 로컬 자원만 카운트된 값이 반환된다.

// 항목의 개수를 출력한다.
console.log(dx.getTotalItemCount());

형식

count = component.getTotalItemCount([onlyLocal]);

파라미터

반환

현재 항목의 개수

1.0.0.0 이상

설명

로컬 파일의 개수를 반환한다.

DEXTUploadX5가 가질 수 있는 항목은 로컬 파일, 가상 파일이 있다.

로컬 파일은 컴포넌트로부터 얻을 수 있는 항목의 type 속성이 "FILE"이다.

// 로컬 파일의 개수를 출력한다.
console.log(dx.getTotalLocalFileCount());

형식

count = component.getTotalLocalFileCount();

반환

로컬 파일의 개수

1.0.0.0 이상

설명

삭제 상태인 가상 파일의 개수를 반환한다.

가상 파일은 삭제가 될 때, 완전히 제거되지 않고 삭제된 상태로 변경되어 보관된다.

// 삭제 상태인 가상 파일의 개수를 반환한다.
count = dx.getTotalRemovedFileCount();
console.log(count);

형식

count = component.getTotalRemovedFileCount();

반환

삭제 상태인 가상 파일의 개수

1.0.0.0 이상

설명

삭제 상태인 가상 파일의 크기 합을 반환한다.

가상 파일은 삭제가 될 때, 완전히 제거되지 않고 삭제된 상태로 변경되어 보관된다.

// 삭제 상태인 가상 파일의 크기 합을 반환한다.
rsize = dx.getTotalRemovedFileSize();
console.log(rsize);

형식

rsize = component.getTotalRemovedFileSize();

반환

삭제 상태인 가상 파일의 크기 합

1.0.0.0 이상

설명

가상 파일의 개수를 반환한다.

DEXTUploadX5가 가질 수 있는 항목은 로컬 파일, 가상 파일이 있다.

가상 파일은 컴포넌트로부터 얻을 수 있는 항목의 type 속성이 "VIRTUAL"이다.

가상 파일은 addVirtualFile, addVirtualFileList 함수를 사용하여 추가할 수 있다.

// 가상 파일의 개수를 출력한다.
console.log(dx.getTotalVirtualFileCount());

형식

count = component.getTotalVirtualFileCount();

반환

가상 파일의 개수

1.0.0.0 이상

설명

DEXTUploadX5 컴포넌트 버전을 반환한다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 버전을 출력한다.
  console.log(dx.getVersion());
}

형식

strVersion = component.getVersion();

반환

버전 문자열

1.0.0.0 이상

설명

업로드할 수 있는 대상이 있는지를 반환한다.

function upload(id) {
  var dx = dx5.get(id);
  // 업로드할 대상이 있는 지 확인 후, 업로드를 시작한다.
  if (dx.hasUploadableItems()) {
    // 업로드를 시작한다.
  } else {
    alert("업로드할 대상이 없다.");
  }
}

형식

has = component.hasUploadableItems();

반환

업로드할 수 있는 대상이 있다면 true, 아니면 false

1.0.0.0 이상

설명

확장자가 없는 파일 추가 허용 여부를 반환한다.

형식

allow = component.isAllowNoExtension();

반환

확장자가 없는 파일을 허용하면 true, 아니면 false

1.0.0.0 이상

설명

확장자가 없는 파일 추가 허용 여부를 설정한다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 확장자가 없는 파일 추가를 막는다.
  dx.setAllowNoExtension(false);
  // 확장자가 없는 파일 추가 허용 여부를 출력한다.
  console.log(dx.isAllowNoExtension());
}

형식

component.setAllowNoExtension(allow);

파라미터

1.0.0.0 이상

설명

미리보기 뷰어 사용 여부를 반환한다.

형식

enable = component.isPreviewEnable();

반환

미리보기 뷰어 사용 여부

1.0.0.0 이상

설명

미리보기 뷰어 사용 여부를 설정한다.

대상이 이미지 파일이고, 미리보기가 가능한 경우 화면 또는 이벤트로 미리보기 기능을 제공한다.

지원하는 포맷은 다음과 같는다.

• JPG, GIF, PNG, BMP

// true로 설정하면 뷰어를 사용할 수 있다.
dx.setPreviewEnable(true);
// 배경색을 설정한다.
dx.setPreviewBackgroundColor("#ff0000");
// 내장 뷰어를 사용하여 미리보기를 수행하도록 설정한다. (기본값 1)
dx.setPreviewMethod(1);
// 첫 번째 파일이 로컬 이미지 파일이라면 내장 뷰어를 실행한다.
dx.preview(0);

형식

component.setPreviewEnable(enable);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목이 선택 상태인지를 반환한다.

// 6번 째 항목을 선택 상태로 변경한다.
dx.selectByIndex(5);
// 6번 째 항목을 선택 상태인지를 출력한다.
console.log(dx.isSelectedByIndex(5));

형식

selected = component.isSelectedByIndex(index);

파라미터

반환

선택 상태면 true, 아니면 false

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목을 잠금 상태로 변경한다.

항목이 잠기면 대상을 삭제할 수 없다.

// 대상을 잠금 상태로 변경한다.
dx.lockById(id);
// 대상의 잠금 상태를 해지한다.
dx.unlockById(id);

형식

component.lockById(id);

파라미터

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목의 잠금 상태를 해지한다.

항목이 잠기면 대상을 삭제할 수 없다.

// 대상을 잠금 상태로 변경한다.
dx.lockById(id);
// 대상의 잠금 상태를 해지한다.
dx.unlockById(id);

형식

component.unlockById(id);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 잠금 상태로 변경한다.

항목이 잠기면 대상을 삭제할 수 없다.

// 대상을 잠금 상태로 변경한다.
dx.lockByIndex(5);
// 대상의 잠금 상태를 해지한다.
dx.lockByIndex(5);

형식

component.lockByIndex(index);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목의 잠금 상태를 해지한다.

항목이 잠기면 대상을 삭제할 수 없다.

// 대상을 잠금 상태로 변경한다.
dx.lockByIndex(5);
// 대상의 잠금 상태를 해지한다.
dx.lockByIndex(5);

형식

component.unlockByIndex(index);

파라미터

1.2.0.0 이상

설명

등록하려는 로컬 파일이 이미지 파일인 경우, 대상 파일을 미리 볼 수 있는 뷰어를 제공한다.

내장 뷰어를 사용하는 경우 브라우저를 전체 화면으로 하는 미리보기 영역을 생성된다.

이와 달리 미리보기 방식을 이벤트 호출 방식으로 설정하면, 개발자가 원하는 미리보기 화면 구성이 가능하게 된다.

로컬 파일만 미리보기가 가능하다.

// true로 설정하면 뷰어를 사용할 수 있다.
dx.setPreviewEnable(true);
// 배경색을 설정한다.
dx.setPreviewBackgroundColor("#ff0000");
// 내장 뷰어를 사용하여 미리보기를 수행하도록 설정한다. (기본값 1)
dx.setPreviewMethod(1);
// 첫 번째 파일이 로컬 이미지 파일이라면 내장 뷰어를 실행한다.
dx.preview(0);

형식

component.preview(index);

파라미터

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 가상 파일을 제거한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

이렇게 삭제 상태로 보관 중인 가상 파일은 purgeRemovedVirtual 함수를 사용하여 완전히 제거가 가능하다.

// 주어진 고유 아이디에 해당하는 가상 파일을 제거한다.
dx.purgeRemovedVirtual(id);

형식

component.purgeRemovedVirtual(id);

파라미터

1.0.0.0 이상

설명

모든 항목을 삭제한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

// 모든 항목을 삭제한다.
dx.removeAll();
// 모든 항목(가상 파일의 경우에도 완전 제거)을 삭제한다.
dx.removeAll(true);

형식

component.removeAll([perma[, fireEvent]]);

파라미터

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 항목을 삭제한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

// 주어진 고유 아이디에 해당하는 항목을 삭제한다.
dx.removeById(id);
// 주어진 고유 아이디에 해당하는 항목을 삭제(가상 파일의 경우에도 완전 제거)한다.
dx.removeById(id, true);

형식

component.removeById(id [, perma[, fireEvent]]);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 삭제한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

// 6번 째 항목을 삭제한다.
dx.removeByIndex(5);
// 6번 째 항목을 삭제(가상 파일의 경우에도 완전 제거)한다.
dx.removeByIndex(5, true);

형식

component.removeByIndex(index [, perma[, fireEvent]]);

파라미터

1.0.0.0 이상

설명

체크된 항목 모두를 삭제한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

// 체크된 항목 모두를 삭제한다.
dx.removeChecked();
// 체크된 항목(가상 파일의 경우에도 완전 제거) 모두를 삭제한다.
dx.removeChecked(true);

형식

component.removeChecked([perma[, fireEvent]]);

파라미터

2.0.0.0 이상

설명

사용자 정의 헤더를 삭제한다.

DEXTUploadX5는 파일을 업로드하거나 다운로드할 때, 사용자 정의 헤더를 HTTP 요청에 함께 실어 보낼 수 있다.

setCustomHeader 메소드를 사용하여 사용자 정의 헤더를 설정할 수 있으며, getCustomHeader 메소드를 사용하여 헤더 값을 확인할 수 있다.

한번 사용자 정의 헤더가 설정되면, 이후 모든 요청에 헤더를 포함하여 보기 때문에, 만일 헤더가 필요하지 않은 상황이라면 removeCustomHeader 메소드를 사용하여 이미 설정된 헤더를 제거할 수 있다.

// 사용자 정의 헤더를 설정한다.
dx.setCustomHeader("X-Third-Party-Name", "DEXTUploadX5");
// 사용자 정의 헤더 값을 확인한다.
value = dx.getCustomHeader("X-Third-Party-Name");
// 대상 헤더를 삭제한다.
dx.removeCustomHeader("X-Third-Party-Name")

헤더 이름과 값은 제품 내부적으로 인코딩 처리를 하지 않기 때문에, 인코딩이 필요한 상황이라면 직접 처리해주어야 한다.

크로스 도메인으로 요청을 하는 상황이라면 CORS(Cross-Origin Resource Sharing) 설정 여부에 따라 사용자 정의 헤더를 서버 측에서 허용하지 않을 수도 있다. 그러므로 사용자 정의 헤더를 성공적으로 전달하기 위해서는 Access-Control-Allow-Headers 응답 헤더를 이용하여 사용자 정의 헤더를 허용하거나, 서버(웹) 플랫폼에 맞도록 설정을 해주어야 한다.

형식

component.removeCustomHeader(name);

파라미터

1.0.0.0 이상

설명

선택된 항목을 모두 삭제한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

// 선택된 항목 모두를 삭제한다.
dx.removeSelected();
// 선택된 항목(가상 파일의 경우에도 완전 제거) 모두를 삭제한다.
dx.removeSelected(true);

형식

component.removeSelected([perma[, fireEvent]]);

파라미터

1.0.0.0 이상

설명

삭제된 가상 파일을 모두 복구한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

이렇게 삭제 상태로 보관 중인 가상 파일을 모두 복구하려면 revokeAllVirtualFiles 함수를 사용한다.

// 삭제된 가상 파일을 모두 복구한다.
dx.revokeAllVirtualFiles();

형식

component.revokeAllVirtualFiles();

1.0.0.0 이상

설명

주어진 고유 아이디에 해당하는 삭제된 가상 파일을 복구한다.

항목을 삭제할 때, 대상이 가상 파일이면, 바로 삭제하지 않고 삭제 상태로 보관한다.

이와 달리 로컬 자원들은 상태 변경없이 완전히 제거된다.

이렇게 삭제 상태로 보관 중인 가상 파일을 다시 복구하려면 revokeVirtualFile 함수를 사용한다.

// 주어진 아이디에 해당하는 삭제된 가상 파일을 복구한다.
dx.revokeVirtualFile(id);

형식

component.revokeVirtualFile(id);

파라미터

1.0.0.0 이상

설명

모든 항목을 선택 상태로 변경한다.

// 모든 항목을 선택 상태로 변경한다.
dx.selectAll();
// 모든 항목을 선택 해지 상태로 변경한다.
dx.unselectAll();

형식

component.selectAll();

1.0.0.0 이상

설명

모든 항목을 선택 해지 상태로 변경한다.

// 모든 항목을 선택 상태로 변경한다.
dx.selectAll();
// 모든 항목을 선택 해지 상태로 변경한다.
dx.unselectAll();

형식

component.unselectAll();

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 선택 상태로 변경한다.

// 6번 째 항목을 선택 상태로 변경한다.
dx.selectByIndex(5);
// 6번 째 항목을 선택 해지 상태로 변경한다.
dx.unselectByIndex(5);

형식

component.selectByIndex(index);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 선택 해지 상태로 변경한다.

// 6번 째 항목을 선택 상태로 변경한다.
dx.selectByIndex(5);
// 6번 째 항목을 선택 해지 상태로 변경한다.
dx.unselectByIndex(5);

형식

component.unselectByIndex(index);

파라미터

1.0.0.0 이상

설명

필터링된 파일을 전부 혹은 부분 차단할지를 설정한다.

여기서 차단이란 파일 추가를 막는 것을 말한다.

등록하려는 파일이 사전에 정의된 필터에 위배되는 경우, 대상은 차단이 된다.

만일 전체 파일 크기 제한이 10MB일 때, 추가하려는 파일이 8MB, 1MB, 3MB, 4MB이면, 8MB, 1MB인 두 파일을 등록할지 여부를 질의한다.

setFilterSilence 함수를 true로 설정하면, 이런 질의 과정 없이 파일 추가 과정이 모두 취소된다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  ...
  // 필터링 조건에 따라 필터링이 된 경우, 부분 허용없이 모두 차단(추가를 안함)한다.
  dx.setFilterSilence(true);
}

형식

component.setFilterSilence(enable);

파라미터

1.1.0.0 이상

설명

정렬을 할 때, 가상 파일을 최우선으로 할지를 설정한다.

가상 파일을 최우선으로 한다면, 오름차순, 내림차순 상관없이 항상 가상 파일이 제일 먼저 위치한다.

// 정렬할 때 가상 파일을 제일 우선하도록 한다.
dx.setSortPriorityVirtualFile(true);

형식

component.setSortPriorityVirtualFile(enable);

파라미터

1.0.0.0 이상

설명

GUI 스타일을 변경한다.

setUIStyle 함수에 스타일 속성이 지정된 json 객체를 설정하면 스타일이 변경된다.

dx.setUIStyle({
 headerVisible: false, statusBarVisible: false, borderVisible: true
});

형식

component.setUIStyle({ /* UI 속성 */ });

파라미터

1.0.0.0 이상

설명

특정 컴포넌트가 가진 로컬 자원을 현재 컴포넌트에 추가한다.

DEXTUploadX5는 파일 선택 다이얼로그, 폴더 선택 다이얼로그만을 가지고 로컬 자원을 추가할 수 있도록 설계되었다.

그러나 컴포넌트 끼리 항목을 주고 받아야 하는 상황에서 로컬 자원 데이터를 서로 공유해야 하는 상황이 발생한다.

setUploadableFilesFrom 함수는 스크립트에서 로컬 자원 항목을 등록할 수 있도록 생성된 함수이며, 오로지 컴포넌트끼리 항목을 주고받을 목적으로 만들어졌다.

// "dext5-uploader" 컴포넌트가 "dext5-a", "dext5-b" 컴포넌트의 로컬 자원 항목을 대신 업로드한다.
var uploader = dx5.get("dext5-uploader");
			
uploader.clearItems();
// 첫 번째 컴포넌트로부터 업로드를 하기 위한 파일 정보를 얻는다.
uploader.setUploadableFilesFrom(dx5.get("dext5-a"));
// 두 번째 컴포넌트로부터 업로드를 하기 위한 파일 정보를 얻는다.
uploader.setUploadableFilesFrom(dx5.get("dext5-b"));
uploader.setUploadURL("업로드 경로");
uploader.upload("AUTO");

setUploadableFilesFrom 메소드를 사용하여 파일을 얻은 컴포넌트는 UI 변화가 없다.

2.3.1.0 버전 이전에는 함수명이 setUploableFilesFrom에서 setUploadableFilesFrom으로 변경되었다.

3.4.0.0 버전에서는 정렬된 순서대로 업로드를 하고자 할 때, 대상 컴포넌트의 정렬된 상태로 항목 정보를 가져올 수 있다.

var uploader = dx5.get("dext5-uploader");

uploader.clearItems();

// 업로드 순서를 정렬된 순서로 정한다.
uploader.setUploadByOrder(true);

// 대상 컴포넌트에서 항목을 가져올 때, 정렬된 순서대로 가져온다.
uploader.setUploadableFilesFrom(dx5.get("dext5-a"));
uploader.setUploadableFilesFrom(dx5.get("dext5-b"));

uploader.setUploadURL("업로드 경로");
uploader.upload("AUTO");

setUploableFilesFrom을 사용하여 등록된 항목들은 setAutoSortingType, setEnableColumnSorting, sortColumnIndex 영향을 받지 않는다.

형식

component.setUploadableFilesFrom(otherComponent);

파라미터

1.0.0.0 이상

설명

대용량 파일 업로드를 수행할 때, 업로드 단위 크기를 설정한다.

DEXTUploadX5는 대용량 파일 업로드를 수행할 때, 파일을 주어진 블록 크기로 나누어 전송을 한다.

100MB 파일을 업로드할 때, 블록 크기가 10MB면 메타 데이터 전송을 포함하여 총 11번(헤더전송 1번 + 파일전송 10번) 요청이 발생한다.

setUploadBlockSize 함수는 대용량 업로드에서만 동작하기 때문에, "ORAF", "OROF", "AWSS3" 전송에서는 무시된다.

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 대용량 업로드 방식으로 사용한다.
  dx.setUploadMode("EXTS");
  // 업로드 블록 단위를 10MB로 설정한다.
  dx.setUploadBlockSize(10 * 1024 * 1024);
}

형식

component.setUploadBlockSize(blockSize);

파라미터

1.1.0.0 이상

설명

주어진 칼럼을 기준으로 정렬을 한다.

가상 파일을 최우선으로 한다면, 오름차순, 내림차순 상관없이 항상 가상 파일이 제일 먼저 위치한다.

// 1번째 칼럼을 기준으로 오름 차순 정렬을 바로 수행한다.
dx.sortColumnIndex(1, false);

파일명으로 정렬할 때는 1, 파일 크기로 정렬할 때는 2를 index 값으로 설정해야 한다. 만일 다른 값의 경우에는 정렬 작업을 수행하지 않는다.

TILE 스타일의 경우에는 칼럼 순서에 상관없이 무조건 파일명을 기준으로 정렬을 수행한다.

// 파일의 크기를 기준으로 오름 차순 정렬을 수행한다.
// 만일 타일 형식이라면 파일명을 기준으로 오름 차순 정렬을 수행한다.
dx.sortColumnIndex(2, false);

형식

component.sortColumnIndex(index, ascending);

파라미터

1.0.0.0 이상

설명

DEXTUploadX5는 컴포넌트 자체에 업로드 중지하는 버튼이나 GUI 요소가 없다.

대신 스크립트를 사용하여 중지할 수 있도록 함수를 제공하고 있다.

<button type="button" onclick="stop('component-id');">중지</button>
<script>
function stop(id) {
  dx5.get(id).stopUploading();
}
</script>

컴포넌트 생성 시점에 btnStopUploading 속성 값을 사용하여 자동으로 바인딩하여 사용할 수 있다.

<button id="btn-stop-uploading" type="button">중지</button>
<script>
  dx5.create({
    ...,
    // 업로드 중지 기능이 자동으로 연결된다.
    btnStopUploading: "btn-stop-uploading"
  });
</script>

형식

component.stopUploading();

1.0.0.0 이상

설명

파일 업로드를 시작한다.

• "AUTO": 모든 로컬 항목들 중에서 status가 "WAIT"인 로컬 자원을 모두 업로드한다.
• "SELECTED": 선택된 로컬 항목들 중에서 status가 "WAIT"인 로컬 자원을 모두 업로드한다.
• "CHECKED": 체크된 로컬 항목들 중에서 status가 "WAIT"인 로컬 자원을 모두 업로드한다.

DEXTUploadX5는 컴포넌트 자체에 파일을 업로드하는 버튼이나 GUI 요소가 없다.

대신 스크립트를 사용하여 업로드할 수 있도록 함수를 제공하고 있다.

<button type="button" onclick="upload('component-id');">업로드</button>
<script>
function upload(id) {
  var dx = dx5.get(id);
  if (dx.hasUploadableItems()) {
    // 업로드를 시작한다.
    dx.upload("AUTO");
  } else {
    alert("업로드할 대상이 없다.");
  }
}
</script>

특별한 코드 처리없이 "AUTO" 파라미터 값을 가지고 업로드를 처리하려 한다면, 컴포넌트 생성 시점에 btnUploadAuto 속성 값을 사용하여 자동으로 바인딩하여 사용할 수 있다.

<button id="btn-upload" type="button">업로드</button>
<script>
  dx5.create({
    ...,
    // 파일 업로드 기능이 자동으로 연결된다.
    btnUploadAuto: "btn-upload"
  });
</script>

btnUploadAuto 속성 외에, btnUploadSelected, btnUploadChecked도 사용할 수 있다.

형식

component.upload(flag);

파라미터

1.0.0.0 이상

설명

제품에서 제공하는 자체 진행창을 사용할지를 설정한다.

DEXTUploadX5에서 기본으로 지원하는 진행창을 사용하지 않으려면 useProgressDialog 함수를 사용할 수 있다.

대신 getUploadStatus 함수를 사용하여 업로드 진행 정보를 스크립트로 따로 얻을 수 있다.

// 기본 진행창을 사용하지 않는다.
dx.useProgressDialog(false);
// 진행창이 안보이므로 getUploadStatus 함수를 사용하여 업로드 진행 정보를 얻는다.
var status = dx.getUploadStatus();
// 이름: status.currentName 
// 전체 속도: status.totalSpeed 
// 업로드가 완료된 개수: status.completeCount
// 전체 개수: status.totalCount
// 현재 파일 전송률: status.currentRate
// 현재 파일의 전송된 크기: status.currentSendSize
// 현재 파일의 크기: status.currentSize
// 현재 파일의 전송 시간: status.currentTime
// 현재 파일의 남은 시간: status.remainedCurrentTime
// 전체 파일 전송률: status.totalRate
// 전체 파일의 전송된 크기: status.totalSendSize
// 전체 파일의 크기: status.totalSize
// 전체 파일의 전송 시간: status.totalTime
// 전체 파일의 남은 시간: status.remainedTotalTime

형식

component.useProgressDialog(enable);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 리스트의 아래로 이동시킨다.

moveItemDown 함수를 사용하여 대상이 이동하게 되면, 대상의 순서는 변경된다.

// 6번 째 항목을 7번 째로 이동한다.
dx.moveItemDown(5);

형식

component.moveItemDown(index);

파라미터

1.0.0.0 이상

설명

주어진 순서에 해당하는 항목을 리스트의 위로 이동시킨다.

moveItemUp 함수를 사용하여 대상이 이동하게 되면, 대상의 순서는 변경된다.

// 6번 째 항목을 5번 째로 이동한다.
dx.moveItemUp(5);

형식

component.moveItemUp(index);

파라미터