RealGrid2 API
RealGrid Package

realgrid package

Classes

ClassDescription
GridViewGridView 클래스, GridBase 의 자식 클래스이다.
LocalDataProviderLocalDataProvider 클래스. DataProviderBase 를 상속한다.
LocalTreeDataProviderLocalTreeDataProvider 클래스. DataProviderBase 를 상속한다.
RealGridRealGrid 메인 클래스
TreeViewTreeView 클래스, GridBase 의 자식 클래스이다.

Abstract Classes

Abstract ClassDescription
CustomCellRendererImpl사용자 정의 Renderer의 상위 class이다.
DataProviderBaseLocalDataProviderLocalTreeDataProvider 의 기반 클래스
GridBaseGridBase는 GridViewTreeView의 기반 클래스(Base Class)이다.

Enumerations

EnumerationDescription
BarOriginBarCellRenderer 의 바의 위치
ButtonVisibility컬럼에 버튼이 설정된 경우, 데이터 셀에 컬럼 버튼과 편집 버튼을 표시하는 방법
CellButton데이터 셀의 우측에 표시할 버튼 종류
CellLayoutTypelayout의 type을 지정한다.
ColumnHeaderItemLocation컬럼 헤더의 이미지나 체크 박스의 위치 유형
ColumnLayoutDirectionCell Layout 설정 시 배치 방향
DataDropMode데이터 drop 시 모드
DataFillMode데이터 채우기 방법
DefaultShowDate달력 편집기를 사용할 때, 달력에 표시되는 날짜 유형
DragFeedbackStylemouse가 over 될때 drop 되는 위치를 보여주는 feedback의 style
DropDownPositionDropDownCellEditor 의 목록 또는 DateCellEditor, BTDateCellEditor 달력 선택 상자의 위치
DropDownSortStyleDropDownCellEditor 목록의 정렬 방식
DropDownValueLabelDropDownCellEditor 의 목록을 보여주는 방법
EdgeMarkedgeMark
ExitGridWhenTab

tab 입력 시 그리드를 벗어나기 위한 조건

EditOptions.exitGridWhenTab 에서 설정 가능하다.

ExpanderVisibility행 그룹핑 시 Expander 표시여부
ExportLayoutExpandlayout Expandable이 true인 layut을 excel로 export할때
ExportTarget그리드를 외부 문서로 내보내기 할 때의 대상
ExportType그리드를 외부 문서로 내보내기 할 때의 종류
FilterMode데이터 수정 이후 필터 동작 모드
FocusMoveStepcolumnGroup이 있을때 왼쪽화살표 또는 오른쪽 화살표를 입력했을때 focus이동 방식
FocusType

focus를 layer형태로 표시하거나 테두리만 표시한다.

DisplayOptions.focusType 에서 설정 가능하다.

GridCellType그리드의 셀 종류
GridFitStyle컬럼들의 표시 방식을 조정하는 상수
GroupShowMode

그룹컬럼을 접거나 펼쳤을때 보여질것인가를 결정한다.

CellLayoutItem.groupShowMode에서 설정한다.

HandleVisibility핸들의 표시 방법
IconLocation렌더링하는 아이콘, 체크박스, 도형 등의 위치
IndicatorValue인디케이터에 표시될 내용 종류
InlineFilterOperatorFilterPanel에서 사용할수 있는 연산자의 종류이다.
ItemState아이템의 상태
ItemType그리드에서 아이템의 종류
MenuItemTypePopupMenu 등에 표시되는 메뉴 항목의 유형
NullsOrder

정렬할때 undefined, null ''을 오름차순, 내림차순에 관계없이 상단 또는 하단에 위치시킨다.

SortingOptions.nullsOrder에서 설정한다.

PolygonShapeShapeCellRenderer 에서 사용 가능한 도형 목록
RefreshMode그리드를 다시 그릴 때 필요한 상수
RestoreMode복원 모드 종류
RowGroupAdornments행 그룹 상태일 때 헤더나 푸터의 표시 방법
RowMaskType선택 된 행의 표시 형태 (행의 마스크 종류)
RowState행의 상태
ScrollOnEditing편집 중 일때 스크롤 시 처리 상태
SelectionDisplay셀 선택 디스플레이
SelectionMode셀 선택 영역에 대한 모드
SelectionStyle셀 선택 영역에 대한 스타일
SortCase대소문자 구분 유형
SortDirection정렬 방식
SortMode데이터 수정 이후 정렬 동작 모드
SortStyle그리드 컬럼 헤더 클릭 시 정렬 유형
StateMark상태바의 상태 표시 방법
SummaryMode그리드의 각 컬럼의 합계를 계산하는 방식
SummaryType필드의 합계값을 계산하기 위한 유형
SyncGridHeight조회된 data가 모두 보일수 있도록 그리드의 높이를 변경한다.
TextInputCase대소문자 형태
TimeSelectType
TreeExpanderIconStyleTree Expander에 표시되는 기본 아이콘의 스타일을 지정한다.
ValidationLevel데이터 검증 결과 수준
ValidationMode검증 방법
ValueType데이터 필드의 데이터 자료형
VerticalMoveStepdirection이 vertical인 ColumnGruop의 하위 컬럼에서 위화살표 또는 아래화살표를 입력했을때 focus이동 방식.

Interfaces

InterfaceDescription
BarCellRenderer숫자 형 컬럼 셀의 값을 바(bar)로 표시하는 렌더러
BTDateCellEditorBootStrap DatePicker 를 이용한 편집기
ButtonCellRenderer버튼을 표시하는 렌더러
CellEditor셀 편집기들의 기반이 되는 모델
CellIndex셀의 위치정보 모델
CellLayoutColumnItem컬럼 레이아웃 정보 모델
CellLayoutGroupHeader

CellLayoutGroupItem.header의 설정 정보 모델

[상위 클래스] CellLayoutHeader

CellLayoutGroupItem그룹 레이아웃 정보 모델
CellLayoutHeader셀 레이아웃 헤더의 설정 정보 모델
CellLayoutItem레이아웃을 설정하기 위한 기반 모델
CellProtectProperties셀 잠금 또는 셀 숨김을 설정한다.
CellRenderer셀 렌더러들의 기반 모델
CheckBar체크바와 관련된 설정 모델
CheckCellRenderer값이 참인지 거짓인지를 표시하는 렌더러
ClickData클릭한 아이템의 정보 모델
Code128CellRendererCode128 Barcode를 표시하는 렌더러
Code39CellRendererCode39 Barcode를 표시하는 렌더러
ColumnFilter컬럼 필터링에 관련된 설정 정보
ColumnFilterCollectionColumnFilter 의 콜렉션 모델
ColumnFooter그리드 푸터 영역에 표시되는 컬럼 푸터에 대한 설정 정보
ColumnFooterCollectionColumnFooter 의 컬렉션
ColumnHeader그리드 헤더 영역에 표시되는 컬럼 헤더에 대한 설정 정보 모델
ColumnHeaderSummary그리드 헤더 영역에 표시되는 ColumnSummary 의 설정 정보
ColumnHeaderSummaryCollectionColumnHeaderSummary의 컬렉션
ColumnLayoutInfo설정된 레이아웃이 CellLayoutColumnItem 모델일 경우, GridBase.saveColumnLayout() 에서 반환되는 오브젝트
ColumnObject컬럼 관련 클래스들의 기반 클래스
ColumnStyleObjectCellStyleCallback 으로 셀 스타일 변경 시 반환해야 하는 스타일 모델 중 하나
ColumnSummaryColumnFooter, ColumnHeaderSummary 등의 기반 클래스
ColumnSummaryStyleObjectCellStyleCallback 으로 셀 스타일 변경 시 반환해야하는 스타일 모델 중 하나
CopyOptions그리드의 내용을 클립보드를 복사하는 것에 대한 설정 모델
CustomCellRenderer사용자 지정 셀 렌더러를 설정할 때 사용하는 오브젝트
DataCell그리드 Data영역의 셀정보
DataColumnValueColumn 을 상속한 컬럼 정보 모델
DataDropOptions다른 그리드에서 drag 된 데이터를 처리하는 방식에 대한 설정 모델
DataExportOptions내보내기에 관한 설정 모델
DataField데이터 필드 모델 객체
DataFieldObject설정할 때 사용하는 DataField 와 동일한 구조의 오브젝트
DataFillOptions데이터 불러오기에 관한 설정 모델
DataFilter데이터 필터 조건을 갖고 있는 오브젝트
DataOptionsDataProviderBase 의 전체설정 정보들
DataOutputOptions출력할 때 데이터를 반환하는 방식에 대한 설정 모델
DateCellEditor날짜 편집기
DateHoliday날짜로 지정하는 공휴일
DayHoliday요일로 지정하는 공휴일
DisplayOptions그리드 수준에서 관리되는 표시 정보들에 대한 설정 모델
DocumentTitleGridExportOptions 모델과 GridBase.exportGrid() 를 사용하여 그리드를 내보내기 할 때, Excel 문서의 제목, 부제, 꼬릿말을 설정하기 위한 모델
DropDownCellEditor목록으로 수정할 수 있는 편집기 (dropdown 편집기)
EditingItemInfoGridBase.getEditingItem() 에서 반환되는 오브젝트 형식
EditMaskObject텍스트나 날짜 필드에 적용할 수 있는 편집기의 오브젝트 형태 표시 형식
EditOptions그리드에서의 데이터 편집에 대한 설정 모델
EditorOptions그리드 수준에서 관리되는 편집기 정보들에 대한 설정 모델
EditResultGridBase.onGetEditValue 에서 쓰이는 셀 편집 후 출력 정보
EditValidation컬럼 단위 혹은, 행 단위 데이터 편집 검증 조건과 방식에 대한 모델
EditValidationCollectionEditValidation 의 콜렉션 모델
ExportBaseOptions그리드 및 데이터 내보내기에 관한 설정들의 기반 모델
ExportOptions그리드 및 데이터 내보내기에 관한 설정들의 공통 모델
FieldMapDataDropOptions.fieldMap 에서 사용되는 옮길 그리드의 필드명 - 옮김을 받은 그리드의 필드명 쌍 형식
FilterAutomatingOptions자동 필터링에 관한 설정 정보
FilterCategory사용자 지정 자동필터링 생성 시 카데고리 분류 모델
FilteringOptions컬럼 필터링과 관련된 설정 모델
FilterPanelGridHeader영역 아래 사용자가 입력한 값을 이용해서 filtering을 할수 있는 입력창을 표시한다.
FilterSelectorOptions컬럼 필터의 선택 상자에 대한 설정 모델
FixedOptions그리드의 고정 행 및 컬럼 영역에 대한 설정 모델
FormatOptions데이터 필드 값의 변환 형식에 대한 설정 모델
GridCell
GridColumn컬럼 정보 모델
GridExportOptions그리드 내보내기에 관한 설정 모델
GridFooter푸터 영역의 단일 설정 모델
GridFooterCollection그리드 푸터 영역에 관한 콜렉션 모델
GridHeader헤더 영역의 설정 모델
GridItem아이템의 정보 모델
GridOptions그리드의 전체 설정 정보들
GroupingOptions행 그룹핑에 관련된 설정 모델
GroupItem

그룹 아이템의 정보 모델

[상위 클래스]

GridItem

콜백의 파라메터로 전달될때만 사용된다.

