GridExportOptions
그리드 내보내기에 관한 설정 모델
Signature:
export interface GridExportOptions extends ExportOptions
Extends: ExportOptions
Remarks
ExportOptions 를 상속한다.
[상위 클래스]
Properties
Property | Type | Description |
---|---|---|
allColumns | boolean | 숨겨진 컬럼들도 엑셀로 내보내기 할 것인지의 여부 |
allItems | boolean | 숨겨진 행들도 엑셀로 내보내기 할 것인지의 여부 |
applyDynamicStyles | boolean | Dynamic Styles 을 적용하여 내보내기 것인지의 여부 |
applyFitStyle | boolean | GridFitStyle 로 적용된 너비로 내보내기 여부 |
applyFixed | boolean | fixed된 컬럼 또는 row가 있는 경우 틀고정 여부 |
bulkImageDownload | boolean | excel에 포함시킬 이미지를 download할때 하나씩 다운로드하거나 일괄 다운로드 한다. |
checkBar | string | 그리드 체크바 영역을 포함시킬 것인지의 여부 |
checkMark | string | 그리드 체크바 영역을 내보내기 했을 때, 선택 값의 표시 방법 |
documentSubtitle | DocumentTitle | 내보내기 시 엑셀 문서의 부제목 |
documentTail | DocumentTitle | 내보내기 시 엑셀 문서의 꼬릿말 |
documentTitle | DocumentTitle | 내보내기 시 엑셀 문서의 제목 |
exportGrids | { grid: GridBase; sheetName: string; }[] | 내보내기를 할 그리드의 GridBase 컨트롤과 내보내기의 대상이 되는 엑셀 sheet 의 이름 |
exportImage | boolean | excel로 export할때 image 포함 여부 |
exportLayout | ConfigObject[] | 엑셀로 내보내기 하려는 모양이 화면과 다를때 사용하는 layout |
exportLink | boolean | LinkCellRenderer의 url을 내보내기 할것인지 여부 |
exportSeriesColumn | boolean | 시리즈컬럼을 내보내기 할 것인지의 여부 |
exportTemplate | boolean | TemplateCellRenderer를 내보내기 할것인지 여부 |
fillMergeFooterValue | boolean | 그리드가 행병합 그룹핑 상태이면서 GridExportOptions.separateRows가 true 일때 GroupFooter또는 GroupSummary셀의 값 출력여부 |
footer | string | 그리드 푸터 영역을 포함시킬 것인지의 여부 |
header | string | 그리드 헤더 영역을 포함시킬 것인지의 여부 |
headerSummary | string | 그리드 Header Summary 영역을 포함시킬 것인지의 여부 |
hiddenColumns | string[] | 엑셀의 hidden Column |
hideColumns | string[] | 엑셀로 내보내기 안하고자 하는 컬럼을 배열 |
indenting | boolean | 행 그룹핑 및 트리 그리드 자료를 내보내기 시 들여쓰기 여부 |
indicator | string | 그리드 인디케이터 영역을 포함시킬 것인지의 여부 |
indicatorValue | string | 그리드 인디케이터 영역을 내보내기 했을 때, 해당 영역의 값의 표시 방법 |
layoutExpand | ExportLayoutExpand | string | expandable이 설정된 컬럼을 export할때 expand여부 |
linear | boolean | 컬럼 그룹을 해제하고 엑셀로 내보내기 할 것인지의 여부 |
lookupDisplay | boolean | 컬럼의 lookupDisplay 값을 표시된 값으로의 내보내기 여부 |
onlyCheckedItems | boolean | 체크한 행들만 엑셀로 내보내기 할 것인지의 여부 |
pagingAllItems | boolean | 엑셀로 내보내기 시 페이징되어 보이지 않는 데이터를 포함한 모든 데이터를 내보내기 할 것인지의 여부 |
protectPassword | string | 시트 보호를 사용할때 해제 암호를 입력한다. |
protectProperties | SheetProtectProperties | 시트 보호를 사용할때 허용하거나 잠글 속성을 지정한다. |
separateRows | boolean | 엑셀 내보내기 시 병합 해제 여부 |
sheetAttrs | ConfigObject | 엑셀로 내보내기 할때 sheet에 추가할 attribute |
sheetName | string | 엑셀 sheet 명 |
sheetProtect | boolean | 잠긴 셀의 내용과 워크시트 보호 |
showColumns | string[] | 엑셀로 내보내기 하고자 하는 컬럼의 배열 |
showLevelOutline | boolean | 행 그룹핑 된 자료를 내보내기 시 엑셀 왼쪽에 위치한 그룹간 묶음선 표시여부 |
stylePrefix | string | 엑셀로 내보내기 할때 스타일 찾기위한 접두어가 있는 경우 사용 |
unCheckMark | string | 그리드 체크바 영역을 내보내기 했을 때, 선택 해제된 값의 표시 방법 |
userCells | UserExportCell[] | 사용자 지정 출력 |
userCellsCallback | UserCellsCallback | 사용자 출력셀을 만들기 위해 호출되는 callback userCells가 지정되어있으면 callback은 무시된다. |
xOffset | number | 왼쪽 여백컬럼의 수를 지정한다. |
xOffsetWidth | number | 왼쪽 여백컬럼의 너비를 지정한다. |
yOffset | number | 위쪽 여백행의 수를 지정한다. |
Properties Desc
allColumns
숨겨진 컬럼들도 엑셀로 내보내기 할 것인지의 여부
Type
- boolean
Remarks:
allItems
숨겨진 행들도 엑셀로 내보내기 할 것인지의 여부
Type
- boolean
Remarks:
applyDynamicStyles
Dynamic Styles 을 적용하여 내보내기 것인지의 여부
Type
- boolean
Remarks:
applyFitStyle
GridFitStyle 로 적용된 너비로 내보내기 여부
Type
- boolean
Remarks:
applyFixed
fixed된 컬럼 또는 row가 있는 경우 틀고정 여부
Type
- boolean
Remarks:
fixed Column 또는 fixed Row가 있으면 엑셀로 내보내기 할때 틀고정
을 설정한다.
bulkImageDownload
excel에 포함시킬 이미지를 download할때 하나씩 다운로드하거나 일괄 다운로드 한다.
Type
- boolean
Remarks:
true
이면 일괄 다운로드하고 false
이면 하나씩 다운로드 한다.
checkBar
그리드 체크바 영역을 포함시킬 것인지의 여부
Type
- string
Remarks:
'default'
일 때는 현재 그리드에 표시된 상태에 따라 포함, 'hidden'
이면 포함 안함, 'visible'
이면 포함한다.
checkMark
그리드 체크바 영역을 내보내기 했을 때, 선택 값의 표시 방법
Type
- string
Remarks:
documentSubtitle
내보내기 시 엑셀 문서의 부제목
Type
- DocumentTitle
documentTail
내보내기 시 엑셀 문서의 꼬릿말
Type
- DocumentTitle
documentTitle
내보내기 시 엑셀 문서의 제목
Type
- DocumentTitle
exportGrids
내보내기를 할 그리드의 GridBase 컨트롤과 내보내기의 대상이 되는 엑셀 sheet 의 이름
Type
- { grid: GridBase; sheetName: string; }[]
Remarks:
지정하지 않으면 메소드를 호출한 그리드 인스턴스가 GridBase 컨트롤로 지정되어 'sheet1'
에 내보내기된다.
exportImage
excel로 export할때 image 포함 여부
Type
- boolean
Remarks:
true
이면 imageRenderer, iconRenderer를 이용해서 표시한 image를 excel에 포함한다. displayOptions.rowHeight가 -1인경우 셀의 상단에 표시. IE의 경우 Promise 관련 polyFill을 추가해야 한다.
exportLayout
엑셀로 내보내기 하려는 모양이 화면과 다를때 사용하는 layout
Type
- ConfigObject[]
Remarks:
원하는 layout을 지정하여 excel로 내보내기 한다. 내보내기 종류가 엑셀일 때만 사용 가능하다.
exportLink
LinkCellRenderer의 url을 내보내기 할것인지 여부
Type
- boolean
Remarks:
true
로 지정하면 url의 HYPERLINK로 내보내기 한다. 내보내기 종류가 엑셀일 때만 사용 가능하다.
exportSeriesColumn
시리즈컬럼을 내보내기 할 것인지의 여부
Type
- boolean
Remarks:
true
로 지정하면 sparkLine
, sparkColumn
, sparkWinLoss
컬럼들이 내보내기 된다.
스파크 컬럼들이 참조하고 있는 DataColumn들을 반드시 포함하여 내보내기 해야하며 DataColumn
의 name
속성은 반드시 지정되어 있어야 한다.
또한 DataColumn
은 참조한 순서대로 표시되어 있어야 한다.
exportTemplate
TemplateCellRenderer를 내보내기 할것인지 여부
Type
- boolean
Remarks:
true
로 지정하면 TemplateCellRenderer가 renderering한 HTML에서 Tag를 제거한 문자열을 내보내기 한다. 내보내기 종류가 엑셀일 때만 사용 가능하다.
fillMergeFooterValue
그리드가 행병합 그룹핑 상태이면서 GridExportOptions.separateRows가 true
일때 GroupFooter또는 GroupSummary셀의 값 출력여부
Type
- boolean
footer
그리드 푸터 영역을 포함시킬 것인지의 여부
Type
- string
Remarks:
'default'
일 때는 현재 그리드에 표시된 상태에 따라 포함, 'hidden'
이면 포함 안함, 'visible'
이면 포함한다.
header
그리드 헤더 영역을 포함시킬 것인지의 여부
Type
- string
Remarks:
'default'
일 때는 현재 그리드에 표시된 상태에 따라 포함, 'hidden'
이면 포함 안함, 'visible'
이면 포함한다.
headerSummary
그리드 Header Summary 영역을 포함시킬 것인지의 여부
Type
- string
Remarks:
'default'
일 때는 현재 그리드에 표시된 상태에 따라 포함, 'hidden'
이면 포함 안함, 'visible'
이면 포함한다.
hiddenColumns
엑셀의 hidden Column
Type
- string[]
Remarks:
엑셀로 export되었을때 hidden상태로 내보내기 되는 컬럼을 지정한다. 내보내기 종류가 엑셀일 때만 사용 가능하다.
hideColumns
엑셀로 내보내기 안하고자 하는 컬럼을 배열
Type
- string[]
Remarks:
visible
이 true
이지만 내보내기를 하고 싶지 않은 컬럼을 지정한다. 내보내기 종류가 엑셀일 때만 사용 가능하다.
indenting
행 그룹핑 및 트리 그리드 자료를 내보내기 시 들여쓰기 여부
Type
- boolean
Remarks:
indicator
그리드 인디케이터 영역을 포함시킬 것인지의 여부
Type
- string
Remarks:
'default'
일 때는 현재 그리드에 표시된 상태에 따라 포함, 'hidden'
이면 포함 안함, 'visible'
이면 포함한다.
indicatorValue
그리드 인디케이터 영역을 내보내기 했을 때, 해당 영역의 값의 표시 방법
Type
- string
Remarks:
'default'
일 때는 현재 그리드에 표시된 상태에 따라, 'row'
이면 행의 고유번호로, 'item'
이면 1부터 시작하여 표시한다.
layoutExpand
expandable이 설정된 컬럼을 export할때 expand여부
Type
- ExportLayoutExpand | string
Remarks:
화면의 expand상태에 상관없이 접거나 펼친 상태로 export할때 설정한다.
linear
컬럼 그룹을 해제하고 엑셀로 내보내기 할 것인지의 여부
Type
- boolean
Remarks:
lookupDisplay
컬럼의 lookupDisplay 값을 표시된 값으로의 내보내기 여부
Type
- boolean
Remarks:
onlyCheckedItems
체크한 행들만 엑셀로 내보내기 할 것인지의 여부
Type
- boolean
Remarks:
그룹핑 된 행이나 TreeView 에서는 지원하지 않는다.
pagingAllItems
엑셀로 내보내기 시 페이징되어 보이지 않는 데이터를 포함한 모든 데이터를 내보내기 할 것인지의 여부
Type
- boolean
Remarks:
protectPassword
시트 보호를 사용할때 해제 암호를 입력한다.
Type
- string
Remarks:
영문/숫자/특수문자만 입력해야한다. 한글을 입력하는 경우 시트보호를 해제할수 없다.
protectProperties
시트 보호를 사용할때 허용하거나 잠글 속성을 지정한다.
Type
- SheetProtectProperties
separateRows
엑셀 내보내기 시 병합 해제 여부
Type
- boolean
Remarks:
sheetAttrs
엑셀로 내보내기 할때 sheet에 추가할 attribute
Type
- ConfigObject
Remarks:
json 형식으로 입력된 값을 sheetView element의 attribute로 추가한다.
Example:
var sheetAttrs = {
showGridLines: "0", // 눈금선 감추기
view: "pageBreakPreview" // 페이지 나누기 미리 보기
}
gridView.exportGrid({type:"excel", target:"local", sheetAttrs:sheetAttrs})
sheetName
엑셀 sheet 명
Type
- string
Remarks:
sheetProtect
잠긴 셀의 내용과 워크시트 보호
Type
- boolean
Remarks:
다른 사용자가 잠긴 셀을 수정하지 못하도록 시트 보호를 설정한다.
showColumns
엑셀로 내보내기 하고자 하는 컬럼의 배열
Type
- string[]
Remarks:
visible
이 false
이지만 내보내기를 하고 싶은 컬럼을 지정한다. 내보내기 종류가 엑셀일 때만 사용 가능하다.
showLevelOutline
행 그룹핑 된 자료를 내보내기 시 엑셀 왼쪽에 위치한 그룹간 묶음선 표시여부
Type
- boolean
Remarks:
stylePrefix
엑셀로 내보내기 할때 스타일 찾기위한 접두어가 있는 경우 사용
Type
- string
Remarks:
제공된 스타일에 영역을 제한하기 위한 className이 있는 경우 사용한다.
unCheckMark
그리드 체크바 영역을 내보내기 했을 때, 선택 해제된 값의 표시 방법
Type
- string
Remarks:
userCells
사용자 지정 출력
Type
- UserExportCell[]
Remarks:
export되는 엑셀파일에 그리드 이외의 내용을 출력할때 사용한다.
그리드가 출력하는 영역은 사용을 자제해야한다.
userCellsCallback
사용자 출력셀을 만들기 위해 호출되는 callback userCells가 지정되어있으면 callback은 무시된다.
Type
- UserCellsCallback
Remarks:
출력되는 column과 row의 갯수를 참조해서 cell의 위치를 변경할때 사용한다.
xOffset
왼쪽 여백컬럼의 수를 지정한다.
Type
- number
Remarks:
그리드를 출력할때 지정된 컬럼수 이후부터 출력한다.
xOffsetWidth
왼쪽 여백컬럼의 너비를 지정한다.
Type
- number
Remarks:
pixel단위로 지정한다.
yOffset
위쪽 여백행의 수를 지정한다.
Type
- number
Remarks:
그리드를 출력할때 지정된 행수 이후부터 출력한다.