ExportBaseOptions
그리드 및 데이터 내보내기에 관한 설정들의 기반 모델
Signature:
export interface ExportBaseOptions
Remarks
GridExportOptions, DataExportOptions 가 하위 모델이다.
[하위 클래스]
Properties
Property | Type | Description |
---|---|---|
compression | ExportCompression | 파일 생성시 압축방식 |
compressionLevel | number | 압축레벨 |
done | ExportSimpleCallback | 내보내기를 완료할 때 수행 될 콜백 |
fileName | string | 내보내기 시 파일 명 |
nullDateText | string | Datetime 필드의 값이 null 일 때 표현되는 값 |
params | ConfigObject | target이 "remote"일때 서버로 전달될 parameters |
prepareProgress | number | (ALPHA) |
progressCallback | ProgressCallback | 사용자 Progress Bar를 위한 callback |
progressMessage | string | 프로그레스 바 사용 시 표시될 메시지 |
showProgress | boolean | 내보내기 시 프로그레스 바 표시여부 |
streamFiles | boolean | 파일생성시 stream여부 |
target | ExportTarget | string | 내보내기 할 대상 / 경로 |
type | ExportType | string | 내보내기를 할 타입 |
url | string | 그리드가 내보내는 문서 스트림을 전송 받은 후 다시 사용자 컴퓨터에 내려 주는 서버의 url |
zip | any | JSZip 모듈을 지정한다. JSZip을 import해서 사용하는 경우 import한 모듈을 지정한다. |
Properties Desc
compression
파일 생성시 압축방식
Type
- ExportCompression
Remarks:
STORE
를 사용해서 저장하는 경우 압축대비 10배정도의 크기를 가지지만 30% 정도의 속도 향상
STORE
압축을 하지 않고 원본 그대로 저장 DEFLATE
압축을 해서 파일 size를 줄인다. JSZip.compression (opens in a new tab) 참조
compressionLevel
압축레벨
Type
- number
Remarks:
ExportBaseOptions.compression 이 DEFLATE
일때 압축레벨
1
~ 9
까지 정수로 입력한다. JSZip.compressionOptions (opens in a new tab) 참조
done
내보내기를 완료할 때 수행 될 콜백
Type
- ExportSimpleCallback
Remarks:
ExportBaseOptions.target 이 ExportTarget.STREAM 인경우 Base64로 encoding된 Data가 전달된다.
fileName
내보내기 시 파일 명
Type
- string
Example:
'gridExportSample.xlsx'
nullDateText
Datetime 필드의 값이 null
일 때 표현되는 값
Type
- string
params
target이 "remote"일때 서버로 전달될 parameters
Type
- ConfigObject
Remarks:
target이 remote일때 서버로 전달되어야 할 추가 정보가 있는 경우 사용한다.
Example:
var params = {
userId: "userId",
param1: "param1",
param2: "param2"
}
gridView.exportGrid({type:"excel", target:"local", params:params})
prepareProgress
Type
- number
progressCallback
사용자 Progress Bar를 위한 callback
Type
- ProgressCallback
Remarks:
progressCallback이 설정되면 Grid내부의 progressBar는 표시되지 않는다.
progressMessage
프로그레스 바 사용 시 표시될 메시지
Type
- string
Remarks:
showProgress
내보내기 시 프로그레스 바 표시여부
Type
- boolean
streamFiles
파일생성시 stream여부
Type
- boolean
Remarks:
false
이면 압축된 파일을 메모리에 보관후 crc32
를 파일의 앞쪽에 추가 true
이면 파일의 마지막에 데이터 설명자 추가. JSZip.streamFiles (opens in a new tab) 참조
target
내보내기 할 대상 / 경로
Type
- ExportTarget | string
type
내보내기를 할 타입
Type
- ExportType | string
url
그리드가 내보내는 문서 스트림을 전송 받은 후 다시 사용자 컴퓨터에 내려 주는 서버의 url
Type
- string
zip
JSZip 모듈을 지정한다.
JSZip을 import해서 사용하는 경우 import한 모듈을 지정한다.
Type
- any