GroupLayoutInfo설정된 레이아웃이 CellLayoutGroupItem 모델일 경우, GridBase.saveColumnLayout() 에서 반환되는 오브젝트
GroupPanel그리드 Group Panel 표시 정보들에 대한 설정 정보
GroupSummaryGridBase.getGroupSummary() 에서 반환되는 오브젝트 형식
HeaderSummaryHeader Summary 영역의 단일 설정 모델
HeaderSummaryCollectionHeader summary 영역에 관한 콜렉션 모델 오브젝트
IconCellRenderer아이콘 렌더러
ImageCellRenderer이미지 렌더러
InvalidCellGridBase.getInvalidCells() 에서 반환되는 오브젝트 형식
LineCellEditor한 줄 입력을 받을 수 있는 텍스트 편집기
LinkCellRenderer하이퍼링크를 표시하는 렌더러
LookupDataKeyValuesLookupData 의 한 종류
LookupDataRowsLookupData 의 한 종류
LookupSource컬럼에 연결된 데이터 필드의 실제 값 대신 그 값과 연관된 다른 값을 셀에 표시하기 위한 설정 정보
MenuItem메뉴 항목 관련 설정 정보 모델
MobileOptions모바일 관련 설정 모델
MultiCheckCellEditor드롭 다운 목록에서 여러 항목들을 선택할 수 있는 편집기
MultiLineCellEditor

여러 줄 입력을 받을 수 있는 편집기

CellEditor 를 상속한다.

[상위 클래스]

CellEditor

NumberCellEditor숫자와 구두점 및 부호만을 입력할 수 있는 편집기
NumberFormatOptions언어별로 다르게 표현되는 숫자, 화폐, 회계 를 표시하기 위한 formatOption
PasswordCellEditor암호를 입력하기 위한 편집기
PasteOptions클립보드의 데이터를 그리드에 붙여넣는 것에 관한 설정 모델
PopupMenu

그리드에 등록되는 팝업 메뉴 또는 하위 메뉴의 설정 모델

[상위 클래스]

PopupMenuBase

PopupMenuBasePopupMenuPopupMenuItem 의 기반 클랙스 이다.
PopupMenuItem

마우스 오른쪽 클릭을 통해 표시되는 팝업 메뉴 아이템의 설정 모델

PopupMenu 참조

[상위 클래스]

PopupMenuBase

RealGridLocale

그리드가 참조하기 위한 locale과 currency를 설정한다.

numberFormats: Intl.NumberFormat (opens in a new tab)을 이용한 numberFormat을 등록한다.

messages: 그리드의 메시지를 사용자 환경에 맞게 변경한다.

RealGridMessages그리드에서 출력되는 text를 지정한다.
RendererEditResult사용자 지정 렌더러의 편집 완료 결과 모델
RowGroup행 그룹핑과 관련된 영역들의 표시 방법 등에 대한 설정 모델
RowGroupFooter그리드 그룹푸터 모델
RowGroupFooterCollection그리드 그룹 푸터 영역에 관한 콜렉션 모델
RowIndicator그리드의 인디케이터에 관한 설정 모델
RowStateList행 상태의 따른 행들의 목록
RowStyleObjectRowStyleCallback 으로 행의 스타일을 변경시 반환되는 스타일 모델
SearchCellEditor검색 기능이 추가 된 드롭 다운 편집기
SearchCellOptions셀 검색 관련 유연한 설정 모델
SearchCellResult검색된 셀의 위치정보
SearchOptions행 검색 관련 유연한 설정 정보 모델
Selection그리드 선택 영역 정보 모델
SeriesColumn하나 이상의 데이터 값을 동시에 표시하는 컬럼
SeriesTextCellRenderer하나 이상의 데이터 값을 동시에 표시하는 Series column 을 텍스트로 표시하기 위한 렌더러
ShapeCellRenderer그리드에 포함되어 있는 도형을 표시하는 렌더러
SheetProtectProperties엑셀 시트 보호를 적용시 허용할 속성을 지정한다.
SignalBarCellRenderer셀 값을 신호세기로 표시하는 렌더러
SortedFieldsgridView.getSortedFields의 return 형식
SortingOptions데이터 정렬에 대한 설정 모델
SparkChartRenderer스파크 차트 그래프를 표시하기 위한 렌더러들의 기반 모델
SparkColumnRenderer하나 이상의 데이터 값을 동시에 표시하는 Series column 을 Spark Column 으로 표시하기 위한 렌더러
SparkLineRenderer하나 이상의 데이터 값을 동시에 표시하는 Series column 을 Spark Line 으로 표시하기 위한 렌더러
SparkWinLossRenderer하나 이상의 데이터 값을 동시에 표시하는 Series column 을 Spark WinLoss 으로 표시하기 위한 렌더러
StateBar

행들의 상태를 표시하는 상태바와 관련된 설정 모델

GridBase.setStateBar() 사용시 필요한 정보만 입력하면 된다.

StateTexts상태바에 표시될 상태 텍스트들 종류
StyledCell그리드의 구성요소중 공간을 채우기위해 사용되는 셀의 모델
TemplateCellRendererHTML 형식의 템플릿을 표시하는 렌더러
TextCellEditor텍스트 입력을 받을 수 있는 편집기들의 기반 모델
TextCellRenderer기본 텍스트 렌더러
ToastOptionsToast View 표시 여부와 메시지를 지정할 수 있는 설정 모델
TreeOptionsTreeView 표시에 대한 설정 모델
UpdatedCell변경된 셀 정보
UpdatedRow변경된 행 정보
UserExportCell엑셀로 export할때 그리드가 출력하는 내용외에 추가적으로 출력할 내용을 지정한다.
ValidationError검증 결과 관련 설정 정보 모델
ValueCellDataCell의 상위 클래스이다.
ValueColumnGridColumn 을 상속한 컬럼 정보 모델
ViewOptionsGridView 의 전체 설정 정보들
WaiOptionsShadow Dom 에 관한 설정 모델

Type Aliases

Type AliasDescription
BooleanOutputCallbackboolean 필드 변환시 수행 될 콜백함수 형식
CategoryCallback자동 필터링 시 사용자 지정 분류를 위한 콜백 형식
CellSpanCallback사용자 지정의 cell spanning을 설정하기 위한 콜백
CellStyleCallback동적 셀 스타일 변경을 위한 콜백
CheckableCallbackCheckBar 에서 체크 가능 여부를 결정하는 콜백
ColumnObjectCallbackdataTypeobject인 data를 화면에 표시할때 사용되는 콜백
ColumnSummaryCallback컬럼의 footer 또는 summary에 표시되는 값을 사용자가 지정할때 사용되는 콜백의 형식
CompareCallback검색할 때 사용자 임의로 조건을 지정하기 위한 값 비교 콜백 형식
CompareFunction비교함수 형식
ConfigObject
CopyTextCallback그리드를 복사할때 클립보드에 저장되는 text를 반환하는 콜백 형식
CreateFooterCallback특정 그룹 푸터의 표시 여부를 지정하기 위한 콜백 형식
DataDragCallback그리드 간 drag and drop 을 시작할 때 발생하는 콜백 형식
DataDragLabelCallbackdrag 중인 item 의 label 텍스트를 결정하기 위한 콜백의 형식
DataDropCallback그리드 간 drag and drop 했을 때 발생하는 콜백 형식
DataFieldInput데이터 필드에 관한 입력 형식
DataFilters필터 조건의 배열 및 컬렉션 오브젝트
DataValues행 오브젝트 및 행 배열
DatetimeOutputCallbackdatetime 필드 변환시 수행 될 콜백함수 형식
DropFieldMapCallback그리드 간 drag and drop 으로 이동 / 복사를 할 때 적용되는 규칙을 반환하는 콜백 형식
EditMask텍스트나 날짜 필드에 적용할 수 있는 편집기의 표시 형식
ExpanderVisibleCallback그룹 expander의 visible 여부를 return 하는 callback
ExportSimpleCallbackdone 을 설정하기 위한 내보내기를 완료할 때 수행될 콜백의 형식
ExportValueCallback그리드 내보내기 설정에서 필드 별로 출력 시 수행될 콜백을 지정하기 위한 형식
FieldValueCallbackcalculated 필드일 경우 수식을 지정하여 계산 될 콜백의 형식
FilterCallback필터 콜백
FilterPanelCallbackFilterPanel의 입력창에 text를 입력후 enter를 입력하거나 filterDelay이후 호출되는 callback이다.
GetAriaLabelCallbackCellRenderer.ariaLabelCallback 에서 사용되는 콜백 형식
GetCellTitleCallback이미지 렌더링 할 때 이미지의 alt 텍스트 설정 또는 링크 셀 렌더링 할 때 HTML Anchor Element의 title 텍스트를 설정을 위한 콜백 형식
GetCheckedCallback렌더링 시 체크 값을 결정하는 콜백 형식
GetClassCallbacklinkRenderer의 a tag에 class를 추가
GetImageCallback이미지를 렌더링을 위해 이미지의 경로를 지정하는 콜백 형식
GetLinkUrlCallbackLinkCellRenderer.urlCallback 에서 사용되는 콜백 형식
GetShapeCallback도형 렌더러에서 도형의 종류를 지정하기 위한 ShapeCellRenderer.shapeCallback 에서 사용하는 콜백 형식
GetTemplateCallbackTemplateCellRenderer.callback 에 사용되는 콜백 형식
GroupFooterCellSpanCallback사용자 지정의 groupFooter spanning을 설정하기 위한 콜백
GroupFooterStyleCallback그리드 그룹 푸터 행의 스타일을 지정하기 위한 콜백
GroupFooterUserSpanCallback사용자 지정 groupFooterUser span을 설정하기 위한 콜백
HeaderCallback행 그룹 Header에 표시되는 Text를 return 하는 Callback
Holidays공휴일 지정을 위한 설정 모델
LayoutInfoGridBase.saveColumnLayout() 에서 반환되는 레이아웃의 정보 모델
LayoutItem원하는 형태의 컬럼을 만들 수 있는 레이아웃 아이템 모델의 타입
ListCallbackDropDownCellEditor의 목록을 만들때 사용하는 콜백 조건에 따라 변경되는 item을 가져올때 사용한다.
ListResultListCallback 또는 GridBase.onSearchCellButtonClick 의 return type
ListTemplateCallbackDropDownCellEditor 또는 SearchCellEditor에서 list에 표시되는 item을 사용자가 작성할때 사용하는 콜백
LookupDataLookupSource 를 채우기 위한 모델 정보
MenuItemClick메뉴 아이템을 클릭 시 호출되는 콜백
NumberOutputCallbacknumber 필드 변환시 수행 될 콜백함수 형식
ObjectToValuesCallbackjson형태의 data를 dataProvider에 입력할때 각 행별로 호출되는 콜백
OuterSortCallback사용자가 sort를 수행할때 지정하는 콜백형식
ProgressCallback그리드 내보내기 설정에서 showProgress가 true일때 수행될 콜백을 지정하기 위한 형식
RealizeHeaderCallbackColumnHeader.templateCallback 또는 CellLayoutGroupHeader.templateCallback에 사용되는 콜백 형식
RealizeSummaryCallbackColumnSummary.templateCallback에서 사용되는 콜백 형식
RealizeValueCallbackTemplateCellRenderer.valueCallback 에 사용되는 콜백 형식
RowBarCellStyleCallbackRowBar영역의 셀 스타일을 지정하기 위한 콜백
RowBlockCallbackrow block 마스크를 설정하기 위한 콜백
RowHeightCallback행의 높이를 반환하는 콜백형식
RowObject행 오브젝트
RowStyleCallback행 스타일 변경을 위한 콜백
RowValues행 데이터
ScrollMessageCallbacklivescroll 을 미적용 할 때 스크롤 위치를 알려주는 화면에 표시되는 메시지를 반환하는 콜백 형식
SetCheckedCallback편집 시 체크 결과 값을 결정하는 콜백 형식
SummaryCellSpanCallback사용자 지정의 headerSummary와 footer spanning을 설정하기 위한 콜백
TreeIconCallback

