RealGrid2 API
Interface
SortingOptions

SortingOptions

데이터 정렬에 대한 설정 모델

Signature:

export interface SortingOptions 

Remarks

style 이 "exclusive"일 때 shift 키와 함께 컬럼 헤더를 클릭하면 "inclusive"처럼 동작한다.

그리드 에서 옵션으로 설정할 때는 필요한 정보만 넣으면 된다.

Example

grid.setSortingOptions({enabled: false});

Properties

PropertyTypeDescription
commitBeforeSortingboolean정렬 전에 commit 할 건지의 여부
enabledboolean컬럼 헤더를 클릭으로 컬럼을 정렬 가능 여부
handleVisibilityHandleVisibility필터 핸들의 표시 방법
keepFocusedRowboolean정렬 시 현재 focus 된 행 유지 여부
nullsOrderNullsOrder정렬할때 null, undefined, ''을 처음 또는 마지막에 위치하도록 한다.
outerSortOuterSortCallback | boolean그리드는 실제 정렬을 하지않고 정렬된것처럼 동작한다.
pageSortingboolean현재페이지 기준으로 정렬할 것인지의 여부
showSortOrderboolean여러 컬럼을 정렬했을 때 정렬 순서 표시 여부
sortDataRowboolean정렬하려는 field의 값이 동일한 경우 dataRow 정렬 여부
styleSortStyle그리드에서 여러 컬럼에 대한 정렬 상태를 지정하는 방식
suppressScrollToBottomboolean그리드가 정렬된 상태에서는 onScrollToBottom 이벤트를 발생시키지 않는다.
textCaseSortCase대소문자 구분
toastToastOptionstoast 관련 설정

Properties Desc

commitBeforeSorting

정렬 전에 commit 할 건지의 여부

Type - boolean


enabled

컬럼 헤더를 클릭으로 컬럼을 정렬 가능 여부

Type - boolean

Remarks:

orderBy() 는 이 속성 값과 상관없이 실행된다.


handleVisibility

필터 핸들의 표시 방법

Type - HandleVisibility


keepFocusedRow

정렬 시 현재 focus 된 행 유지 여부

Type - boolean


nullsOrder

정렬할때 null, undefined, ''을 처음 또는 마지막에 위치하도록 한다.

Type - NullsOrder


outerSort

그리드는 실제 정렬을 하지않고 정렬된것처럼 동작한다.

Type - OuterSortCallback | boolean

Remarks:

DataProvider에 있는 data를 이용한 정렬이 아닌 서버에서 정렬된 data를 다시 load하는 경우 사용한다.

true로 지정하면 사용자가 grid.orderBy를 이용해서 정렬상태를 지정해야한다.

function으로 지정하면 onSortingChanged이벤트 직전에 function을 호출해준다.

Example:

grid.sortingOptions.outerSort = true;
grid.onCellClicked = (grid, clickData) {
  // 하나의 field를 대상으로 정렬하는 예제
  if (clickData.cellType === "header") {
    const sortInfo = grid.getSortedFields();
    const fieldName = clickData.fieldName;
    const isSort = sortInfo && sortInfo.find(v => v.orgFieldName === fieldName);
    // let sortOrder = isSort ? (isSort.direction === 'ascending' ? 'descending' : null) : 'ascending';
    let sortOrder = (!isSort || isSort.direction === 'descending') ? 'ascending' : 'descending';
 
    if (sortOrder) {
      grid.orderBy([fieldName], [sortOrder])  // 그리드는 header에 정렬표시만 한다.
    } else {
      grid.orderBy([]);
    }
    getData(fieldName, sortOrder) // getData내에서 dataProvider.setRows 수행.
  }
}

pageSorting

현재페이지 기준으로 정렬할 것인지의 여부

Type - boolean


showSortOrder

여러 컬럼을 정렬했을 때 정렬 순서 표시 여부

Type - boolean


sortDataRow

정렬하려는 field의 값이 동일한 경우 dataRow 정렬 여부

Type - boolean


style

그리드에서 여러 컬럼에 대한 정렬 상태를 지정하는 방식

Type - SortStyle


suppressScrollToBottom

그리드가 정렬된 상태에서는 onScrollToBottom 이벤트를 발생시키지 않는다.

Type - boolean


textCase

대소문자 구분

Type - SortCase


toast

toast 관련 설정

Type - ToastOptions

Remarks:

ToastOptions 모델을 따른다.