트리 expander옆에 표시되는 아이콘을 지정하는 콜백

[매개변수 목록]

TreeView - 트리뷰 객체

itemIndex - 행의 인텍스

dataRow - 행의 dataRow

iconIndex - 원 iconIndex의 값

[반환값] - icon의 url 또는 TreeOptions.iconImages의 순번

UserCellsCallback사용자가 출력 셀을 추가할때 사용되는 콜백 GridExportOptions.userCells이 있는 경우 수행되지 않는다.
ValueForGroupCallback동일한 값이 아니지만 하나의 그룹으로 묶을때 기준이 되는 값을 개발자가 지정할때 사용한다. field의 dataType과 동일한 dataType으로 return 해야한다.

Enumerations Desc

BarOrigin

BarCellRenderer 의 바의 위치

Members:

MemberValueDescription
BOTTOMbottom아래쪽
DEFAULTdefault기본값
LEFTleft왼쪽
RIGHTright오른쪽
TOPtop위쪽

Example:

column.renderer = {
     "type": "bar",
     "origin":"right"
}

ButtonVisibility

컬럼에 버튼이 설정된 경우, 데이터 셀에 컬럼 버튼과 편집 버튼을 표시하는 방법

Members:

MemberValueDescription
ALWAYSalways항상 표시
DEFAULTdefault마우스가 셀 위에 있거나, 셀을 선택한 상태에서만 표시
HIDDENhidden표시하지 않음
ROWFOCUSEDrowfocused행이 선택된 상태에서 표시
VISIBLEvisible셀을 선택한 상태에서 표시

Remarks:

ValueColumn의 buttonVisibility 속성과 editButtonVisibility 속성에 사용된다.

Example:

// 컬럼 버튼
column.buttonVisibility = false;
 
// 편집기의 버튼
column.editButtonVisibility = false;

CellButton

데이터 셀의 우측에 표시할 버튼 종류

Members:

MemberValueDescription
ACTIONaction실행 버튼 (클릭 시 onCellButtonClicked 콜백 호출)
NONEnone버튼 없음
POPUPpopup팝업 메뉴 버튼

Remarks:

ValueColumn.button 에서 사용된다.

Example:

column.button = 'popup';

CellLayoutType

layout의 type을 지정한다.

Members:

MemberValueDescription
COLUMNcolumn컬럼과 연결된 layout을 생성한다.
GROUPgroupgroupLayout을 추가할때 사용한다.

Remarks:

GridBase.addLayout() 또는 CellLayoutGroupItem.addLayout() 을 이용해서 Layout을 추가할때 layout의 type을 지정한다.

ColumnHeaderItemLocation

컬럼 헤더의 이미지나 체크 박스의 위치 유형

Members:

MemberValueDescription
BOTTOMbottom아래쪽
BOTTOM_EDGEbottomEdge아래쪽 모서리
CENTERcenter가운데
LEFTleft왼쪽
LEFT_EDGEleftEdge왼쪽 모서리
NONEnone없음
RIGHTright오른쪽
RIGHT_EDGErightEdge오른쪽 모서리
TOPtop위쪽
TOP_EDGEtopEdge위쪽 모서리

Remarks:

ColumnHeader.checkLocation 에서 사용된다.

Example:

let col = grid.columnByName('col1')
col.header.checkLocation = 'leftEdge';

ColumnLayoutDirection

Cell Layout 설정 시 배치 방향

Members:

MemberValueDescription
HORIZONTALhorizontal수평적으로 배치
VERTICALvertical수직적으로 배치

Remarks:

CellLayoutGroupItem.direction 에서 사용된다.

DataDropMode

데이터 drop 시 모드

Members:

MemberValueDescription
COPYcopy복사
MOVEmove이동

DataFillMode

데이터 채우기 방법

Members:

MemberValueDescription
APPENDappend마지막 행 뒤에 데이터 추가
INSERTinsert삽입
SETset기존 데이터를 무시하고 0행부터 데이터 행 개수만큼 채움
UPDATEupdate기존 데이터를 대체한다. 마지막행까지 도착한 이후 남은 데이터는 무시된다.

Remarks:

DataFillOptions.fillMode 에서 사용한다.

DefaultShowDate

달력 편집기를 사용할 때, 달력에 표시되는 날짜 유형

Members:

MemberValueDescription
DEFAULTdefault지정된 날짜
DEFAULT_WHEN_NULLdefaultWhenNull셀에 데이터가 있는 경우 해당일자, 없는 경우 지정된 날짜가 선택되어 표시된다.
NORMALnormal일반
TODAYtoday오늘
TODAY_WHEN_NULLtodayWhenNullnormal 의 동작과 같지만, 날짜가 없는 경우에만 현재 일자가 선택되어 표시되는 유형

Remarks:

DateCellEditor 에서 사용된다.

Example:

column.editor = { type: "date", maxLength: 6, yearNavigation: true, defaultShowDate: 'today' }

DragFeedbackStyle

mouse가 over 될때 drop 되는 위치를 보여주는 feedback의 style

Members:

MemberValueDescription
CELLcell
GROUPgroup드랍되는 컬럼 Group셀에 overlay되는 block형태로 표시.
LINEline

Line

드랍되는 행의 위 또는 아래에 line형태로 표시

ROWrow

Block or Row

드랍되는 행에 overlay되는 block형태로 표시

DropDownPosition

DropDownCellEditor 의 목록 또는 DateCellEditor, BTDateCellEditor 달력 선택 상자의 위치

Members:

MemberValueDescription
BUTTONbutton버튼에 맞추어 정렬
EDITOReditor편집기에 맞추어 정렬

Example:

column.editor = {
		type: 'list',
		values: ['value1', 'value2'],
		dropDownPosition: 'editor'
}

DropDownSortStyle

DropDownCellEditor 목록의 정렬 방식

Members:

MemberValueDescription
ASCENDINGascending오름차순
DESCENDINGdescending내림차순
NONEnone지정 안함

Example:

column.editor = {
		type: 'list',
		values: ['value1', 'value2'],
		itemSortStyle: 'descending'
}

DropDownValueLabel

DropDownCellEditor 의 목록을 보여주는 방법

Members:

MemberValueDescription
LABELlabellabel 값만
LABEL_VALUElabelValuelabel - value 순서쌍
VALUEvaluevalue 값만
VALUE_LABELvalueLabelvalue - label 순서쌍

Example:

column.editor = {
		type: 'list',
		values: ['value1', 'value2'],
		labels: ['label1', 'label2'],
		displayLabels: 'valueLabel'
}

EdgeMark

edgeMark

Members:

MemberValueDescription
LEFT_BOTTOMleftBottom왼쪽 아래
LEFT_TOPleftTop왼쪽 위
RIGHT_BOTTOMrightBottom오른쪽 아래
RIGHT_TOPrightTop오른쪽 위

Remarks:

ValueColumn.edgeMark에서 사용된다.

Example:

column.edgeMark = "leftTop"

ExitGridWhenTab

tab 입력 시 그리드를 벗어나기 위한 조건

EditOptions.exitGridWhenTab 에서 설정 가능하다.

Members:

MemberValueDescription
GRIDgrid그리드의 마지막 셀일 경우 벗어난다.
NONEnonetab키를 입력했을때 그리드를 벗어나지 않는다.
ROWrow행의 마지막 셀일 경우 벗어난다.

Example:

grid.editOptions.exitGridWhenTab = 'grid';

ExpanderVisibility

행 그룹핑 시 Expander 표시여부

Members:

MemberValueDescription
ALWAYSalways행 그룹핑 시 Expander 를 항상 표시한다.
DEFAULTdefault기본값: 그룹핑 된 행들이 여러 개 보임 상태이면 표시하고 그렇지 않으면 표시하지 않는다.
NONEnone행 그룹핑 시 Expander 를 표시하지 않는다.

Remarks:

RowGroup.mergeExpanderVisibility 에서 사용된다.

Example:

gridView.rowGroup.mergeExpanderVisibility = 'always';

ExportLayoutExpand

layout Expandable이 true인 layut을 excel로 export할때

Members:

MemberValueDescription
COLLAPSEcollapse접힌 상태로 출력한다.
CURRENTcurrentcurrent 현재모양
EXPANDexpand펼쳐진 상태로 출력한다.
IGNOREignoreexpandable을 무시하고 설정된 layout모양대로 출력한다.

ExportTarget

그리드를 외부 문서로 내보내기 할 때의 대상

Members:

MemberValueDescription
LOCALlocal로컬에 직접 저장
REMOTEremote서버를 경유해서 저장
STREAMstream콘솔에 내보내기

ExportType

그리드를 외부 문서로 내보내기 할 때의 종류

Members:

MemberValueDescription
CSVcsvCSV
EXCELexcel엑셀

Remarks:

ExportBaseOptions.type 에서 사용된다.

FilterMode

데이터 수정 이후 필터 동작 모드

Members:

MemberValueDescription
AUTOauto자동
EXPLICITexplicit데이터 수정이후 명시적으로 필터링을 수행해야 필터링됨

Remarks:

GridView.filterMode 에서 사용된다.

Example:

gridView.filterMode = 'explicit';

FocusMoveStep

columnGroup이 있을때 왼쪽화살표 또는 오른쪽 화살표를 입력했을때 focus이동 방식

Members:

MemberValueDescription
CELLcell셀단위로 이동한다.
GROUPgroup최상위 그룹단위로 이동한다.

FocusType

focus를 layer형태로 표시하거나 테두리만 표시한다.

DisplayOptions.focusType 에서 설정 가능하다.

Members:

MemberValueDescription
LAYERlayer선택된 셀을 덮는 layer형태로 표시한다.
LINEline선택된 셀의 테두리만 line으로 표시한다.

GridCellType

그리드의 셀 종류

Members:

MemberValueDescription
CHECKcheck체크 바
DATAdata데이터
FILTERfilterfilter rowIndicator영역
FIXED_BARfixedbar고정 바
FOOTfootfoot
FOOTERfooter푸터
GRID_EMPTYgridEmpty빈 그리드
GROUP_BARgroupBar그룹 바
GROUP_COLUMNgroupColumn그룹 컬럼
GROUP_FOOTgroupFootgroup foot
GROUP_FOOTERgroupFooter그룹 푸터
GROUP_HEADgroupHeadgroup head
GROUP_HEADERgroupHeader그룹 헤더
GROUP_PANELgroupPanel그룹 패널
HEADheadhead
HEADERheader헤더
INDICATORindicator인디케이터
INLINE_FILTERinlineFilterinline-filter body영역
LAYOUT_HEADERlayoutHeaderColumn Group의 Header
STATEstate상태 바
SUMsumsum
SUMMARYsummarySummary

Remarks:

ClickData 등에서 사용된다.

Example:

gridView.onMenuItemClicked =  function (grid, item, clickData) {
     console.log(item.label + "was clicked.");
     console.log("cellType is: " + clickData.cellType);
};

GridFitStyle

컬럼들의 표시 방식을 조정하는 상수

Members:

MemberValueDescription
EVENeven표시한 컬럼들의 전체 너비가 그리드 너비보다 작을 경우 비율에 맞춰 남는 크기를 분배
EVEN_FILLevenFill항상 그리드 너비에 맞게 늘리거나 축소 (컬럼의 width를 이용)
FILLfillfillWidth가 설정되었다면 이를 이용하여, 그렇지 않다면 even과 동일한 방식으로 그리드를 채움
NONEnone조정하지 않고 컬럼 너비대로 표시

Remarks:

DisplayOptions.fitStyle 등에서 쓰인다.

Example:

grid.displayOptions.fitStyle = 'even'

GroupShowMode

그룹컬럼을 접거나 펼쳤을때 보여질것인가를 결정한다.

CellLayoutItem.groupShowMode에서 설정한다.

Members:

MemberValueDescription
ALWAYSalways항상 보여진다.
COLLAPSEcollapse그룹을 접었을때 보여진다.
EXPANDexpand그룹을 펼쳤을때 보여진다.

Remarks:

상위 layout의 expand상태에 따라서 보이거나 숨도록 한다.

HandleVisibility

핸들의 표시 방법

Members:

MemberValueDescription
ALWAYSalways항상 표시
HIDDENhidden숨김
HOVEREDhovered호버링 된 경우만 표시
VISIBLEvisible표시

Remarks:

소팅(sorting), 필터링(filtering) 시 컬럼 헤더에 표시되는 기능 아이콘을 핸들(Handle)이라고 한다.

HandleVisiblity는 SortingOptions, FilteringOptions 의 handleVisibility 속성으로 구현되어 있다.

Example:

grid.sortingOptions.handleVisibility = 'visible';

IconLocation

렌더링하는 아이콘, 체크박스, 도형 등의 위치

Members:

MemberValueDescription
BOTTOMbottom텍스트 아래쪽에 표시
BOTTOM_EDGEbottomEdge셀 아래쪽 모서리에 표시
CENTERcenter셀 중앙에 표시
LEFTleft텍스트 왼쪽에 표시
LEFT_EDGEleftEdge셀 왼쪽 모서리에 표시
RIGHTright텍스트 오른쪽에 표시
RIGHT_EDGErightEdge셀 오른쪽 모서리에 표시
TOPtop텍스트 위쪽에 표시
TOP_EDGEtopEdge셀 위쪽 모서리에 표시

Remarks:

IconCellRenderer, CheckCellRenderer, ShapeCellRenderer 에서 사용된다.

Example:

...
"renderer": {
         "type": "check",
         "checkLocation": "right"
     },
...

IndicatorValue

인디케이터에 표시될 내용 종류

Members:

MemberValueDescription
INDEXindex행 순서
NONEnone없음
REVERSEreverse행 순서를 역순으로 표시
ROWrow행 고유 번호

InlineFilterOperator

FilterPanel에서 사용할수 있는 연산자의 종류이다.

Members:

MemberValueDescription
BETWEENbetween범위를 지정한다.
CONTAINScontains입력된 값을 포함하고 있는 Data
EMPTYempty값이 없는 Data를 검색
ENDS_WITHendsWith입력된 값으로 끝나는 Data
EQUALequal입력된 값과 동일한 Data
GREATERgreater입력된 값보다 큰 Data
GREATER_EQUALgreaterEqual입력된 값보다 크거나 같은 Data
LOWERlower입력된 값보다 작은 Data
LOWER_EQUALlowerEqual입력된 값보다 작거나 같은 Data
NOT_CONTAINSnotContains입력된 값을 포함하고 있지 않은 Data
NOT_EQUALnotEqual입력된 값과 다른 Data
RESETreset입력된 값을 지우고 filter를 비활성화 시킨다.
STARTS_WITHstartsWith입력된 값으로 시작하는 Data

Remarks:

DataColumn.valueType에 따라서 사용할수 있는 연산자에 제한이 있다.

ItemState

아이템의 상태

Members:

MemberValueDescription
APPENDINGappending추가 중인 경우
DUMMYdummy더미
FOCUSEDfocused입력된 인덱스가 현재 편집 중인 아이템의 인덱스인 경우
INSERTINGinserting삽입 중인 경우
NORMALnormal편집, 추가, 입력 중이 아닌 경우
UPDATINGupdating편집 중인 경우

ItemType

그리드에서 아이템의 종류

Members:

MemberValueDescription
FOOTERfooter그룹 푸터
GROUPgroup그룹 아이템
ROWrow
TREEtree트리 아이템

Remarks:

getModelAs() 등에서 사용한다.

Example:

let model = gridView.getModelAs(3, 'row');

MenuItemType

PopupMenu 등에 표시되는 메뉴 항목의 유형

Members:

MemberValueDescription
CHECKcheck체크박스와 텍스트
NORMALnormal일반 텍스트
RADIOradio라디오 버튼과 텍스트
SEPARATORseparator메뉴 항목 간 구분

Remarks:

PopupMenuItem.typeMenuItem.type 에서 사용된다.

Example:

let menu = [{
     label: "menu3 입니다",
     type: "check",
     checked: true,
 }]

NullsOrder

정렬할때 undefined, null ''을 오름차순, 내림차순에 관계없이 상단 또는 하단에 위치시킨다.

SortingOptions.nullsOrder에서 설정한다.

Members:

MemberValueDescription
DEFAULTdefault오름차순일때는 상단, 내림차순일때는 하단에 위치시킨다.
FIRSTfirst상단에 위치시킨다.
LASTlast하단에 위치시킨다.

PolygonShape

ShapeCellRenderer 에서 사용 가능한 도형 목록

Members:

MemberValueDescription
DIAMONDdiamond다이아몬드
DOWN_ARROWdownarrow아래를 향하는 화살표
EQUALequal등호 기호
INVERTED_TRIANLGEitriangle역삼각형
LEFT_ARROWleftarrow왼쪽을 향하는 화살표
MINUSminus빼기 기호
PLUSplus더하기 기호
RECTANGLErectangle직사각형
RIGHT_ARROWrightarrow오른쪽을 향하는 화살표
STARstar별 모양
TRIANLGEtriangle삼각형
UP_ARROWuparrow위를 향하는 화살표

Example:

column.renderer = {
    "type": "shape",
    "shape": "triangle" // PolygonShape
}

RefreshMode

그리드를 다시 그릴 때 필요한 상수

Members:

MemberValueDescription
ALLall모든 컬럼들을 다시 그리기
RECYCLErecycle세로스크롤시에는 보이는 컬럼만 다시 그리고 가로스크롤시에는 전체 컬럼을 다시 그린다.
VISIBLE_ONLYvisibleOnly보이는 컬럼들만 다시 그리기

Remarks:

DisplayOptions.refreshMode 에서 사용한다.

Example:

grid.displayOptions.refreshMode = 'visibleOnly';

RestoreMode

복원 모드 종류

Members:

MemberValueDescription
AUTOauto원래 값으로 다시 수정만 하면 RowState 도 다시 원상태로 돌아온다.
EXPLICITexplicit명시적으로 restoreUpdatedRows()를 사용했을 경우에만 RowState 와 값이 변경된다.
NONEnone복원 모드를 설정하지 않는다.

RowGroupAdornments

행 그룹 상태일 때 헤더나 푸터의 표시 방법

Members:

MemberValueDescription
BOTHboth행 그룹 상태일 때 헤더와 푸터 둘 다 표시, expandedAdornments 상태에서만 적용
FOOTERfooter행 그룹 상태일 때 푸터 표시
HEADERheader행 그룹 상태일 때 헤더 표시
NONEnone표시 안 함, expandedAdornments 상태에서만 적용 가능하다.
SUMMARYsummary행 그룹 상태일 때 summary의 내용을 헤더 위치에 표시

Remarks:

RowGroup.collapsedAdornments, RowGroup.expandedAdornments 에서 사용된다.

Example:

grid.setRowGroup({expandedAdornments: "none"});

RowMaskType

선택 된 행의 표시 형태 (행의 마스크 종류)

Members:

MemberValueDescription
CELLcell하나의 셀
DATAdata컬럼 영역
FILLfill인디케이터, 상태바, 체크바, 컬럼을 포함한 영역 + 빈 영역
NONEnone없음
ROWrow인디케이터, 상태바, 체크바, 컬럼을 포함한 영역

Remarks:

rowBlockType, rowHoverType, rowFocusType 등에서 사용된다.

Example:

grid.displayOptions.rowBlockCallback = f;
grid.displayOptions.rowBlockType = 'row';

RowState

행의 상태

Members:

MemberValueDescription
CREATE_AND_DELETEDcreateAndDeleted생성 후 삭제됨
CREATEDcreated생성됨
DELETEDdeleted삭제됨
NONEnone아무것도 아님
UPDATEDupdated업데이트됨

ScrollOnEditing

편집 중 일때 스크롤 시 처리 상태

Members:

MemberValueDescription
CANCELcancel편집 취소
COMMITcommit커밋
DEFAULTdefault편집기 유지

Remarks:

EditOptions.scrollOnEditing 에서 설정 가능하다.

Example:

grid.editOptions.scrollOnEditing = 'cancel';

SelectionDisplay

셀 선택 디스플레이

Members:

MemberValueDescription
CELLcell
CELL_AND_BORDERcellAndBorder셀과 경계
MASKmask마스크

Remarks:

개발 중...

SelectionMode

셀 선택 영역에 대한 모드

Members:

MemberValueDescription
EXTENDEDextended여러개의 영역선택을 사용
NONEnone영역선택을 사용하지 않음.
SINGLEsingle하나의 영역선택만 사용

Remarks:

DisplayOptions.selectionMode 에서 사용된다.

SelectionStyle

셀 선택 영역에 대한 스타일

Members:

MemberValueDescription
BLOCKblock블록 형태로 선택
COLUMNScolumns컬럼 단위로 선택
GROUPgroup블록과 동일한 형식으로 선택하지만 셀단위가 아닌 그룹단위로 선택을 한다.
NONEnone선택 불가
ROWSrows행 단위로 선택
SINGLEsingle하나의 셀만 선택
SINGLE_COLUMNsingleColumn하나의 컬럼만 선택
SINGLE_ROWsingleRow하나의 행만 선택

Remarks:

SINGLE, SINGLE_ROW, SINGLE_COLUMN 을 single selection style 이라한다.

DisplayOptions.selectionStyle 에서 사용된다.

RowIndicator.selectable 기능이 정상적으로 작동하려면 DisplayOptions.selectionStyle 이 single selection style 이 아니어야 한다.

DisplayOptions.selectionStyle 이 single selection style 이 아니어야 ctrl key 를 누른 후 컬럼헤더 드래그 시 컬럼 단위 선택 영역이 지정된다.

SortCase

대소문자 구분 유형

Members:

MemberValueDescription
INSENSITIVEinsensitive구분하지 않음
SENSITIVEsensitive구분

Remarks:

SortingOptions.textCase, orderBy() 등에서 사용된다.

Example:

gridView.orderBy(['fruit'], ['descending'], ['insensitive']);

SortDirection

정렬 방식

Members:

MemberValueDescription
ASCENDINGascending오름차순
DESCENDINGdescending내림차순
NONEnone없음

Remarks:

getDistinctValues(), orderBy() 등에서 사용된다.

Example:

gridView.orderBy(['fruit'], ['descending'], ['insensitive']);

SortMode

데이터 수정 이후 정렬 동작 모드

Members:

MemberValueDescription
AUTOauto자동
EXPLICITexplicit데이터 수정이후 명시적으로 정렬을 수행해야 정렬

Remarks:

GridBase.sortMode 에서 사용된다.

Example:

gridView.sortMode = "explicit";

SortStyle

그리드 컬럼 헤더 클릭 시 정렬 유형

Members:

MemberValueDescription
EXCLUSIVEexclusive마지막으로 클릭 한 컬럼으로 정렬
INCLUSIVEinclusive처음으로 클릭 한 컬럼을 우선으로 정렬
NONEnone정렬 안 함
REVERSEreverse마지막으로 클릭한 컬럼을 우선으로 정렬

Remarks:

SortingOptions.style 에서 사용된다.

Example:

grid.sortingOptions.style = 'inclusive'

StateMark

상태바의 상태 표시 방법

Members:

MemberValueDescription
IMAGEimage이미지
NONEnone없음
TEXTtext텍스트

SummaryMode

그리드의 각 컬럼의 합계를 계산하는 방식

Members:

MemberValueDescription
AGGREGATEaggregate합, 평균, 최대값, 최소값 등 산술적인 합계를 자동으로 계산
NONEnone계산하지 않음
STATISTICALstatistical분산, 표준 편차 등 통계적 합계를 자동으로 계산

Remarks:

GridBase.summaryMode 등에서 설정하여 사용할 수 있다.

Example:

let sum = gridView.getSummary('unitPrice', 'sum');

SummaryType

필드의 합계값을 계산하기 위한 유형

Members:

MemberValueDescription
AVGavg평균
COUNTcount개수
DATAAVGdataavgDATACOUNT 로 나눈 평균
DATACOUNTdatacount값이 지정되어 잇는 데이터 개수 (null 이 아닌)
MAXmax최대값
MINmin최소값
STDEVstdev표본집단 표준편차
STDEVPstdevp모집단 표준편차
SUMsum
VARvar표본집단 분산
VARPvarp모집단 분산

Remarks:

GridBase.getSummary() 에서 사용된다.

Example:

let sum = gridView.getSummary('unitPrice', 'sum');

SyncGridHeight

조회된 data가 모두 보일수 있도록 그리드의 높이를 변경한다.

Members:

MemberValueDescription
ALWAYSalways항상 data 영역에 그리드 높이를 맞춘다.
NONEnone지정된 높이를 유지한다.
OVERover그리드의 영역보다 커지는 경우 그리드의 높이를 변경한다.

Remarks:

data가 없는 경우 초기 높이로 표시된다. 많은 data가 출력되는 경우 느려지기 때문에 일부 data만 가져온후 더보기 버튼등을 이용해서 data를 추가해야 한다.

TextInputCase

대소문자 형태

Members:

MemberValueDescription
DEFAULTdefault편집기에서 이 값으로 설정되면 컬럼에 설정된 값을 따름
LOWERlower소문자로 표시
NORMALnormal입력되는 대로 표시
UPPERupper대문자로 표시

Remarks:

ValueColumn.textInputCase, CellEditor.textCase 등에서 사용된다.

Example:

column.editor = { type: "line", maxLength: 1, textCase: 'lower'}

TimeSelectType

Members:

MemberValueDescription
HOURhour시간선택 화면을 표시한다.
MINUTEminute시/분 선택화면을 표시한다.
NONEnone시간선택화면을 표시하지 않는다.
SECONDsecond시/분/초 선택화면을 표시한다.

TreeExpanderIconStyle

Tree Expander에 표시되는 기본 아이콘의 스타일을 지정한다.

Members:

MemberValueDescription
SQUAREsquare사각형 형태의 Tree Expander 아이콘을 표시한다.
TRIANGLEtriangle삼각형 형태의 Tree Expander 아이콘을 표시한다.

ValidationLevel

데이터 검증 결과 수준

Members:

MemberValueDescription
ERRORerror오류
IGNOREignore없음
INFOinfo정보
WARNINGwarning경고

Remarks:

GridBase.setValidations() 등에서 쓰인다.

Example:

gridView.setValidations({
     message: 'Too expensive!',
     criteria: "values['UnitPrice'] > 100",
     level: 'error'
})

ValidationMode

검증 방법

Members:

MemberValueDescription
ALWAYSalways항상(삽입, 수정) 커밋될 때마다
INSERTinsert추가한 행이 커밋될 때
UPDATEupdate수정한 행이 커밋될 때

Remarks:

GridBase.setValidations() 등에서 쓰인다.

Example:

gridView.setValidations({
     message: 'Too expensive!',
     criteria: "values['UnitPrice'] > 100",
     mode: 'always'
})

ValueType

데이터 필드의 데이터 자료형

Members:

MemberValueDescription
BOOLEANbooleanBoolean
CHARchar문자
DATEdate시간 부분이 제거된 날짜
DATETIMEdatetime날짜
INTint정수형
NUMBERnumber숫자
OBJECTobject오브젝트
TEXTtext텍스트
UINTuint0 이상의 정수형 값
UNUMunum0 이상의 숫자

Remarks:

DataField.dataType 에서 사용될 때는 TEXT, NUMBER, DATETIME, BOOLEAN, OBJECT 으로 사용되며, 적용한 자료형을 제한하고 싶을 때에는 DataField.subType 에 다음과 같이 부여 가능하다.

dataTypeTEXT: CHAR

dataTypeNUMBER: INT, UNUM, UINT

dataTypeDATETIME: DATE

Example:

let fields = [{
...
     dataType: "text",
     subType: "char",
...
}]
 
ds.setFields(fields);

VerticalMoveStep

direction이 vertical인 ColumnGruop의 하위 컬럼에서 위화살표 또는 아래화살표를 입력했을때 focus이동 방식.

Members:

MemberValueDescription
CELLcell셀단위로 이동한다.
ROWrowrow단위로 이동한다.

Type Aliases Desc

BooleanOutputCallback

boolean 필드 변환시 수행 될 콜백함수 형식

Remarks:

DataOutputOptions.booleanCallback 에서 사용된다.

[매개변수 목록]

ds - DataProvider 컨트롤

row - 아이템의 인덱스

field - 필드명

value - 값

[반환값] - 출력할 값

Example:

const f = function(ds, row, field, value) {
     return !!value;
}

CategoryCallback

자동 필터링 시 사용자 지정 분류를 위한 콜백 형식

Remarks:

[매개변수 목록]

column - 자동 필터링이 걸려있는 컬럼

values - 전체 값들

[반환값] - 카데고리 분류 모델의 배열 형태

Example:

const f = function(column, values) {
     const emptyText = '빈 아이템'
     if (!values) {
         return null;
     }
     const valids = values.filter(function (el) { return el != undefined && el != null; });
     const min = Math.min.apply(null, valids);
     const vlen = values.length;
     let unit;
     if (vlen > 15) {
         const groupCount = Math.min(Math.round(vlen / 5)), 10);
         unit = Math.round(vlen / groupCount);
     } else {
         unit = 1;
     }
     let categories = [];
     let gvals = [];
     let gindex = 0;
     let gmin = min;
     let isEmpty = false;
     for (let i = 0; i < vlen; i++) {
         const v = values[i];
         if (v === undefined || v === null) {
             isEmpty = true;
             continue;
         }
         if (i == gindex + unit || i === vlen - 1) {
             categories.push({ text: gmin + ' ~ ' + v, values: gvals });
             gvals = [v];
             gindex = i;
             gmin = v;
         } else {
             gvals.push(v);
         }
     }
     if (isEmpty) {
         categories.push({ text: emptyText, empty: true });
     }
     return categories;
}

CellSpanCallback

사용자 지정의 cell spanning을 설정하기 위한 콜백

Remarks:

CellLayoutColumnItem 에서 사용된다.

[매개변수 목록] grid - GridBase 컨트롤

layout - 레이아웃 아이템

itemIndex - 행의 인덱스

Example:

const f = function (grid, layout, itemIndex) {
    var value = grid.getValue(itemIndex, layout.column.dataIndex);
    if (value) {
        return value[0] === "B" ? 3 : value[0] === "F" ? 2 : 1;
    }
    return 1;
};

CellStyleCallback

동적 셀 스타일 변경을 위한 콜백

Remarks:

ColumnStyleObject 를 반환 할 때는 GridBase.setCellStyleCallback(), ValueColumn.styleCallback 에서 사용한다.

ColumnSummaryStyleObject 를 반환 할 때는 GridFooter.cellStyleCallback, HeaderSummary.cellStyleCallback 에서 사용한다.

문자열 반환 시 스타일 명으로 지정

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

[반환값] - 동적 스타일을 부여하기 위한 오브젝트 혹은 스타일 클래스 명

Example:

const f1 = function(grid, model) {
     if (model.value > 5) return "rg-data-cell bold-cell";
     if (model.value < 0 && model.value > -10) {
         return {
             styleName: 'custom-negative-cell',
             renderer: {
                 type: 'bar',
                 absoluteValue: true
             }
         }
     }
}
 
const f2 = function(grid, model) {
     if (model.value > 10) {
         return {
             styleName: 'custom-summary-cell'
         }
     }
}
 
// 전체 데이터 셀에 적용
gridView.setCellStyleCallback(f1);
 
// 컬럼 별 적용
let column = gridView.columnByName('Price');
column.styleCallback = f1;
 
// 푸터 적용
gridView.footer.cellStyleCallback = f2;
 
// header summary 적용
gridView.headerSummary.cellStyleCallback = f2;

CheckableCallback

CheckBar 에서 체크 가능 여부를 결정하는 콜백

Remarks:

[매개변수 목록]

dataSource - DataProvider 컨트롤

item - 체크의 대상이 되는 아이템 (행 아이템, 헤더 아이템 등)

[반환값] - 체크 가능 여부

Example:

const f = function(dataSource, item) {
     if (item.value) {
         return item.value !== 'doNotCheck';
     }
     else {
         return false;
     }
}

ColumnObjectCallback

dataTypeobject인 data를 화면에 표시할때 사용되는 콜백

Remarks:

[매개변수 목록]

fieldName - field명

dataRow - dataRow

value - value

[반환값] - 화면에 표시할 내용

Example:

const callback = function(fieldName, dataRow, value) {
  return JSON.stringify(value);
}
 
gridView.columnByName("objectColumn").objectCallback = callback;

ColumnSummaryCallback

컬럼의 footer 또는 summary에 표시되는 값을 사용자가 지정할때 사용되는 콜백의 형식

Remarks:

[매개변수 목록]

grid - gridView

column - footer 또는 summary의 컬럼

footerIndex - column의 footer가 여러개인경우 순번

summary - footer 또는 summary객체 groupFooter인 경우 GroupItem객체

value - expression이 지정된 경우 값

[반환값] - 화면에 표시될 내용.

CompareCallback

검색할 때 사용자 임의로 조건을 지정하기 위한 값 비교 콜백 형식

Remarks:

[매개변수 목록]

v1 - 검색되어지는 값

v2 - 검색한 값

sensitive - 대소문자 구분 여부

partialMatch - 포함되는 글자도 검색하는지 여부

[반환값] - 해당 값 매칭 여부

Example:

const f = function(v1, v2, sensitive, partialMatch) {
     if (v1 === v2) {
          return true;
     }
     let s1 = String(v1);
     let s2 = v2 == null ? undefined : String(v2);
     if (!s1 && !s2) {
          return true;
     }
     if (!s1 || !s2) {
          return false;
     }
     if (!caseSensitive) {
          s1 = s1.toLowerCase();
          s2 = s2.toLowerCase();
     }
     if (partialMatch) {
     	    return s2.indexOf(s1) >= 0;
     } else {
     	    return s1 == s2;
     }
}

CompareFunction

비교함수 형식

Remarks:

Array.prototype.sort() 에서 쓰는 CompareFunction 과 같은 형식이다.

DataProviderBase.setDataComparer() 에서 사용한다.

ConfigObject

CopyTextCallback

그리드를 복사할때 클립보드에 저장되는 text를 반환하는 콜백 형식

Remarks:

CopyOptions.copyTextCallback에서 사용된다.

[매개변수 목록]

grid - GridBase 컨트롤

itemIndex - 복사되는 행의 itemIndex

column - DataColumn 객체

[반환값] - 클립보드에 복사될 text undefined 를 return 하면 value 또는 copyOptions의 다른 설정값에 따른 text가 복사된다.

Example:

const f = function(grid, itemIndex, column, value) {
     if (value != null && column.name === "number1") {
         return value + "";
     }
}
grid.copyOptions.copyTextCallback = f;

CreateFooterCallback

특정 그룹 푸터의 표시 여부를 지정하기 위한 콜백 형식

Remarks:

RowGroup.createFooterCallback 에서 사용되는 형식이다.

[매개변수 목록]

owner - GridBase 컨트롤

group - 그룹 아이템

footerIndex - 푸터 콜렉션 내에서의 인덱스

Example:

createFooterCallback: function(owner, group, footerIndex) {
		if (group.level >= 5) { return false }
		if (group.level === 4) {
			let relation2 = owner.getDataSource().getValue(group.firstItem.dataRow, "relation2");
			return relation2 === "친족"
		}
		if (group.level === 3) {
			let relation1 = owner.getDataSource().getValue(group.firstItem.dataRow, "relation1");
			return relation1 === "동일인측"
		}
		return true;
	}

DataDragCallback

그리드 간 drag and drop 을 시작할 때 발생하는 콜백 형식

Remarks:

false 반환 시 drag and drop 이 취소된다. DataDropOptions.dragCallback 에서 쓰인다.

[매개변수 목록]

source - 드래그한 아이템이 있던 GridBase 컨트롤

sourceItems - 드래그한 그리드의 아이템들의 인덱스

target - 드랍할 GridBase 컨트롤 또는 HTMLElement

targetItem - 드랍할 그리드에서의 아이템 인덱스

targetColumn - 드랍할 그리드에서의 targetColumn

[반환값] - drag and drop 가능 여부

Example:

gridView.dataDropOptions.dragCallback = function (source, sourceItems, target, targetItem) {
    return targetItem % 2 == 0;
}

DataDragLabelCallback

drag 중인 item 의 label 텍스트를 결정하기 위한 콜백의 형식

Remarks:

[매개변수 목록]

source - 드래그한 아이템이 있던 GridBase 컨트롤

sourceItems - 드래그한 그리드의 아이템들의 인덱스

target - 드랍할 GridBase 컨트롤 또는 HTMLElement

targetItem - 드랍할 그리드에서의 아이템 인덱스

targetColumn - 드랍할 그리드에서의 targetColumn

[반환값] - 레이블의 텍스트

Example:

gridView.dataDropOptions.labelCallback = function (source, sourceItems, target, targetItem) {
    return sourceItems.length + " 개의 행";
}

DataDropCallback

그리드 간 drag and drop 했을 때 발생하는 콜백 형식

Remarks:

DataDropOptions.callback 에서 사용 된다.

[매개변수 목록]

source - 드래그한 아이템이 있던 GridBase 컨트롤

sourceItems - 드래그한 그리드의 아이템들의 인덱스

target - 드랍할 GridBase 컨트롤 또는 HTMLElement

targetItem - 드랍할 그리드에서의 아이템 인덱스

targetColumn - 드랍할 그리드에서의 targetColumn

Example:

gridView.dataDropOptions.callback = function (source, sourceItems, target, targetItem) {
    alert('row from ' + sourceItems + ' to ' + targetItem);
    for (var i = 0; i < sourceItems.length; i++) {
        var r = source.getDataRow(sourceItems[0]);
        var ds = source.getDataSource();
        var row = ds.getJsonRow(r)
        if (targetItem >= target.getItemCount()) {
            ds.addRow(row);
        } else {
            r = target.getDataRow(targetItem);
            target.getDataSource().insertRow(r, row);
        }
    }
}

DataFieldInput

데이터 필드에 관한 입력 형식

Remarks:

setFields 등에서 사용한다.

Example:

// string
ds.setFields('fieldnName');
 
// model
let fields = ds.getFields();
ds.setFields(fields);
 
// config
ds.setFields({
     fieldName: 'OrderID',
     dataType: 'text',
});

DataFilters

필터 조건의 배열 및 컬렉션 오브젝트

Remarks:

LocalDataProvider.setFilters() 에서 사용한다.

Example:

// string
dataProvider.setFilters([
  "value['field1']='가수'",
  "value['field2']='여자'"
], "and");
 
// object
dataProvider.setFilters([
  {criteria: "value['field1']='가수'"},
  {criteria: "value['field2']='여자'"}
], "and");

DataValues

행 오브젝트 및 행 배열

Remarks:

LocalDataProvider, LocalTreeDataProvider 의 method 에서 다양하게 쓰인다.

RowObject 또는 RowValues 이다.

Example:

// array
let row = ['value1', 'value2', 'value3']
 
// object
let row = {field1: 'value1', field2: 'value2', field3: 'value3'}

DatetimeOutputCallback

datetime 필드 변환시 수행 될 콜백함수 형식

Remarks:

DataOutputOptions.datetimeCallback 에서 사용된다.

[매개변수 목록]

ds - DataProvider 컨트롤

row - 아이템의 인덱스

field - 필드명

value - 값

[반환값] - 출력할 값

Example:

const f = function(ds, row, field, value) {
     if (value === 'today) {
         return new Date();
     }
     return new Date(value);
}

DropFieldMapCallback

그리드 간 drag and drop 으로 이동 / 복사를 할 때 적용되는 규칙을 반환하는 콜백 형식

Remarks:

[매개변수 목록]

source - 드래그한 아이템이 있던 GridBase 컨트롤

sourceItems - 드래그한 그리드의 아이템들의 인덱스

target - 드랍할 GridBase 컨트롤

targetItem - 드랍할 그리드에서의 아이템 인덱스

targetColumn - 드랍할 그리드에서의 targetColumn

[반환값] - FieldMap 오브젝트

Example:

gridView.dataDropOptions.fieldMapCallback = function (source, sourceItems, target, targetItem) {
    if (targetItem % 2 == 0) {
        return {
            Country: "Country",
            CompanyName: "ShipAddress",
            EmployeeID: "ShipPostalCode"
        }
    }
}

EditMask

텍스트나 날짜 필드에 적용할 수 있는 편집기의 표시 형식

Remarks:

ValueColumn.editor 를 적용할 때, 에디터의 mask 속성에서 사용된다.

숫자 필드는 NumberCellEditor.editFormat 을 사용한다.

마크스에 적용된 형식은 편집기에만 표시된다.

dropDown, multiLine, multiCheck, number Editor 에서는 동작하지 않는다.

Example:

// string
column.editor = {
     type: 'line',
     mask: '9999-99-99'
}
 
// object
column.editor = {
     type: 'line',
     mask: {
         editMask: '9999-99-99',
         placeHolder: 'input...'
     }
}

ExpanderVisibleCallback

그룹 expander의 visible 여부를 return 하는 callback

Remarks:

RowGroup.expanderVisibleCallback 에서 사용되는 형식이다.

[매개변수 목록] grid - GridBase 컨트롤

group - 그룹 아이템

Example:

gridView.rowGroup.expanderVisibleCallback = function(grid, group) {
     // 2 level인 group만 expander를 표시한다.
     return group.level === 2;
	}

ExportSimpleCallback

done 을 설정하기 위한 내보내기를 완료할 때 수행될 콜백의 형식

Remarks:

[매개변수 목록]

data - target이 stream인 경우 전달된다.

ExportValueCallback

그리드 내보내기 설정에서 필드 별로 출력 시 수행될 콜백을 지정하기 위한 형식

Remarks:

[매개변수 목록]

index - 인덱스

name - 컬럼명 또는 필드명

value - 입력된 값

grid - export를 진행중인 grid 또는 dataProvider

[반환값] - 내보내기 될 값

FieldValueCallback

calculated 필드일 경우 수식을 지정하여 계산 될 콜백의 형식

Remarks:

DataField.valueCallback 또는 DataFieldObject.valueCallback 에서 사용된다.

최종적으로 출력하고자 하는 값을 반환하면 된다.

[매개변수 목록]

ds - DataProvider 컨트롤

rowId - 행 고유번호

fieldName - 필드명

fields - 필드명 배열

values - 값 배열

[반환값] - 출력할 값

Example:

function (ds, rowID, fieldName, fields, values) {
    let quantity = values[fields.indexOf("Quantity")];
    let unitprice = values[fields.indexOf("UnitPrice")];
    if (isNaN(quantity) || isNaN(unitprice))
        return undefined;
    else
        return quantity >= 1000 ? Math.round(quantity * unitprice * 0.95) : quantity * unitprice;
}

FilterCallback

필터 콜백

Remarks:

ColumnFilter.callback 에서 사용된다.

[매개변수 목록]

ds - Provider 컨트롤

dataRow - 행의 인덱스

level - 수준

field - 필드명

filter - ColumnFilter 객체

value - 값

[반환값] - 필터링 결정 여부

Example:

const f = function(ds, dataRow, level, field, filter, value) {
     let res = isMatched(value, filter.criteria);
     return res;
}

FilterPanelCallback

FilterPanel의 입력창에 text를 입력후 enter를 입력하거나 filterDelay이후 호출되는 callback이다.

Remarks:

true를 return하면 그리드의 filtering을 수행하지 않는다. operator와 text를 return하면 입력된 operator와 text로 filtering을 한다.

[매개변수 목록]

grid - GridBase 컨트롤

column - 입력창의 컬럼 객체

operator - InlineFilterOperator

text - 입력된 text

Example:

grid.filterPanel.filterPanleCallback = function(grid, column, operator, text) {
 if (column.fieldName === "notRun") {
     return true; // notRun인 필드는 filtering을 하지 않는다.
 } else if (column.fieldName = "userFilter") {
     return {
         operator: InlineFilterOperator.STARTS_WITH,
         text: text.substr(0,2) // 입력된 문자중 앞 2글자만 대상으로 필터링.
     }
 }
}

GetAriaLabelCallback

CellRenderer.ariaLabelCallback 에서 사용되는 콜백 형식

Remarks:

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

[반환값] - 스크린 리더가 읽을 문자열.

Example:

const f = function(grid, model) {
     var s = model.value;
     var date = grid.getValue(model.item.index, "date")
     s += (date.getTime() > Date.now() - 60*60*24*7*1000) ? " 신규" : "";
     return s;
}
 
column.renderer = {
     type: 'text',
     ariaLabelCallback: f
}

GetCellTitleCallback

이미지 렌더링 할 때 이미지의 alt 텍스트 설정 또는 링크 셀 렌더링 할 때 HTML Anchor Element의 title 텍스트를 설정을 위한 콜백 형식

Remarks:

ImageCellRenderer.titleCallback 또는 LinkCellRenderer.titleCallback 에서 사용된다.

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

[반환값] - alt 텍스트 또는 title 텍스트

Example:

const f = function(grid, model) {
     return 'catimage'
}

GetCheckedCallback

렌더링 시 체크 값을 결정하는 콜백 형식

Remarks:

CheckCellRenderer.getCheckedCallback 에서 사용한다.

[매개변수 목록]

grid - GridBase 컨트롤

itemIndex - 아이템의 순서

column - 컬럼 객체

value - 값

[반환값] - 체크 여부

Example:

const f = function(grid, itemIndex, column, value) {
     if (typeof value === "number") {
         return value % 2 === 1;
     }
     else if (typeof value ==="boolean") {
         return value;
     }
     else {
         return Boolean(v);
     }
}

GetClassCallback

linkRenderer의 a tag에 class를 추가

Remarks:

LinkCellRenderer의 a tag에 class를 추가하는 경우 사용한다.

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

[반환값] - string

Example:

const callback = function (grid, model) {
  let cls = "";
  model.value.indexOf("새글") > 0 && (cls += " new");
  model.value.indexOf("비밀글") > 0 && (cls += " lock");
  // link에 새글/비밀글 icon을 background형태로 추가하는 경우
}
 

GetImageCallback

이미지를 렌더링을 위해 이미지의 경로를 지정하는 콜백 형식

Remarks:

ImageCellRenderer.imageCallback 또는 IconCellRenderer.iconCallback 에서 사용된다.

[프로퍼티 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

[반환값] - 이미지 경로

Example:

const f = function(grid, model) {
     const base = '/images/';
     if (jpgSet.indexOf(model.value)){
         return base + model.value + '.jpg';
     }
     else base + 'default.jpg';
}

GetLinkUrlCallback

LinkCellRenderer.urlCallback 에서 사용되는 콜백 형식

Remarks:

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

[반환값] - Url 주소

Example:

...
     "renderer" : {
         "type": "link",
         "urlCallback": function (grid, cell) {
             return "http://realgrid.com";
         },
     }
...

GetShapeCallback

도형 렌더러에서 도형의 종류를 지정하기 위한 ShapeCellRenderer.shapeCallback 에서 사용하는 콜백 형식

Remarks:

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

[반환값] - 도형 종류, PolygonShape 또는 'ellipse' 이다.

Example:

const f = function(grid, model) {
     if (model.value) {
         return 'ellipse';
     }
     else {
         return 'minus';
     }
}

GetTemplateCallback

TemplateCellRenderer.callback 에 사용되는 콜백 형식

Remarks:

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

width - 셀의 너비

height - 셀의 높이

[반환값] - string type 의 template 형식

Example:

const f = function (grid, model, width, height) {
    return "<img src='images/realgrid-logo.png' height='" + height / 2 + "'></img>" + "<div>" + model.value + "</div>";
}
 
column.renderer = {
    type: "html",
    callback: f
}

GroupFooterCellSpanCallback

사용자 지정의 groupFooter spanning을 설정하기 위한 콜백

Remarks:

CellLayoutColumnItem 에서 사용된다.

[매개변수 목록] grid - GridBase 컨트롤

layout - 레이아웃 아이템

itemIndex - 행의 인덱스

footerIndex - groupFooter의 index

GroupFooterStyleCallback

그리드 그룹 푸터 행의 스타일을 지정하기 위한 콜백

Remarks:

RowGroupFooter.styleCallback에서 사용되는 형식이다.

[매개변수 목록] grid - GridBase 컨트롤

itemIndex - 푸터의 itemIndex

footerIndex - 그룹에 푸터가 여러개 있는 경우 footer의 index

Example:

var f = function(grid, itemIndex, footerIndex) {
    var dataRow = grid.getGroupModel(itemIndex, true).firstDataItem.dataRow;
    var value = grid.getDataSource().getValue(dataRow, "area2name");
    return value && value.indexOf("군") >= 0 ? `style-1-${footerIndex}` : undefined;
};
 
gridView.rowGroup.setFooters([{styleCallback: f},{styleCallback: f}]);

GroupFooterUserSpanCallback

사용자 지정 groupFooterUser span을 설정하기 위한 콜백

Remarks:

CellLayoutColumnItem 에서 사용된다.

[매개변수 목록] grid - GridBase 컨트롤

layout - 레이아웃 아이템

model - GroupModel

itemIndex - 행의 인덱스

footerIndex - groupFooter의 index

HeaderCallback

행 그룹 Header에 표시되는 Text를 return 하는 Callback

Remarks:

RowGroup.headerCallback 에서 사용되는 형식이다. RowGroup.headerStatement가 있는 경우 무시된다.

[매개변수 목록] grid - GridBase 컨트롤

group - 그룹 아이템

Example:

gridView.rowGroup.headerStatement = undefined;
gridView.rowGroup.headerCallback = function(grid, group) {
     var ds = grid.getDataSource()
     if (group.level === 1) {
         return ds.getOrgFieldName(group.groupField) + " - " + group.firstDataItem.getData(group.groupField) + " - " + group.descendantCount + " rows"
     } else if (group.level === 2) {
         var sum = group.getSum("number");
         return isNaN(sum) ? "합계 없음" : ("합계 => "+ sum.toString());
     } else {
         return "GroupLevel => "+group.level.toString()
     }
	}

Holidays

공휴일 지정을 위한 설정 모델

Remarks:

GridBase.setEditorOptions() 을 이용하여 지정하거나 grid.editorOptions.holidays 에 직접 지정할 때 사용된다.

DateCellEditor 에서 사용되기도 한다.

Example:

holidays: [
     {
         type : "date",
         dates : ["2020-01-24","2020-01-25","2020-01-26","2020-01-27"],
         styleName: "seollal",
         tooltips : ["설날1","설날2","설날3","설날4"]
     },
  ...
]

LayoutInfo

GridBase.saveColumnLayout() 에서 반환되는 레이아웃의 정보 모델

Example:

// array of LayoutInfo
[
     {column: "OrderID", visible: true, width: 80},
     {column: "CustomerID", visible: true, width: 90},
     {
         name: "companyGroup"
         items: [
             {
                 name: "countryGroup"
                 items: [
                     {column: "Country", visible: true, width: 100},
                     {column: "Phone", visible: true, width: 100}
                 ]
                 visible: true,
                 direction: "horizontal",
                 width: 250,
                 header: {visible: true, text: "Country Group"}
             },
             {column: "CompanyName", visible: true, width: 100}
         ]
         visible: true,
         direction: "vertical",
         width: 250,
         header: {visible: true, text: "Company Group"}
     },
     {column: "EmployeeID", visible: true, width: 90}
]

LayoutItem

원하는 형태의 컬럼을 만들 수 있는 레이아웃 아이템 모델의 타입

Remarks:

GridBase.setColumnLayout() 에서 사용된다.

[개념 설명]

span 은 html table의 colspan (opens in a new tab) 과 비슷한 개념이다.

span 개수와 컬럼 개수로 영역을 분할하며, width와 뒤의 수들을 더한 만큼 영역을 한다.

layout 단위로 span 한다. 즉, 다음 layout이 그룹이면 그 그룹 전체를 span 한다.

그룹을 벗어나서 span 할 수 없다.

그룹은 span할 수 없다.

왼쪽에서 오른쪽으로, 위에서 아래로 진행한다.

상위 layout부터 먼저 span 한다(top-down).

그룹이 다음 layout들을 span 한 경우 새로 추가된 셀들을 하위 layout들에 배분한다.

(배분 방식: 하위 layout의 cell 개수 비율에 따라 마지막 layout부터 배분한다.)

행 병합 상태일 경우 span 하려는 다음 layout들과 행 어긋남이 없어야 한다.

fixed, rightFixed 경계를 넘어갈 수 없다.

Example:

[
       {
           name: "companyGroup",
           items: [
               {
                   column: "Country",
                   cellSpan: 3
               },
               20,20,
               {
                   column: "CompanyName",
                   cellSpan: 3
               },
               20,20,
           ],
           header: true
       },
       ...
   ];

ListCallback

DropDownCellEditor의 목록을 만들때 사용하는 콜백 조건에 따라 변경되는 item을 가져올때 사용한다.

Remarks:

DataColumn.lookupDisplay가 적용되기 위해서는 DataColumn.labelField를 이용해야 한다.

[매개 변수 목록]

grid - gridView

index - CellIndex

ListResult

ListCallback 또는 GridBase.onSearchCellButtonClick 의 return type

Remarks:

IE11에서 ListCallback을 이용해서 목록을 만드는 경우 Promise polyfill을 추가해야 한다.

ListTemplateCallback

DropDownCellEditor 또는 SearchCellEditor에서 list에 표시되는 item을 사용자가 작성할때 사용하는 콜백

Remarks:

[매개변수 목록]

grid - gridView

index - CellIndex

dom - div element

value - value

label - label

item - DropDownCellEditor.listCallback 또는 GridBase.fillEditSearchItems()에서 입력한 정보

Example:

const columns = [
 {   fieldName:"text",
     name: "text",
     editor: {
         type: "list",
         templateCallback: (grid, index, dom, value, label, item) {
             dom.innerHTML = '<img src="images/flags/'+item.flag+'.png" style="width:20px" class="dropdown-image"></img>'+
                             '<span> value = '+value+'></span>'+
                             '<span style="color:red"> label = '+label+'</span>'+
                             '<span style="background:lawngreen"> Country: '+item.name
         }
     }
 }
]

LookupData

LookupSource 를 채우기 위한 모델 정보

Remarks:

fillLookupData() 시 매개변수로 사용된다.

Example:

// rows 속성을 이용할 경우
gridView.fillLookupData("empLookup", {
     rows: [
         ["TOMSP", "5", "TOMSP_5X"],
         ["TOMSP", "6", "TOMSP_6X"]
     ]});
 
// key-value 속성을 이용할 경우
gridView.fillLookupData("empLookup", {
     keys: [
         ["TOMSP", "5", "TOMSP_5X"],
         ["TOMSP", "6", "TOMSP_6X"]
     ],
     values: [
         ["TOMSP_5X"],
         ["TOMSP_6X"]
     ]});

MenuItemClick

메뉴 아이템을 클릭 시 호출되는 콜백

Remarks:

GridBase.onMenuItemClickedGridBase.onContextMenuItemClicked, PopupMenuItem.callback 에서 사용된다.

[매개변수 목록]

grid - GridBase 컨트롤

menuItem - MenuItem 객체

clickData - 클릭된 아이템의 정보

Example:

grid.addPopupMenu("menu1", [
        {
             label: "alpha",
             callback: function(grid, menuItem, clickData) {
                 console.log("aa")
                 console.log(menuItem);
                 console.log(clickData);
             }
        },
        {label: "beta"},
        {label: "gamma"}
]);

NumberOutputCallback

number 필드 변환시 수행 될 콜백함수 형식

Remarks:

DataOutputOptions.numberCallback 에서 사용된다.

[매개변수 목록]

ds - DataProvider 컨트롤

row - 아이템의 인덱스

field - 필드명

value - 값

[반환값] - 출력할 값

Example:

const f = function(ds, row, field, value) {
     let v = Number(value);
     return v === NaN ? 42: v;
}

ObjectToValuesCallback

json형태의 data를 dataProvider에 입력할때 각 행별로 호출되는 콜백

Remarks:

서버에서 전달된 data의 형태가 fields로 설정한 fieldName과 다르거나 value값을 임의로 변경할때 사용한다.

Example:

dataProvider.valuesCallback = function (ds, obj) {
    let row = [];
    if (obj) {
        for (let i = 0, cnt = this.fieldCount; i < cnt; i++) {
            let fld = this.getOrgFieldName(i);
            let fName = Object.keys(obj).find(function(key) {return key.toLowerCase() === fld.toLowerCase()})
            if (obj.hasOwnProperty(fName)) {
                row[i] = obj[fName];
            }
        }
    }
    return row;
}

OuterSortCallback

사용자가 sort를 수행할때 지정하는 콜백형식

Remarks:

IE11에서 사용하기 위해서는 Promise polyfill을 추가해야 한다.

ProgressCallback

그리드 내보내기 설정에서 showProgress가 true일때 수행될 콜백을 지정하기 위한 형식

Remarks:

[매개변수 목록] grid - 현재 export를 진행중인 grid, zip파일을 생성중인 경우 null이 전달된다.

work - Grid가 엑셀을 생성하면서 호출되는 경우 process, zip파일을 생성하면서 호출되는 경우 zip이 전달된다. jsZIP이 generateAsync지원하는 경우 호출된다.

max - maxPosition

position - 현재 진행되고 있는 position

RealizeHeaderCallback

ColumnHeader.templateCallback 또는 CellLayoutGroupHeader.templateCallback에 사용되는 콜백 형식

Remarks:

컬럼 헤더의 template에 입력한 field중 values에 지정되지 않은 값을 가져올때 사용한다.

[매개변수 목록]

grid - GridBase 컨트롤

header - 컬럼의 header 또는 그룹 Layout의 header

field - 필드명

[반환값] - string

Example:

const f = function (grid, model, field) {
     if (field == "field1") {
         return "1234";
     } else if (field === "field2") {
         return "ABCD";
     } else {
         return "field Fail";
     }
}
 
column.header.template =
               "<img src='images/realgrid-logo.png' height='20'/>"+
               "<span style='color: red;font-weight: bold;'>${field1}</span>"+
               "<span style='color: blue'>${field2}</span>";
column.header.templateCallback = f;

RealizeSummaryCallback

ColumnSummary.templateCallback에서 사용되는 콜백 형식

Remarks:

ColumnFooter, HeaderSummary, GroupFooter의 template에 입력한 field중 values에 지정되지 않은 값을 가져올때 사용한다.

[매개변수 목록]

grid - GridBase 컨트롤

column - footer의 column

summaryIndex - footer의 순번

summary - footer객체 또는 groupFooter인 경우 GroupItem

field - 필드명

[반환값] - string

Example:

const f = function (grid, column, summaryIndex, summary, field) {
     if (field == "field1") {
         return "1234";
     } else if (field === "field2") {
         return "ABCD";
     } else {
         return "field Fail";
     }
}
 
column.footer.template =
               "<img src='images/realgrid-logo.png' height='20'/>"+
               "<span style='color: red;font-weight: bold;'>${field1}</span>"+
               "<span style='color: blue'>${field2}</span>";
column.footer.templateCallback = f;

RealizeValueCallback

TemplateCellRenderer.valueCallback 에 사용되는 콜백 형식

Remarks:

[매개변수 목록]

grid - GridBase 컨트롤

model - 그리드의 셀

field - 필드명

[반환값] - string type 의 template 형식

Example:

const f = function (grid, model, field) {
     if (field == "xxx") {
         return "1234";
     }
}
 
column.renderer = {
     type: "html",
     template: "<img src='images/realgrid-logo.png' height='20'/>"+
               "<span>${value}-${value:unitprice}-</span>"+
               "<span style='color: red;font-weight: bold;'>${xxx}</span>"+
               "<span style='color: blue'>${value:Country}</span>",
     valueCallback: f

RowBarCellStyleCallback

RowBar영역의 셀 스타일을 지정하기 위한 콜백

Remarks:

CheckBar.cellStyleCallback에서 사용되는 형식이다.

[매개변수 목록] grid - GridBase 컨트롤

type - GridCellTypecheck, indicator, state 중 하나

index - 셀의 itemIndex

Example:

var f = function(grid, type, index) {
 if (grid.getValue(index, "field") === "TEST") {
   return 'style-test';
 }
}

RowBlockCallback

row block 마스크를 설정하기 위한 콜백

Remarks:

DisplayOptions.rowBlockCallback 에서 사용된다. DisplayOptions.rowBlockTypeRowMaskType.NONE 이면 반영되지 않는다.

[매개변수 목록]

grid - GridBase 컨트롤

itemIndex - 선택 된 행의 인덱스

[반환값] - Row Block Mask 를 적용시킬 행의 범위, start: 시작 행, end: 끝 행

Example:

const f = function(grid, itemIndex) {
    let billNo;
    let ds = grid.getDataSource();
    let fld = ds.getFieldIndex("text1");
    let dataRow = grid.getDataRow(itemIndex);
    if (dataRow >= 0) {
        billNo = ds.getValue(dataRow, fld);
    } else {
        billNo = null;
    }
 
    let top = Math.min(grid.getTopItem(), itemIndex);
    let full = top + grid.fullItemCount();
    let startNo = top + full;
    let endNo = -1;
    let check1 = false;
 
    for (let i = top; i <= full; i++) {
        dataRow = grid.getDataRow(i);
        if (dataRow < 0) {
            continue;
        }
 
        let cBillNo = ds.getValue(dataRow, fld);
 
        if (cBillNo === billNo) {
            startNo = Math.min(startNo, i), endNo = Math.max(endNo, i);
            check1 = true;
        } else {
            if (check1) {
                break;
            }
        }
    };
 
    if (startNo <= endNo && endNo > 0) {
        console.log(startNo)
        console.log(endNo);
        return { start: startNo, end: endNo };
    }
}

RowHeightCallback

행의 높이를 반환하는 콜백형식

Remarks:

number 또는 number[]형태로 행의 높이를 지정한다.

[매개변수 목록]

grid - GridBase 컨트롤

type - row의 type

itemIndex - row의 itemIndex

[반환값] - 행의 높이, 여러줄로 이루어진 행의 경우 배열로 반환하면 각각 지정된다.

RowObject

행 오브젝트

Remarks:

DataValues 의 형식 중 하나

RowStyleCallback

행 스타일 변경을 위한 콜백

Remarks:

스타일 클래스 명을 반환해야한다.

GridBase.setRowStyleCallback() 에서 쓰인다.

[매개변수 목록]

grid - GridBase 컨트롤

item - 행 아이템

fixed - 고정행 여부

[반환값] - 스타일 클래스 명 또는 RowStyleObject 객체

Example:

const f = function(grid, item, fixed) {
     if (fixed) {
         return 'custom-fixed-row';
     }
     else if (item.isDataRow) {
         var val =
         return 'custom-data-row';
     }
}
gridView.setRowStyleCallback(f)

RowValues

행 데이터

Remarks:

DataValues 의 형식 중 하나

ScrollMessageCallback

livescroll 을 미적용 할 때 스크롤 위치를 알려주는 화면에 표시되는 메시지를 반환하는 콜백 형식

Remarks:

DisplayOptions.scrollMessageCallback 에서 사용된다.

[매개변수 목록]

grid - GridBase 컨트롤

isVertical - 수직 스크롤 여부

itemIndex - 스크롤 위치에 있는 아이템의 인덱스

[반환값] - 화면에 표시되는 메시지의 텍스트

Example:

const f = function(grid, vertical, itemIndex) {
    let msg = grid.getValue(itemIndex, "area3name");
    return "<span style='color:blue;font-size:20px'>itemIndex = " + msg+"</span>";
}

SetCheckedCallback

편집 시 체크 결과 값을 결정하는 콜백 형식

Remarks:

CheckCellRenderer.setCheckedCallback 에서 사용한다.

[매개변수 목록]

grid - GridBase 컨트롤

itemIndex - 아이템의 순서

column - 컬럼 객체

oldValue - 편집 전 값

checked - 편집 전 체크 상태

[반환값] - 체크 결과 값

Example:

const f = function(grid, itemIndex, column, oldValue, checked) {
     if (itemIndex % 2 === 0) {
         return checked;
     }
     else if (itemIndex % 17 === 0) {
         return oldValue
     }
     else {
         return false;
     }
}

SummaryCellSpanCallback

사용자 지정의 headerSummary와 footer spanning을 설정하기 위한 콜백

Remarks:

CellLayoutColumnItem 에서 사용된다.

[매개변수 목록] grid - GridBase 컨트롤

layout - 레이아웃 아이템

footerIndex - footer의 인덱스

TreeIconCallback

트리 expander옆에 표시되는 아이콘을 지정하는 콜백

[매개변수 목록]

TreeView - 트리뷰 객체

itemIndex - 행의 인텍스

dataRow - 행의 dataRow

iconIndex - 원 iconIndex의 값

[반환값] - icon의 url 또는 TreeOptions.iconImages의 순번

UserCellsCallback

사용자가 출력 셀을 추가할때 사용되는 콜백 GridExportOptions.userCells이 있는 경우 수행되지 않는다.

Remarks:

[매개변수 목록] grid - 현재 export를 진행중인 grid

rowCount - sheet의 행수

colCount - sheet의 컬럼수

name - sheet의 name

[반환값] - UserExportCell의 배열

Example:

var callback = function(grid, rowCount, colCount, sheetName) {
 return [{row:3, col: colCount -3, mergeCol: 3, text:"열의 마지막에 표시", styles:{textAlign:"right"}}]
}
gridView.exportGrid({"type":"excel", "target":"local", "yOffset":4, userCellsCallback: callback});

ValueForGroupCallback

동일한 값이 아니지만 하나의 그룹으로 묶을때 기준이 되는 값을 개발자가 지정할때 사용한다. field의 dataType과 동일한 dataType으로 return 해야한다.

Remarks:

RowGroup.valueForGroupCallback에서 사용되는 형식이다. [매개변수 목록]

grid - GridBase 컨트롤

dataRow - dataRow

fieldName - fieldName

value - value

Example:

valueForGroupCallback = function(grid, dataRow, fieldName, value) {
		if (value && fieldName === 'date1') {// 특정 field에만 적용.
			// Date형식의 data를 년도와 월을 이용해서 그룹으로 묶는다.
			return new Date(value.getFullYear(), value.getMonth());
		};
     // 변경되지 않았다면 원래의 값을 reutrn해야 한다.
		return value;
}