AUISoft
AUIGrid 3.0.13 Documentation
Methods

AUIGrid 에서 호출 가능한 메소드 리스트입니다.

아래는 설정 예제 입니다.
 AUIGrid.setFixedRowCount("create() 메소드 호출 시 사용한 pid", columnCount);

모든 그리드 메소드는 create() 메소드 호출 시 사용한 pid 를 기본 파라메터로 삽입해야 합니다.

파라메터 첫번째 인자는 pid 입니다.(샘플 상 myGridID 변수)

문서에서 pid 파라메터는 기본으로 설명에서 생략되었습니다.

즉, setFixedRowCount 메소드에 대한 설명으로 파라메터는 columnCount 1개로 설명되지만 실제적으로 2개를 삽입해야 합니다.

첫번째 인자는 pid 이고, 설명된 columnCount 가 2번째 인자가 됩니다.

문서상에 정리된 파라메터를 실제 적용시 주의해 주십시오.

NameDescription
addCheckedRowsByIds
Type : Method   Version: 2.11.0

엑스트라 행 체크박스가 설정된 경우행 고유 값(rowIdField 값)을 이용해 특정 행에 체크를 설정합니다.

이 메소드는 기존에 체크된 항목에 누적해서 체크됩니다.

파라메터 설명

  • rowIds : (Array) 행 고유 값(rowIdField 값)들을 요소로 갖는 배열

참고 : 기존 체크 항목을 제거하고 새로 설정하는 값으로만 체크하고자 한다면 setCheckedRowsByIds 메소드를 사용하십시오.

관련 데모 보기

addCheckedRowsByValue
Type : Method   Version: 2.11.0

엑스트라 행 체크박스가 설정된 경우 특정 행의 dataField 의 값과 일치하는 행에 체크를 표시합니다.

이 메소드는 기존에 체크된 항목에 누적해서 체크됩니다.

파라메터 설명

  • dataField : (String) 행 아이템에서 체크하고자 하는 필드명
  • values : (Array or String) 행 아이템에서 체크하고자 하는 필드의 값(value), 복수의 값을 체크하고자 한다면 배열로 설정(예: ["Anna", "Steve"])

예를 들어 이름(name) 이 "Anna" 라는 사람을 기존에 누적해서 체크하고자 한다면 다음과 같습니다.

AUIGrid.addCheckedRowsByValue(myGridID, "name", "Anna");

참고 : 기존 체크 항목을 제거하고 새로 설정하는 값으로만 체크하고자 한다면 setCheckedRowsByValue 메소드를 사용하십시오.

관련 데모 보기

addColumn
Type : Method   Version: 3.0

그리드 열(column) 을 추가, 삽입합니다.

추가 하는 열(column) 은 반드시 dataField 를 지정해야 하며, 해당 dataField 는 기존과 중복되지 않는 고유 값이여야 합니다.

그리드의 속성 editable 과 무관하게 이 메소드를 통해 열(column)을 추가할 수 있습니다.

파라메터 설명

  • cItem (Object or Array) : 삽입하고자 하는 열 객체(columnm Object), 복수의 열을 삽입하고자 하는 경우 Object 를 배열로 묶으십시오.
  • columnIndex (Number or String) : 삽입될 열의 인덱스, columnIndex 에 다음 문자를 설정한 경우.

    "first" : 맨처음, "last" : 맨끝, "selectionLeft" : 선택 열 왼쪽에, "selectionRight" : 선택 열 오른쪽에 추가 열이 삽입됩니다.

  var cItem = { dataField : "myNumField1", dataType : "numeric", formatString : "#,##0" };
  예1 : AUIGrid.addColumn(myGridID, cItem, 5); // columnIndex 5 에 1열 추가
  예2 : AUIGrid.addColumn(myGridID, cItem, "last"); // 맨끝에 1열 추가
  예3 : AUIGrid.addColumn(myGridID, cItem, "selectionRight"); // 선택 열 오른쪽에 1열 추가
addRow
Type : Method   Version: 2.7.0

그리드 행(row) 아이템을 추가, 삽입합니다.

그리드의 속성 editable 과 무관하게 이 메소드를 통해 아이템을 추가할 수 있습니다.

파라메터 설명

  • items (Object or Array) : 삽입하고자 하는 행 아이템, 복수의 행을 삽입하고자 하는 경우 Object 를 배열로 묶으십시오.
  • rowIndex (Number or String) : 삽입될 행의 인덱스, rowIndex 에 다음 문자를 설정한 경우.

    "first" : 첫 행, "last" : 최하단, "selectionUp" : 선택행 위, "selectionDown" : 선택행 아래에 추가행이 삽입됩니다.

  var item = { "name" : "새 이름", "country" : "새 나라", "price" : 0 };
  예1 : AUIGrid.addRow(myGridID, item, 5); // rowIndex 5 에 1행 추가
  예2 : AUIGrid.addRow(myGridID, item, "last"); // 최하단에 1행 추가
  예3 : AUIGrid.addRow(myGridID, item, "selectionDown"); // 선택한 행 아래에 1행 추가
  주의 : 복수의 행을 추가하기 위해 반복문 안에 addRow 메소드를 사용하지 마십시오. 
  배열로 묶어 한번의 addRow 메소드로 처리하십시오.
  var items = [ {...}, {...}, ... ]; //복수의 Object 
  예4 : AUIGrid.addRow(myGridID, items, "last"); // 배열로 묶어 한번의 다수의 행 추가.

참고 : 일반 그리드의 행 추가입니다. 트리 그리드(계층형 그리드) 의 행 추가는 addTreeRow() 메소드를 참고하십시오.

Also See : addTreeRow | 관련 데모 보기

addTreeColumn
Type : Method   Version: 3.0

그리드에서 특정 열(column)의 자식으로 열을 추가, 삽입합니다.

추가 하는 열(column) 은 반드시 dataField 를 지정해야 하며, 해당 dataField 는 기존과 중복되지 않는 고유 값이여야 합니다.

그리드의 속성 editable 과 무관하게 이 메소드를 통해 열(column)을 추가할 수 있습니다.

파라메터 설명

  • cItem (Object or Array) : 삽입하고자 하는 열 객체(columnm Object), 복수의 열을 삽입하고자 하는 경우 Object 를 배열로 묶으십시오.
  • parentDataField (String) : 부모 dataField 명, 해당 dataField 의 자식으로 칼럼이 추가됩니다.
  • columnIndex (Number or String) : 삽입될 열의 인덱스, columnIndex 에 다음 문자를 설정한 경우. "first" : 맨처음, "last" : 맨끝에 추가 열이 삽입됩니다.
  var cItem = { dataField : "myNumField1", dataType : "numeric", formatString : "#,##0" };
  // "myGroupField" 를 dataField 로 갖는 칼럼을 찾아 해당 칼럼의 자식 인덱스 1 에 1열 추가
  예1 : AUIGrid.addTreeColumn(myGridID, cItem, "myGroupField", 1); 
  
  // "myGroupField" 를 dataField 로 갖는 칼럼을 찾아 해당 칼럼의 맨끝에 1열 추가
  예2 : AUIGrid.addTreeColumn(myGridID, cItem, "myGroupField, "last");
addTreeRow
Type : Method   Version: 2.7.0

트리 그리드 행(row) 아이템을 추가, 삽입합니다.

그리드의 속성 editable 과 무관하게 이 메소드를 통해 아이템을 추가할 수 있습니다.

파라메터 설명

  • items (Object or Array) : 삽입하고자 하는 행 아이템, 복수의 행을 삽입하고자 하는 경우 Object 를 배열로 묶으십시오.
  • parentRowId (String) : 추가될 행의 부모 행 고유 값(rowIdField 값).
  • rowPosition (String) : 삽입될 행의 위치 값, 유효값은 다음과 같습니다.

    "first" : 첫 행, "last" : 최하단, "selectionUp" : 선택행 위, "selectionDown" : 선택행 아래에 추가행이 삽입됩니다.

관련 데모 보기

addTreeRowByIndex
Type : Method   Version: 3.0.10

트리 그리드 행(row) 아이템을 특정 행 위치(rowIndex)에 추가, 삽입합니다.

지정된 행 위치에 맞게 부모-자식 관계가 자동 설정됩니다. 만약 부모-자식 관계를 명확히 하고자 하는 경우 addTreeRow 메소드를 사용하십시오.

파라메터 설명

  • items (Object or Array) : 삽입하고자 하는 행 아이템, 복수의 행을 삽입하고자 하는 경우 Object 를 배열로 묶으십시오.
  • rowIndex (Number) : 추가될 행이 위치할 행 인덱스(rowIndex)
addUncheckedRowsByIds
Type : Method   Version: 2.11.0

엑스트라 행 체크박스가 설정된 경우 행 고유 값(rowIdField 값)을 이용해 특정 행에 체크 해제를 설정합니다.

부분적으로 엑스트라 행 체크박스를 해제하고자 할 때 유용합니다.

파라메터 설명

  • rowIds : (Array) 행 고유 값(rowIdField 값)들을 요소로 갖는 배열

관련 데모 보기

addUncheckedRowsByValue
Type : Method   Version: 2.11.0

엑스트라 행 체크박스가 설정된 경우 특정 행의 dataField 의 값과 일치하는 행에 체크 해제를 설정합니다.

부분적으로 엑스트라 행 체크박스를 해제하고자 할 때 유용합니다.

파라메터 설명

  • dataField : (String) 행 아이템에서 체크 해제 하고자 하는 필드명
  • values : (Array or String) 행 아이템에서 체크 해제 하고자 하는 필드의 값(value), 복수의 값을 체크하고자 한다면 배열로 설정(예: ["Anna", "Steve"])

관련 데모 보기

appendData
Type : Method   Version: 2.7.0

기존 그리드 데이터의 하단에 추가로 데이터를 붙입니다.

파라메터 설명

  • additionalData (Array) : 추가시키고자 하는 데이터

관련 데모 보기

bind
Type : Method   Version: 2.7.0

그리드 이벤트를 핸들링하기 위해 이벤트를 바인딩하는 메소드입니다.

파라메터 설명

  • type : (String or Array) 바인딩하고자 하는 이벤트 유형
  • function : (Function) 이벤트 핸들러 함수

예를 들면 cellClick 이벤트를 핸들링하고 싶다면 다음과 같습니다.

 AUIGrid.bind(myGridID, "cellClick", function( event ) {
       alert("rowIndex : " + event.rowIndex + ", "columnIndex : " + event.columnIndex + " clicked");
 });
 
 // 복수의 이벤트를 한번에 핸들링 하기 (이벤트 유형을 배열로 설정)
 AUIGrid.bind(myGridID, ["cellClick", "headerClick", "footerClick"], function( event ) {
       if(event.type == "cellClick") alert("You clicked cell : " + event.value);
       else if(event.type == "headerClick") alert("You clicked header : " + event.headerText);
 });

관련 데모 보기

changeColumnLayout
Type : Method   Version: 3.0

그리드의 칼럼 레이아웃(columnLayout) 을 변경합니다.

최초에 출력된 그리드를 다른 칼럼 구조를 갖는 칼럼 레이아웃으로 변경합니다.

파라메터 설명

  • columnLayout : (Array-Object) 변경하고자 하는 새로운 칼럼 레이아웃
changeFooterLayout
Type : Method   Version: 3.0

그리드의 푸터 레이아웃(footerLayout) 을 변경합니다.

최초에 출력된 그리드의 푸터를 다른 푸터로 변경합니다.

파라메터 설명

  • footerLayout : (Array-Object) 변경하고자 하는 새로운 푸터 레이아웃
clearFilter
Type : Method   Version: 2.7.0

필터링이 설정되어 있다면 해당 칼럼의 필터링을 해제합니다.

enableFilter 속성이 true 설정되어야 가능합니다.

파라메터 설명

  • dataField (String) : 칼럼이 출력하고 있는 데이터의 필드명
clearFilterAll
Type : Method   Version: 2.7.0

모든 필터링을 해제합니다.

clearGridData
Type : Method   Version: 2.7.0

그리드 데이터를 모두 초기화하여 빈 그리드로 만듭니다.

clearSelection
Type : Method   Version: 2.7.0

선택되어진 모든 아이템들을 초기화합니다.

clearSortingAll
Type : Method   Version: 2.7.0

정렬(Sorting)이 설정되어 있다면 모든 정렬을 초기화 합니다.

clearUndoRedoStack
Type : Method   Version: 2.7.0

실행 취소(Undo), 다시 실행(Redo) 커맨드 스택을 초기화 합니다.

Also See : undo, redo, redoable | 관련 데모 보기

closeFilterLayer
Type : Method   Version: 2.9.3

그리드 필터를 설정한 경우, 필터 레이어(필터 메뉴)가 오픈되어 있을 때 닫도록 지시합니다.

    // 필터 레이어(필터 메뉴)가 열린 경우 닫습니다.
    AUIGrid.closeFilterLayer(myGridID);

Also See : openFilterLayer, isOpenFilterLayer | 관련 데모 보기

collapseAll
Type : Method   Version: 2.7.0

계층 구조 데이터 표현(트리 데이터)인 경우 모든 노드들을 닫고 최상위 Branch 만 표시합니다.

관련 데모 보기

create
Type : Method   Version: 2.7.0

그리드를 최초로 생성하는 메소드입니다.

파라메터 설명

  • pid : (String) 그리드가 생성될 Div 의 id
  • columnLayout : (Object) 그리드 생성하고자 하는 칼럼 레이아웃
  • gridProps : (Object) 그리드 생성 시 변경할 그리드 속성(key-value) 객체

Return : (String) 그리드가 생성될 Div의 id 를 반환합니다.(즉, 파라메터로 넣은 pid 반환)

Also See : destroy | 관련 데모 보기

destroy
Type : Method   Version: 2.7.0

작성된 그리드를 완전히 제거합니다.

동적으로 그리드를 생성, 제거해야 할 경우 반드시 이 메소드를 사용하여 제거하십시오.

Also See : create | 관련 데모 보기

expandAll
Type : Method   Version: 2.7.0

계층 구조 데이터 표현인 경우 모든 노드들을 열어 전체 펼치기를 실행합니다.

관련 데모 보기

expandItemByRowId
Type : Method   Version: 2.7.0

계층형 그리드(트리 그리드)인 경우 행 고유 값(rowIdField 값)에 맞는 아이템이 브랜치(branch)일 때 열기/닫기를 실행합니다.

파라메터 설명

  • rowIds (Array 또는 String) : 행 고유 값(rowIdField 값) (복수인 경우 Array 로 지정)
  • open (Boolean) : 열기 할지 닫기 할지 여부(true 인 경우 열기 실행)
  • recursive (Boolean) : 해당 아이템의 자손까지 모두 열지 여부
exportToCsv
Type : Method   Version: 3.0.13

그리드에 출력된 현재 데이터를 다운로드 가능한 CSV 형태로 내보내기 합니다.

파라메터 설명

  • exportProps (Object) : 내보내기 할 때 파일명 등을 지정할 수 있는 파라메터입니다.

■ exportProps 파라메터 설명 ■

exportProps 파라메터는 Object 로 그 요소는 다음과 같습니다.

  • afterRequestCallback (Function) : 내보내기 후 호출될 콜백함수를 지정합니다.
  • alwaysQuotes (Boolean) : 쌍따옴표를 모든 값에 붙일지 여부를 지정합니다. 값에 컴마가 있는지 확인하여 붙이는 경우(이 속성 false 설정한 경우) 퍼포먼스가 낮을 수 있습니다.
  • beforeRequestCallback (Function) : 내보내기 전 호출될 콜백함수를 지정합니다.
  • fileName (String) : 내보내기 할 때 파일명을 지정하면 해당 파일명을 서버 사이드에서 파라메터로 받을 수 있습니다.
  • localControl(Boolean) : 다운로딩 처리가 아닌 데이터를 Blob 으로 반환할지 여부를 지정합니다.(기본값 : false, IE <10 에서 사용 불가)
  • localControlFunc(Function) : localControl 를 true 설정한 경우 그리드가 CSV 서식 작성 완료 후 Blob 으로 반환하는 함수입니다.
  • localAsText (Boolean) : localControl 를 true 설정한 경우 localControlFunc 의 파라메터를 Blob 대신 String 으로 대체할지 여부를 지정합니다.(기본값 : false)
  • postToServer (Boolean) : exportURL 속성에 지정한 URL (즉, 서버)로 작성된 데이터를 보낼지를 지정합니다.(기본값 : false, 단, IE < 10 은 항상 true)
  • progressBar (Boolean) : 내보내기 진행 상황을 퍼센티지로 보여줄지 여부를 나타냅니다.(기본값 : false)

관련 데모 보기

exportToJson
Type : Method   Version: 3.0.13

그리드에 출력된 현재 데이터를 다운로드 가능한 JSON 형태로 내보내기 합니다.

파라메터 설명

  • exportProps (Object) : 내보내기 할 때 파일명 등을 지정할 수 있는 파라메터입니다.

■ exportProps 파라메터 설명 ■

exportProps 파라메터는 Object 로 그 요소는 다음과 같습니다.

  • afterRequestCallback (Function) : 내보내기 후 호출될 콜백함수를 지정합니다.
  • beforeRequestCallback (Function) : 내보내기 전 호출될 콜백함수를 지정합니다.
  • fileName (String) : 내보내기 할 때 파일명을 지정하면 해당 파일명을 서버 사이드에서 파라메터로 받을 수 있습니다.
  • keyValueMode (Boolean) : 내보내기 할 때 Row 데이터를 칼럼 인덱스에 맞는 배열로 할 지 key-value 로 짝을 갖는 Object 요소 배열로 할지 여부를 나타냅니다.
  • localControl(Boolean) : 다운로딩 처리가 아닌 데이터를 Blob 으로 반환할지 여부를 지정합니다.(기본값 : false, IE <10 에서 사용 불가)
  • localControlFunc(Function) : localControl 를 true 설정한 경우 그리드가 JSON 서식 작성 완료 후 Blob 으로 반환하는 함수입니다.
  • localAsText (Boolean) : localControl 를 true 설정한 경우 localControlFunc 의 파라메터를 Blob 대신 String 으로 대체할지 여부를 지정합니다.(기본값 : false)
  • postToServer (Boolean) : exportURL 속성에 지정한 URL (즉, 서버)로 작성된 데이터를 보낼지를 지정합니다.(기본값 : false, 단, IE < 10 은 항상 true)

관련 데모 보기

exportToObject
Type : Method   Version: 2.7.0

그리드에 출력된 현재 데이터를 자바스크립트 Array-Object 로 내보내기 합니다.

파라메터 설명

  • keyValueMode (Boolean) : 내보내기 할 때 Row 데이터를 칼럼 인덱스에 맞는 배열로 할 지 key-value 로 짝을 갖는 Object 요소 배열로 할지 여부를 나타냅니다.

keyValueMode 를 true 로 지정한 경우 한 행의 구조는 다음과 같습니다.

 [ {"name" : "Anna", "country" : "USA" .... } ] 

keyValueMode 를 false 로 지정한 경우 한 행의 구조는 다음과 같습니다.

 [ "Anna", "USA", .... ] 

Return : (Array) 그리드의 Array-Object 데이터

관련 데모 보기

exportToPdf
Type : Method   Version: 3.0.12

그리드에 출력된 현재 데이터를 다운로드 가능한 PDF 로 내보내기 합니다.

PDF 로 내보내기 시 셀 병합 관련 속성은 무시되며 동일한 행 높이만 내보내기 됩니다. wordWrap 의 가변적인 행 높이로 내보내기 불가능합니다.

또한 그리드에 설정된 스타일 중 글자 색상, 배경색, 이탤릭체, 볼드체, 언더라인 만 고려되어 내보내기 됩니다.

최소한의 PDF 내보내기 기능만을 제공합니다.

HTML5 를 완전히 지원하는 브라우저에서 사용 가능합니다.(IE 인 경우 10 이상)

파라메터 설명

  • exportProps (Object) : PDF로 내보내기 할 때 파일명, 상단, 하단 추가 텍스트를 지정할 수 있는 파라메터입니다.

■ exportProps 파라메터 작성 설명 ■

exportProps 파라메터는 Object 로 그 요소는 다음과 같습니다.

fontPath 는 반드시 지정해야 PDF 저장이 가능합니다.

  • afterRequestCallback (Function) : 내보내기 후 호출될 콜백함수를 지정합니다.
  • beforeRequestCallback (Function) : 내보내기 전 호출될 콜백함수를 지정합니다.
  • fontPath (String) : PDF 파일 작성 시 사용할 글꼴(Font) URL 경로입니다.(필수)
  • compress (Boolean) : PDF 파일 작성 시 압축을 할 지 여부를 지정합니다.(기본값: false)
  • fileName (String) : PDF로 내보내기 할 때 파일명을 지정하면 해당 파일명을 서버 사이드에서 파라메터로 받을 수 있습니다.
  • isRowStyleFront(Boolean) : 행에 적용된 스타일이 열에 적용된 스타일 보다 상위에 적용될지 여부를 지정합니다.(기본값 : true)
  • localControl(Boolean) : 다운로딩 처리가 아닌 데이터를 Blob 으로 반환할지 여부를 지정합니다.(기본값 : false, IE <10 에서 사용 불가)
  • localControlFunc(Function) : localControl 를 true 설정한 경우 그리드가 PDF 서식 작성 완료 후 Blob 으로 반환하는 함수입니다.
  • postToServer (Boolean) : exportURL 속성에 지정한 URL (즉, 서버)로 작성된 데이터를 보낼지를 지정합니다.(기본값 : false)
  • headers (Array) : 그리드 상단에 표시할 추가 행들을 지정합니다. 제목이나 부제목과 같은 내용이 될 수 있습니다.
  • footers (Array) : 그리드 하단에 표시할 추가 행들을 지정합니다.

headers 와 footer 는 Array 이며 요소로는 Object 를 갖으며 개별 요소(1개의 Object)가 1행을 나타냅니다.

Object 는 "text", "height", "style" 의 필드를 갖으며 다음은 이에 대한 설명입니다.

  • text (String) : PDF에 표시할 텍스트입니다.
  • height (Number) : PDF에서 행의 높이를 지정합니다.(px 단위, 실제 PDF는 pt 입니다. 그리드가 px 를 pt 로 변환하므로 px 단위로 지정하십시오.)
  • style (Object) : 행의 스타일을 지정합니다. (유효값 : fontSize, textAlign, underline, background, color)

종합하여 exportToPdf 메소드 사용 예는 다음과 같습니다.

  // PDF 내보내기 속성
  var exportProps = {
         // 저장하기 파일명
         fileName : "2020년_지역별_매출_내역(AUIGrid)",
         // 폰트 경로 지정 (필수)
         fontPath : "./pdfkit/jejugothic-regular.ttf",
         // 헤더 내용
         headers : [ {
              text : "", height:20 // 첫행 빈줄
         }, {
              text : "2020년 지역별 매출 내역", height:24, style : 
                   { fontSize:20, textAlign:"center", underline:true, background:"#DAD9FF"}
         }, {
              text : "작성자 : 에이유아이", style : { textAlign:"right"}
         }, {
              text : "작성일 : 2021. 01. 29", style : { textAlign:"right"}
         }, {
              text : "", height:5, style : { background:"#555555"} // 빈줄 색깔 경계 만듬
         }],
         // 푸터 내용
         footers : [ {
              text : "", height:5, style : { background:"#555555"} // 빈줄 색깔 경계 만듬
         }, {
              text : "참고 : 문의 사항은 전산팀으로 연락 하십시오.", style : { fontSize:15, color:"#2F9D27"}
         }, {
              text : "Copyright 2021 AUISoft", height:24, style : 
                   { textAlign:"right", color:"#ffffff", background:"#222222"}
         }]
  };
  // 내보내기 실행
  AUIGrid.exportToPdf(myGridID, exportProps);

관련 데모 보기

exportToTxt
Type : Method   Version: 3.0.13

그리드에 출력된 현재 데이터를 다운로드 가능한 TXT 형태로 내보내기 합니다.

파라메터 설명

  • exportProps (Object) : 내보내기 할 때 파일명 등을 지정할 수 있는 파라메터입니다.

■ exportProps 파라메터 설명 ■

exportProps 파라메터는 Object 로 그 요소는 다음과 같습니다.

  • afterRequestCallback (Function) : 내보내기 후 호출될 콜백함수를 지정합니다.
  • beforeRequestCallback (Function) : 내보내기 전 호출될 콜백함수를 지정합니다.
  • fileName (String) : 내보내기 할 때 파일명을 지정하면 해당 파일명을 서버 사이드에서 파라메터로 받을 수 있습니다.
  • localControl(Boolean) : 다운로딩 처리가 아닌 데이터를 Blob 으로 반환할지 여부를 지정합니다.(기본값 : false, IE <10 에서 사용 불가)
  • localControlFunc(Function) : localControl 를 true 설정한 경우 그리드가 TXT 서식 작성 완료 후 Blob 으로 반환하는 함수입니다.
  • localAsText (Boolean) : localControl 를 true 설정한 경우 localControlFunc 의 파라메터를 Blob 대신 String 으로 대체할지 여부를 지정합니다.(기본값 : false)
  • postToServer (Boolean) : exportURL 속성에 지정한 URL (즉, 서버)로 작성된 데이터를 보낼지를 지정합니다.(기본값 : false, 단, IE < 10 은 항상 true)
  • progressBar (Boolean) : 내보내기 진행 상황을 퍼센티지로 보여줄지 여부를 나타냅니다.(기본값 : false)

관련 데모 보기

exportToXlsx
Type : Method   Version: 3.0.14

그리드에 출력된 현재 데이터를 다운로드 가능한 엑셀(xlsx) 로 내보내기 합니다.

엑셀 보내내기 시 그리드의 전반적인 내용이 그대로 내보내기 됩니다.

그러나 그리드에 설정된 모든 스타일이 다 엑셀로 내보내기 되는 것이 아닙니다.

글자 색상(color), 배경색(background-color), 이탤릭체(font-style: italic), 볼드체(font-weight: bold), 언더라인(text-decoration: underline)만 고려되어 내보내기 됩니다.

파라메터 설명

  • exportProps (Object) : 엑셀로 내보내기 할 때 파일명, 상단, 하단 추가 텍스트를 지정할 수 있는 파라메터입니다.

■ exportProps 파라메터 작성 설명 ■

exportProps 파라메터는 Object 로 그 요소는 다음과 같습니다.

  • afterRequestCallback (Function) : 엑셀로 내보내기 후 호출될 콜백함수를 지정합니다.
  • beforeRequestCallback (Function) : 엑셀로 내보내기 전 호출될 콜백함수를 지정합니다.
  • baseFontSize (Number) : 엑셀의 기본 글꼴 크기를 명시적으로 지정합니다.
  • columnSizeOfDataField (Object) 엑셀 내보내기할 때 칼럼 사이즈의 크기를 지정합니다.
  • compress (Boolean) : 엑셀 파일 작성 시 압축을 할 지 여부를 지정합니다.(기본값 : false)
  • exceptColumnFields (Array) : 엑셀로 저장 할 때 포함 시키지 않을 칼럼들의 dataField 를 지정합니다.
  • exportWithStyle (Boolean) : 엑셀로 내보내기 할 때 스타일 정보(폰트 및 컬러 등)을 함께 내보내기 할지 여부를 나타냅니다. (단, IE8 의 경우 항상 false)
  • fileName (String) : 엑셀로 내보내기 할 때 파일명을 지정하면 해당 파일명을 서버 사이드에서 파라메터로 받을 수 있습니다.
  • fontFamily (String) : 엑셀로 저장 시 적용될 폰트명을 지정하십시오.(기본값: "맑은 고딕") 예를 들어 Arial 폰트로 적용하고자 한다면 "Arial" 로 설정하십시오.
  • isRowStyleFront(Boolean) : 행에 적용된 스타일이 열에 적용된 스타일 보다 상위에 적용될지 여부를 지정합니다.(기본값 : true)
  • localControl(Boolean) : 다운로딩 처리가 아닌 엑셀 데이터를 Blob 으로 반환할지 여부를 지정합니다.(기본값 : false, IE <10 에서 사용 불가)
  • localControlFunc(Function) : localControl 를 true 설정한 경우 그리드가 엑셀 서식 작성 완료 후 Blob 으로 반환하는 함수입니다.
  • postToServer (Boolean) : exportURL 속성에 지정한 URL (즉, 서버)로 작성된 xlsx 데이터를 보낼지를 지정합니다.(기본값 : false, 단, IE < 10 은 항상 true)
  • preserveSpace (Boolean) : 값의 앞 또는 뒤에 공백이 존재할 때 해당 공백을 유지할지 여부를 지정합니다.(기본값:false)
  • progressBar (Boolean) : 내보내기 진행 상황을 퍼센티지로 보여줄지 여부를 나타냅니다.(기본값 : false)
  • rowHeight (Number) : 엑셀에서의 행 높이를 명시적으로 지정합니다. wordWrap 인 경우 무시됩니다. 기본값은 그리드 속성 rowHeight 값을 따릅니다.
  • sheetName (String) : 엑셀로 내보내기 할 때 엑셀의 시트명을 지정합니다. (기본값 : Sheet 1)
  • showRowNumColumn (Boolean) : 엑셀로 내보내기 할 때 행번호 칼럼을 보여줄지 여부를 나타냅니다. 기본값은 그리드 속성 showRowNumColumn 값을 따릅니다.
  • fixedColumnCount (Number) : 엑셀로 내보내기 할 때 엑셀 상의 틀고정 열(column)을 임의로 지정합니다.
  • fixedRowCount (Number) : 엑셀로 내보내기 할 때 엑셀 상의 틀고정 행(row)을 임의로 지정합니다.
  • headers (Array) : 그리드 상단에 표시할 추가 행들을 지정합니다. 제목이나 부제목과 같은 내용이 될 수 있습니다.
  • footers (Array) : 그리드 하단에 표시할 추가 행들을 지정합니다.
  • rectangles (Array) : 엑셀의 텍스트 상자를 지정합니다.

headers 와 footer 는 Array 이며 요소로는 Object 를 갖으며 개별 요소(1개의 Object)가 엑셀에서 1행을 나타냅니다.

Object 는 text, height, style 의 필드를 갖으며 다음은 이에 대한 설명입니다.

  • text (String) : 엑셀에 표시할 텍스트입니다.
  • height (Number) : 엑셀에서 행의 높이를 지정합니다.(px 단위, 실제 엑셀은 pt 입니다. 그리드가 px 를 pt 로 변환하므로 px 단위로 지정하십시오.)
  • style (Object) : 행의 스타일을 지정합니다.
    • fontSize (Number) : 폰트 사이즈
    • textAlign (String) : 텍스트 정렬 (유효값 : "left", "center", "right")
    • verticalAlign (String) : 텍스트의 수직 정렬 (유효값 : "top", "middle", "bottom")
    • color (String) : 폰트 색상 RGB
    • background (String) : 배경 색상 RGB
    • fontStyle (String) : 이탤릭 스타일 여부 (유효값: "normal", "italic")
    • fontWeight (String) : 볼드체 스타일 여부(유효값 : "normal", "bold)
    • underline (Boolean) : 언더라인 여부

rectangles 는 Object 로 그 요소는 text, dimension, style 의 필드를 갖습니다. 이에 대한 설명입니다.

  • text (String) : 텍스트 상자에 출력할 텍스트입니다.
  • dimension (Object) : 텍스트 상자 위치에 관한 정보입니다.
    • fromColIdx (Number) : 상자가 위치할 시작 columnIndex (즉, 가로의 시작 점)
    • toColIdx (Number) : 상자가 끝날 columnIndex(즉, 가로의 끝점)
    • fromRowIdx (Number) : 상자가 위치할 시작 rowIndex(즉, 세로의 시작 점)
    • toRowIdx (Number) : 상자가 끝날 rowIndex(즉, 세로의 끝점)
    • fromRowOff, toRowOff, fromColOff, toColOff (Number) : 각각 해당 인덱스에서 몇 px 만큼의 여백을 가질지 지정 (즉, offset 값)
  • style: 텍스트 상자의 스타일을 지정합니다.
    • fontSize (Number) : 폰트 사이즈
    • textAlign (String) : 텍스트 정렬 (유효값 : "left", "center", "right")
    • verticalAlign (String) : 텍스트의 수직 정렬 (유효값 : "top", "middle", "bottom")
    • color (String) : 폰트 색상 RGB
    • background (String) : 배경 색상 RGB
    • fontStyle (String) : 이탤릭 스타일 여부 (유효값: "normal", "italic")
    • fontWeight (String) : 볼드체 스타일 여부(유효값 : "normal", "bold")
    • underline (Boolean) : 언더라인 여부
    • borderColor (String) : 테두리 색상 RGB
    • borderThickness (Number) : 테두리 두께

종합하여 exportToXlsx 메소드 사용 예는 다음과 같습니다.

  // 엑셀 내보내기 속성
  var exportProps = {
         // 저장하기 파일명
         fileName : "2018년_지역별_매출_내역(AUIGrid)",
         // 저장 할 때 dataField 가 name, product 인 칼럼들 저장에서 제외시킴.
         exceptColumnFields : ["name", "product"],
         // price 칼럼의 넓이를 200 으로 지정하여 내보내기
         columnSizeOfDataField : { "price" : 200 },
         // 헤더 내용
         headers : [ {
              text : "", height:20 // 첫행 빈줄
         }, {
              text : "2018년 지역별 매출 내역", height:24, style : 
                   { fontSize:20, textAlign:"center", fontWeight:"bold", underline:true, background:"#DAD9FF"}
         }, {
              text : "작성자 : 에이유아이", style : { textAlign:"right"}
         }, {
              text : "작성일 : 2019. 03. 29", style : { textAlign:"right"}
         }, {
              text : "", height:5, style : { background:"#555555"} // 빈줄 색깔 경계 만듬
         }],
         // 푸터 내용
         footers : [ {
              text : "", height:5, style : { background:"#555555"} // 빈줄 색깔 경계 만듬
         }, {
              text : "참고 : 문의 사항은 전산팀으로 연락 하십시오.", style : { fontSize:15, color:"#2F9D27"}
         }, {
              text : "Copyright 2019 AUISoft", height:24, style : 
                   { textAlign:"right", fontWeight:"bold", color:"#ffffff", background:"#222222"}
         }]
  };
  // 내보내기 실행
  AUIGrid.exportToXlsx(myGridID, exportProps);

관련 데모 보기 | 관련 데모 보기

exportToXlsxMulti
Type : Method   Version: 3.0.6

다수의 그리드에 출력된 현재 데이터를 1개의 엑셀(xlsx) 파일에 각각의 엑셀 시트(Sheets)로 내보내기 합니다.

파라메터 설명

  • subGridIds (Array) : 시트(Sheets)에 각각 같이 내보내기 할 서브 그리드들의 pid 배열
  • exportProps (Array) : 각각 그리드들의 내보내기 속성 정의 배열

■ exportProps 파라메터 작성 설명 ■

exportProps 파라메터는 Object 를 요소로 갖는 Array 를 정의합니다. 개별 Object 는 다음의 속성을 갖습니다.

배열의 첫번째 요소는 1번 시트로 마스터 그리드에 해당되고, 두번째 요소부터 서브 그리드에 해당됩니다.

마스터 그리드의 exportProps 작성은 exportToXlsx 의 exportProps 를 참고하십시오.

다음은 서브 그리드들에서 작성 가능한 exportProps 에 대한 구체적인 속성입니다.

  • exceptColumnFields (Array) : 엑셀로 저장 할 때 포함 시키지 않을 칼럼들의 dataField 를 지정합니다.
  • exportWithStyle (Boolean) : 엑셀로 내보내기 할 때 스타일 정보(폰트 및 컬러 등)을 함께 내보내기 할지 여부를 나타냅니다. (단, IE8 의 경우 항상 false)
  • isRowStyleFront(Boolean) : 행에 적용된 스타일이 열에 적용된 스타일 보다 상위에 적용될지 여부를 지정합니다.(기본값 : true)
  • sheetName (String) : 엑셀로 내보내기 할 때 엑셀의 시트명을 지정합니다. (기본값 : Sheet 1)
  • fixedColumnCount (Number) : 엑셀로 내보내기 할 때 엑셀 상의 틀고정 열(column)을 임의로 지정합니다.
  • fixedRowCount (Number) : 엑셀로 내보내기 할 때 엑셀 상의 틀고정 행(row)을 임의로 지정합니다.
  • headers (Array) : 그리드 상단에 표시할 추가 행들을 지정합니다. 제목이나 부제목과 같은 내용이 될 수 있습니다.
  • footers (Array) : 그리드 하단에 표시할 추가 행들을 지정합니다.
  var exportProps = [{
      sheetName : "일반 데이터"
  }, {
      sheetName : "그룹핑 셀병합 Type 1"
  }, {
      sheetName : "그룹핑 셀병합 Type 2",
  }, {
      sheetName : "그룹핑 셀병합 Type 3"
  }];
  // 다수의 그리드를 1개의 엑셀로 내보내기 하기
  AUIGrid.exportToXlsxMulti(myGridID1, [myGridID2, myGridID3, myGridID4], exportProps);

관련 데모 보기

exportToXml
Type : Method   Version: 3.0.13

그리드에 출력된 현재 데이터를 다운로드 가능한 XML 형태로 내보내기 합니다.

파라메터 설명

  • exportProps (Object) : 내보내기 할 때 파일명 등을 지정할 수 있는 파라메터입니다.

■ exportProps 파라메터 설명 ■

exportProps 파라메터는 Object 로 그 요소는 다음과 같습니다.

  • afterRequestCallback (Function) : 내보내기 후 호출될 콜백함수를 지정합니다.
  • beforeRequestCallback (Function) : 내보내기 전 호출될 콜백함수를 지정합니다.
  • fileName (String) : 내보내기 할 때 파일명을 지정하면 해당 파일명을 서버 사이드에서 파라메터로 받을 수 있습니다.
  • localControl(Boolean) : 다운로딩 처리가 아닌 데이터를 Blob 으로 반환할지 여부를 지정합니다.(기본값 : false, IE <10 에서 사용 불가)
  • localControlFunc(Function) : localControl 를 true 설정한 경우 그리드가 XML 서식 작성 완료 후 Blob 으로 반환하는 함수입니다.
  • localAsText (Boolean) : localControl 를 true 설정한 경우 localControlFunc 의 파라메터를 Blob 대신 String 으로 대체할지 여부를 지정합니다.(기본값 : false)
  • postToServer (Boolean) : exportURL 속성에 지정한 URL (즉, 서버)로 작성된 데이터를 보낼지를 지정합니다.(기본값 : false, 단, IE < 10 은 항상 true)

관련 데모 보기

forceEditingComplete
Type : Method   Version: 2.7.0

편집모드(editable=true)인 경우 해당 input 의 값을 강제적으로 편집 완료 또는 취소 상태로 만듭니다.

이 메소드는 (더블)클릭 또는 F2 키 등과 같이 편집 진입한 상태인 경우에만 유효합니다.

사용자 정의 편집 렌더러(customEditRenderer) 를 사용했을 때 편집 렌더러의 값을 강제적으로 완료 또는 취소로 만들고자 한다면 이 메소드를 사용하세요.

현재 편집 인풋터(inputer)에 있는 값으로 편집 완료 상태로 만들고자 한다면 value 를 null 로 설정하십시오.

파라메터 설명

  • value (Object) : 설정하고자 하는 값
  • cancel (Boolean) : 이 값이 true 라면 에디팅 취소(cancel) 가 적용됩니다.
getAddedColumnFields
Type : Method   Version: 3.0

그리드에서 추가된 열(column) 의 dataField 들의 묶음(배열)을 반환합니다.

사용자가 임의로 열을 추가한 후, 다시 삭제하였다면 추가된 열에 포함되지 않습니다.

Return : (Array) 추가된 열의 dataField 들

getAddedRowItems
Type : Method   Version: 2.7.0

그리드에서 추가된 아이템들의 묶음(배열)을 반환합니다.

Return : (Array) 추가된 행 아이템들

관련 데모 보기

getAscendantsByRowId
Type : Method   Version: 2.7.0

트리 그리드(계층형 그리드)에서 행 고유 값(rowIdField 값)에 해당되는 모든 조상(ascendants) 행 아이템을 찾아 배열로 반환합니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)

Return : (Array) 주어진 행 고유 값(rowIdField 값)에 따른 모든 조상 행 아이템들

getCellElementByIndex
Type : Method   Version: 3.0.7.13

주어진 인덱스에 맞는 그리드 셀의 엘리먼트를 반환합니다.

셀의 엘리먼트는 TD 엘리먼트를 의미합니다.

파라메터 설명

  • rowIndex : (Number) 셀의 행 인덱스
  • columnIndex : (Number) 셀의 열 인덱스

Return : (Element Object) 해당 셀의 TD 엘리먼트

getCellFormatValue
Type : Method   Version: 2.8.1

그리드의 특정 셀의 포매팅된 값을 반환합니다.

파라메터 설명

  • rowIndex (Number) : 얻고자하는 행 인덱스
  • dataField or columnIndex(String or Number) : 얻고자 하는 칼럼의 dataField 또는 칼럼 인덱스
   // 0번째 행의 price 칼럼의 포매팅된 값 얻기
   var myValue = AUIGrid.getCellFormatValue(myGridID, 0, "price");
   // 3번째 행의 1 번째 칼럼 즉, (3, 1) 의 셀의 포매팅된 값 얻기
   var myValue = AUIGrid.getCellFormatValue(myGridID, 3, 1);

Return : 선택 셀 포매팅된 값

참고 : getCellValue 과 getCellFormatValue 의 차이는 값의 포매팅 여부 입니다.

예를 들어 칼럼에 labelFunction 이나 formatString 으로 값의 출력 형식을 변경했을 때,

getCellValue 는 원래 값이 반환되고, getCellFormatValue 는 labelFunction 또는 formatString 이 적용된 값을 반환합니다.

Also See : getItemByRowIndex, setCellValue, getCellValue

getCellValue
Type : Method   Version: 2.8.0

그리드의 특정 셀의 값을 반환합니다.

파라메터 설명

  • rowIndex (Number) : 얻고자하는 행 인덱스
  • dataField or columnIndex(String or Number) : 얻고자 하는 칼럼의 dataField 또는 칼럼 인덱스

Return : 선택 셀 값

   // 0번째 행의 name 칼럼의 값 얻기
   var myValue = AUIGrid.getCellValue(myGridID, 0, "name");
   // 3번째 행의 1 번째 칼럼 즉, (3, 1) 의 셀의 값 얻기
   var myValue = AUIGrid.getCellValue(myGridID, 3, 1);

참고 : getCellValue 과 getCellFormatValue 의 차이는 값의 포매팅 여부 입니다.

예를 들어 칼럼에 labelFunction 이나 formatString 으로 값의 출력 형식을 변경했을 때

getCellValue 는 원래 값이 반환되고, getCellFormatValue 는 labelFunction 또는 formatString 이 적용된 값을 반환합니다.

Also See : getItemByRowIndex, setCellValue, getCellFormatValue | 관련 데모 보기

getCheckedRowItems
Type : Method   Version: 2.7.0

엑스트라 행 체크박스가 설정된 경우 체크박스로 체크된 모든 행의 아이템과 행인덱스를 갖는 배열을 반환 합니다.

Return : (Array) 체크된 행 아이템 및 행 인덱스 배열

관련 데모 보기

getCheckedRowItemsAll
Type : Method   Version: 2.7.0

엑스트라 행 체크박스가 설정된 경우 체크박스로 체크된 모든 행의 아이템을 반환합니다.

이 메소드는 순수 행 아이템을 요소로 갖는 배열을 반환합니다.

즉, getCheckedRowItems 메소드는 행 아이템과 행인덱스 배열을 반환하지만 이 메소드는 순수 행 아이템을 요소로 갖는 배열을 반환합니다.

트리 그리드인 경우, 체크된 행이 부모의 열기/닫기로 인해 숨겨진 경우 getCheckedRowItems() 는 숨겨진 행 아이템을 반환하지 않습니다.

트리 그리드에서 숨겨진 행 아이템들도 얻고자 하는 경우 getCheckedRowItemsAll() 를 사용하십시오.

Return : (Array) 체크된 행 아이템 배열

관련 데모 보기

getColumnCount
Type : Method   Version: 3.0

현재 그리드에서 출력하고 있는 전체 열(columns)의 개수를 반환합니다.

Return : (Number) 전체 열(columns) 수

getColumnDistinctValues
Type : Method   Version: 2.7.0

그리드의 칼럼이 출력하는 모든 값들을 반환하되 중복된 값을 제거하고 반환합니다.

참고 : getColumnDistinctValues 메소드는 중복을 제거한 값을 반환하는 반면 getColumnValues 메소드는 모든 값을 반환합니다.

파라메터 설명

  • dataField : (String) 칼럼의 dataField 명
  • total : (Boolean) 그리드의 원래 데이터를 대상으로 할지 여부. 즉, 필터링이 된 경우 필터링 된 상태의 값만 원한다면 false 지정

Return : (Array) 해당 칼럼이 출력하고 있는 모든 값들(중복된 값이 제거된 고유 값들만 반환)

getColumnIndexByDataField
Type : Method   Version: 2.7.0

데이터 필드에 맞는 현재 그리드의 칼럼인덱스를 반환합니다.

파라메터 설명

  • dataField : (String) 데이터 필드명

Return : (Number) 칼럼인덱스

getColumnInfoList
Type : Method   Version: 2.7.0

그리드에 출력된 칼럼 정보를 갖는 1차원 배열을 반환합니다.

만약 칼럼 레이아웃을 그룹형(계층형)으로 설정한 경우 이 메소드의 반환 값은 최하위 자식들의 정보만을 담은 배열입니다.

그룹형이 아닌 경우, 이 반환값은 getColumnLayout() 메소드의 값과 같습니다.

Return : (Array) 현재 그리드 칼럼 레이아웃

getColumnItemByDataField
Type : Method   Version: 2.8.0

데이터 필드(dataField)에 맞는 칼럼 레이아웃의 칼럼 객체를 반환합니다.

파라메터 설명

  • dataField : (String) 컬럼이 출력하고 있는 데이터필드명

Return : (Object) 칼럼 레이아웃의 칼럼 객체

getColumnItemByIndex
Type : Method   Version: 3.0.12.0

열 인덱스(columnIndex)에 맞는 칼럼 레이아웃의 칼럼 객체를 반환합니다.

파라메터 설명

  • columnIndex : (Number) 컬럼이 출력되고 있는 인덱스

Return : (Object) 칼럼 레이아웃의 칼럼 객체

getColumnLayout
Type : Method   Version: 2.7.0

그리드에 출력된 현재 칼럼 레이아웃을 반환합니다.

Return : (Array) 현재 그리드 칼럼 레이아웃

getColumnValues
Type : Method   Version: 2.7.0

그리드의 칼럼이 출력하는 모든 값들을 반환합니다.

참고 : getColumnDistinctValues 메소드는 중복을 제거한 값을 반환하는 반면 getColumnValues 메소드는 모든 값을 반환합니다.

파라메터 설명

  • dataField : (String) 칼럼의 dataField 명
  • total : (Boolean) 그리드의 원래 데이터를 대상으로 할지 여부. 예로 필터링이 된 경우 필터링 무시하고 전체 데이터 대상 원한다면 true 지정

Return : (Array) 해당 칼럼이 출력하고 있는 모든 값들

getCurrentPageData
Type : Method   Version: 3.0.11.0

페이징 모드(usePaging=true)인 경우 현재 페이지에 출력되는 데이터만 반환합니다.

getDataFieldByColumnIndex
Type : Method   Version: 2.7.0

현재 그리드의 칼럼인덱스에 출력 중인 데이터필드(dataField)를 반환합니다.

파라메터 설명

  • columnIndex : (Number) 칼럼 인덱스

Return : (String) 데이터 필드명

getDepthByRowId
Type : Method   Version: 2.7.0

계층형 그리드(트리 그리드)인 경우 행 고유 값(rowIdField 값)에 맞는 행 아이템의 depth를 반환합니다.

깊이(depth) 는 최상위가 1에 해당되며 하위로 갈수록 1씩 증가합니다.

파라메터 설명

  • rowId (String) : 행 고유 값(rowIdField 값)

Return : (Number) 계층구조에서 depth

getDescendantsByRowId
Type : Method   Version: 2.7.0

트리 그리드(계층형 그리드)에서 행 고유 값(rowIdField 값)에 해당되는 모든 자손(descendants) 행 아이템을 찾아 배열로 반환합니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)

Return : (Array) 주어진 행 고유 값(rowIdField 값)에 따른 모든 자손 행 아이템들

getEditedRowColumnItems
Type : Method   Version: 2.7.0

그리드에서 수정된 아이템들의 묶음(배열)을 반환합니다.

getEditedRowItems() 과 다르게 이 메소드는 행 아이템 전체를 반환하지 않습니다. 예를들어 칼럼이 총 10개 있다고 했을 때 그 중 2개 칼럼만 수정했다면 해당 2개 칼럼만을 반환합니다.

행 아이템 전체를 얻고자 한다면 getEditedRowItems() 메소드를, 행에서 진짜로 수정된 칼럼들만 얻고자 한다면 이 메소드를 사용하십시오.

수정된 아이템은 최초의 데이터에서 addRow 메소드로 추가된 아이템을 수정한 경우 포함되지 않습니다.

addRow 메소드로 추가된 아이템은 수정했더라도 최종적으로 추가된 아이템에 해당되기 때문입니다.(getAddedRowItems으로 확인 가능)

Return : (Array) 수정된 행 아이템들

Also See : getEditedRowItems | 관련 데모 보기

getEditedRowItems
Type : Method   Version: 2.7.0

그리드에서 수정된 아이템들의 묶음(배열)을 반환합니다.

수정된 아이템은 최초의 데이터에서 addRow 메소드로 추가된 아이템을 수정한 경우 포함되지 않습니다.

addRow 메소드로 추가된 아이템은 수정했더라도 최종적으로 추가된 아이템에 해당되기 때문입니다.(getAddedRowItems으로 확인 가능)

Return : (Array) 수정된 행 아이템들

Also See : getEditedRowColumnItems | 관련 데모 보기

getFilterCache
Type : Method   Version: 3.0.11.2

필터링 된 경우 현재 어떤 필드와 값으로 필터링 되었는지에 대한 정보를 반환합니다.

이 메소드는 일반적으로 setFilterCache 메소드와 같이 사용 합니다.

Return : (Object) 필터링 필드와 현재 필터링 된 값들에 대한 정보

Also See : setFilterCache

getFilterInlineTexts
Type : Method   Version: 3.0.11.9

인라인 필터 행을 표시하여 필터링을 한 경우 해당 인라인 필터의 현재 텍스트들(input 의 값들)을 반환합니다.

이 메소드는 일반적으로 setFilterInlineTexts 메소드와 같이 사용 합니다.

Return : (Array) 인라인 필터로 필터링 된 칼럼들에 대한 텍스트값들

Also See : setFilterInlineTexts | 관련 데모 보기

getFitColumnSizeList
Type : Method   Version: 2.7.0

현재 출력된 헤더 텍스트를 모함하여 모든 셀들의 길이를 조사하여 최적의 칼럼 사이즈를 배열 형태로 반환합니다.

파라메터 설명

  • fitToGrid (Boolean) : 모든 칼럼 사이즈들의 총합이 그리드 전체 크기보다 작은 경우 그리드 크기에 맞출지 여부를 지정합니다. (기본값: false)

Return : (Array) 모든 칼럼들의 크기를 담은 배열

참고 : getFitColumnSizeList 메소드로 얻은 값을 setColumnSizeList 메소드로 활용하십시오.

getFooterData
Type : Method   Version: 2.7.0

현재 그리드에 출력된 푸터 데이터를 반환합니다.

반환형은 Object 를 요소로 갖는 배열입니다.

개별 Object 는 다음과 같은 key-value 로 이루어집니다.

  • index : 출력된 값의 칼럼 인덱스 값 ("#base" 로 행 번호 칼럼에 출력된 푸터 값은 index 가 -1입니다.)
  • value : 푸터의 값이 포매팅 전의 순수 값 (labelFunction 으로 사용자가 임의 지정한 경우 value 는 text 와 같습니다.)
  • text : 실제로 푸터의 셀에 출력된 포매팅 된 값

Return : (Array) 출력된 푸터 데이터

getFooterFormatValueByDataField
Type : Method   Version: 3.0.5.8

푸터를 설정한 경우 푸터의 특정 필드의 포매팅된 값을 반환합니다.

파라메터 설명

  • dataField : (String) 푸터의 출력 위치 dataField

Return : (String) 해당 열의 푸터 포매팅된 값

  // name 열의 푸터  포매팅된 값 얻기
  var myValue = AUIGrid.getFooterFormatValueByDataField(myGridID, "name");

참고 : getFooterValueByDataField 과 getFooterFormatValueByDataField 의 차이는 값의 포매팅 여부 입니다.

getFooterLayout
Type : Method   Version: 2.7.0

사용자가 설정한 푸터 객체(푸터 레이아웃) 을 반환합니다.

즉, AUIGrid.setFooter() 메소드로 삽입한 푸터 객체를 반환합니다.

Return : (Array) 사용자가 설정한 푸터 객체(푸터 레이아웃)

getFooterValueByDataField
Type : Method   Version: 3.0.5.8

푸터를 설정한 경우 푸터의 특정 필드 값을 반환합니다.

파라메터 설명

  • dataField : (String) 푸터의 출력 위치 dataField

Return : (Number or String) 해당 열의 푸터 값

   // name 열의 푸터  값 얻기
   var myValue = AUIGrid.getFooterValueByDataField(myGridID, "name");

참고 : getFooterValueByDataField 과 getFooterFormatValueByDataField 의 차이는 값의 포매팅 여부 입니다.

getGridData
Type : Method   Version: 2.7.0

그리드에 출력된 현재 데이터를 반환합니다.

필터링, 정렬 등으로 현재 그리드에 보여지는 데이터가 변했다면, 그 상태의 모습 그대로를 반환합니다.

필터링, 정렬 등으로 변한 데이터가 아닌 전체 데이터를 얻고자 한다면 getOrgGridData 메소드를 사용하십시오.

Return : (Array) 현재 그리드 행 아이템들

getGridDataWithState
Type : Method   Version: 3.0.12.0

그리드에 출력된 현재 데이터를 추가(added), 삭제(removed), 수정(edited)된 상태와 함께 반환합니다.

그리드에 보여지는 현재 데이터 그대로에 행 상태 정보가 포함되어 반환합니다.

추가된 행은 "added", 삭제된 행은 "removed", 수정된 행은 "edited" 값으로 반환합니다.

삭제된 행은 소프트삭제 모드인 경우(softRemoveRowMode=true 인 경우)만 상태가 포함됩니다.

파라메터 설명

  • stateField (String) : 상태 정보가 추가될 필드명
  • option (Object) : stateField 의 값으로 사용 될 상태 값들 재정의
 // 그리드 데이터에 state 필드 상태 정보 포함시켜 반환
 var gridDataWithState = AUIGrid.getGridDataWithState(myGridID, "state");
 
 // 추가, 삭제, 수정된 상태 정보 값들을 각각 "a", "r", "e" 로 변경하여 반환 (state 필드에 각각 "a", "r", "e" 로 존재함)
 var gridDataWithState = AUIGrid.getGridDataWithState(myGridID, "state", {added:"a", removed:"r", edited:"e"});

Return : (Array) 상태 정보가 포함된 현재 그리드 행 아이템들

getHiddenColumnDataFields
Type : Method   Version: 2.7.0

현재 그리드에서 숨겨진 칼럼(hidden Columns)이 있는 경우 숨겨진 칼럼들의 모든 dataField 를 반환합니다.

Return : (Array) 숨겨진 칼럼(hidden Columns)들의 dataField 를 담은 배열

getHiddenColumnIndexes
Type : Method   Version: 2.7.0

현재 그리드에서 숨겨진 칼럼(hidden Columns)이 있는 경우 숨겨진 칼럼들의 칼럼 인덱스(columnIndex) 를 반환합니다.

Return : (Array) 숨겨진 칼럼(hidden Columns)들의 칼럼 인덱스를 담은 배열

getIndexesByEvent
Type : Method   Version: 3.0.12.0

자바스크립트 네이티브 마우스 이벤트(Native MouseEvent)를 통해 그리드의 인덱스 정보를 반환합니다.

파라메터 설명

  • mouseEvent : (MouseEvent) 마우스 이벤트

Return : (Object) { startRowIndex, startColumnIndex, endRowIndex, endColumnIndex } 의 key 를 갖는 그리드 인덱스 정보 Object

getInitCellValue
Type : Method   Version: 2.14

특정 셀(rowId 에 맞는 행, dataField 에 맞는 열 부합하는 셀)이 수정된 경우 최초의 그리드 셀 값을 반환합니다.

즉, 수정되기 전 원래의 셀 값을 반환합니다.

파라메터 설명

  • rowId : (String) 행 아이템의 rowId 값
  • dataField : (String) 열의 dataField

Return : (String or Object) 변경 전 원래 셀의 값

   // "#Cust1" 이 행의 ID 이고, 데이터 필드명이 "name" 인 열인 셀의 원래 값 반환
   var orgValue = AUIGrid.getInitCellValue(myGridID, "#Cust1", "name");
getInitValueItem
Type : Method   Version: 3.0.4

그리드 행이 수정된 경우 최초의 그리드 행 아이템을 반환합니다. 즉, 수정되기 전 원래의 값을 갖는 행 아이템을 반환합니다.

파라메터 설명

  • rowId : (String or Array) 행 아이템의 rowId 값

Return : (Object or Array) 수정 전의 행 아이템(들), 만약 해당 행이 수정되지 않았다면 null 반환

   // rowId 가 "#Cust0" 인 행의 원본 행 아이템 반환
   if(AUIGrid.isEditedById(myGridID, "#Cust0")) { // 먼저 수정되었는지 체크
       var orgItem = AUIGrid.getInitValueItem(myGridID, "#Cust0");
   }
   // rowId 가 "#Cust0", "#Cust1"인 행들의 원본 행 아이템들 반환 - 복수 사용 예
   var orgItems = AUIGrid.getInitValueItem(myGridID, ["#Cust0", "#Cust1"]);
getItemByRowId
Type : Method   Version: 2.7.0

행 고유 값(rowIdField 값)에 맞는 행 아이템을 반환합니다.

파라메터 설명

  • rowId (String) : 행 고유 값(rowIdField 값)

Return : (Object) 행아이템 객체

getItemByRowIndex
Type : Method   Version: 2.7.0

행 인덱스에 맞는 행 아이템을 반환합니다.

파라메터 설명

  • rowIndex (Number) : 행인덱스

Return : (Object) 행아이템 객체

getItemsByValue
Type : Method   Version: 2.7.0

특정 value 에 맞는 행 아이템을 반환합니다.

파라메터 설명

  • dataField : (String) 행 아이템에서 얻고자하는 필드명
  • value : (String) 행 아이템에서 얻고자 하는 필드의 값(value)

예를 들어 이름(name) 이 "Anna" 라는 사람의 행 아이템을 얻고자 한다면 다음과 같습니다.

 var rowItems = AUIGrid.getItemsByValue(myGridID, "name", "Anna");

Return : (Array) 조건에 맞는 행 아이템 묶음

참고 : 복수의 값 즉, 이름이 "Anna", "Emma" 등의 복수 값에 대한 행 아이템을 얻고자 한다면 getRowsByValue 메소드를 사용하십시오.

getMergeEndRowIndex
Type : Method   Version: 3.0.6

세로 병합된 셀에 대하여 해당 병합의 마지막 행 인덱스를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 세로 병합된 셀의 행 인덱스
  • columnIndex : (Number) 세로 병합된 셀의 열 인덱스

Return : (Number) 셀이 세로 병합된 셀인 경우 병합 마지막 행 인덱스 반환

주어진 셀이 세로 병합된 셀이 아닌 경우 -1을 반환합니다.

  // (10, 0) 셀이 세로 병합된 셀인 경우 병합 마지막 행 인덱스 반환
  var startRowIndex = AUIGrid.getMergeEndRowIndex(myGridID, 10, 0);
getMergeItems
Type : Method   Version: 3.0.9.0

주어진 셀이 세로 병합된 경우 해당 셀의 세로 병합의 대상이 된 모든 행 아이템을 반환합니다.

파라메터 설명

  • rowIndex : (Number) 셀의 행 인덱스
  • columnIndex : (Number) 셀의 열 인덱스

Return : (Array) 해당 셀로 세로 병합된 모든 행 아이템들

getMergeStartRowIndex
Type : Method   Version: 3.0.6

세로 병합된 셀에 대하여 해당 병합의 시작 행 인덱스를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 세로 병합된 셀의 행 인덱스
  • columnIndex : (Number) 세로 병합된 셀의 열 인덱스

Return : (Number) 셀이 세로 병합된 셀인 경우 병합 시작 인덱스 반환

주어진 셀이 세로 병합된 셀이 아닌 경우 -1을 반환합니다.

  // (10, 0) 셀이 세로 병합된 셀인 경우 병합 시작 행 인덱스 반환
  var startRowIndex = AUIGrid.getMergeStartRowIndex(myGridID, 10, 0);
getOrgCellValue
Type : Method   Version: 2.14

[deprecated Ver 3.0.4] 수정되기 전의 셀 값을 반환합니다.

Also See : getInitCellValue

getOrgGridData
Type : Method   Version: 2.7.0

그리드의 데이터를 반환합니다.

이 메소드는 필터링, 정렬 등으로 현재 그리드에 보여지는 데이터가 아닌 전체 데이터를 반환합니다.

현재 보여지는 데이터를 얻고자 한다면 getGridData 메소드를 사용하십시오.

Return : (Array) 현재 그리드 행 아이템들

getOrgValueItem
Type : Method   Version: 2.14

[deprecated Ver 3.0.4] 수정되기 전 원래의 값을 갖는 행 아이템을 반환합니다.

Also See : getInitValueItem

getParentColumnByDataField
Type : Method   Version: 3.0.10.0

헤더를 계층형(그룹형)으로 설정한 경우 자기 자신의 부모에 해당되는 그룹 칼럼을 반환합니다.

파라메터 설명

  • dataField (String) : 칼럼의 데이터 필드명

Return : (Object) 그룹 칼럼 아이템

   // name 헤더의 부모에 해당되는 그룹 칼럼 얻기
   var groupColumn = AUIGrid.getParentColumnByDataField(myGridID, "name");
getParentItemByRowId
Type : Method   Version: 2.7.0

계층형 그리드(트리 그리드)인 경우 행 고유 값(rowIdField 값)에 맞는 행 아이템의 부모 행 아이템을 찾아 반환합니다.

즉, rowId 의 부모 아이템을 반환합니다.

부모 아이템이 없는 루트(root)에 해당되는 행인 경우 null 을 반환합니다.

파라메터 설명

  • rowId (String) : 행 고유 값(rowIdField 값)

Return : (Object) 부모 행 아이템

getProp
Type : Method   Version: 2.7.0

그리드 속성의 값을 반환합니다.

파라메터 설명

  • name (String) : 속성명

Return : (Object) 속성값

Also See : setProp | 관련 데모 보기

getRemovedColumnFields
Type : Method   Version: 3.0

그리드에서 삭제된 열(column) 의 dataField 들의 묶음(배열)을 반환합니다.

삭제된 열이란 최초 칼럼 레이아웃 작성 시 정의한 칼럼을 삭제 한 것을 말합니다.

즉, 사용자가 임의로 추가한 후 삭제하였다면 삭제된 열에 포함되지 않습니다.

Return : (Array) 삭제된 열의 dataField 들

getRemovedItems
Type : Method   Version: 2.7.0

그리드에서 삭제된 아이템들의 묶음(배열)을 반환합니다.

기본적으로, 삭제된 아이템은 최초의 데이터에서 addRow 메소드로 추가된 아이템을 삭제한 경우 포함되지 않습니다.

즉, 최초 그리드에 삽입된 데이터를 삭제한 행 아이템만 반환합니다.

만약, 추가된 행을 삭제 했을 때 그 추가된 행까지 얻고자 한다면 includeAdded 파라메터를 true 로 설정하십시오.

파라메터 설명

  • includeAdded (Boolean) : 최초의 데이터에서 사용자에 의해 추가된 행을 다시 사용자가 삭제한 경우, 해당 아이템까지 반환 여부

Return : (Array) 삭제된 행 아이템들

관련 데모 보기

getRemovedNewItems
Type : Method   Version: 2.7.0

그리드에서 사용자에 의해 추가되어 다시 삭제된 아이템들의 묶음(배열)을 반환합니다.

즉, 최초 그리드에 삽입된 데이터가 아닌 addRow 메소드나 Insert 키와 같은 방식으로 최초 이후 추가된 행이 삭제된 경우 그 행 아이템들만 반환합니다.

Return : (Array) 추가된 후 삭제된 행 아이템들

getRowCount
Type : Method   Version: 2.7.0

현재 그리드에서 출력하고 있는 전체 행의 개수를 반환합니다.

만약 트리 그리드로 출력하고 있다면 접혀진 브랜치(branch) 행 그대로 개수를 반환합니다. 예를 들어 브랜치 행이 모두 닫혀져 3개만 보이고 있을 때 3이 반환됩니다.

Return : (Number) 전체 행 수

getRowIndexesByValue
Type : Method   Version: 2.7.0

특정 칼럼의 값과 일치하는 값이 있는 행을 모두 찾아 행인덱스(rowIndex)를 반환합니다.

파라메터 설명

  • dataField : (String) 찾고자 하는 칼럼의 dataField 명
  • values : (String or Array) dataField 에서 찾고자 하는 값( 복수의 값인 경우 Array )

예를 들어 "이름이 Anna, Lawrence 인 사람의 행 인덱스 모두 반환" 하고자 한다면 다음과 같습니다.

 var rows = AUIGrid.getRowIndexesByValue(myGridID, "name", ["Anna", "Lawrence"]);

Return : (Array) 해당 dataField 에서 주어진 값(values) 와 일치하는 모든 행 아이템들의 rowIndex

참고 : 행 아이템을 얻고자 한다면 getRowsByValue 메소드 참고

getRowPosition
Type : Method   Version: 2.7.0

수직 스크롤이 생성된 경우 현재 그리드가 출력되고 있는 행의 최상단 인덱스를 반환합니다.

즉, 스크롤에 의해 현재 보여지고 있는 아이템들의 최상단 행의 인덱스를 반환합니다.

수직 스크롤이 생성되지 않은 경우 이 값은 0 을 반환합니다.

Return : (Number) 최상단 행 인덱스

getRowsByValue
Type : Method   Version: 2.7.0

특정 칼럼의 값과 일치하는 값이 있는 행을 모두 찾아 반환합니다.

파라메터 설명

  • dataField : (String) 찾고자 하는 칼럼의 dataField 명
  • values : (String or Array) dataField 에서 찾고자 하는 값( 복수의 값인 경우 Array )

예를 들어 "이름이 Anna, Lawrence 인 사람의 행 아이템 모두 반환" 하고자 한다면 다음과 같습니다.

 var rows = AUIGrid.getRowsByValue(myGridID, "name", ["Anna", "Lawrence"]);

Return : (Array) 해당 dataField 에서 주어진 값(values) 와 일치하는 모든 행 아이템들

참고 : 행인덱스을 얻고자 한다면 getRowIndexesByValue 메소드 참고

getScaleFactor
Type : Method   Version: 3.0.7.7

그리드에 설정된 scaleFactor 의 값을 반환합니다.

See Also : scaleFactor

Return : (Number) scale 값

getSelectedColIndexes
Type : Method   Version: 3.0.7.4

현재 선택된 셀(들)의 시작 칼럼, 종료 칼럼 인덱스를 반환합니다.

Return : (Array) 선택한 셀(들)의 시작 칼럼 인덱스, 종료 칼럼 인덱스 배열

   // 선택된 셀의 시작, 종료 칼럼 인덱스 얻기
   var colIndexes = AUIGrid.getSelectedColIndexes(myGridID);
getSelectedIndex
Type : Method   Version: 2.7.0

선택 모드가 "none" 이 아닌 경우 현재 선택된 아이템의 rowIndex, columnIndex 를 반환합니다.

다수의 셀 또는 행을 선택한 경우 첫번째 선택된 셀 또는 행의 rowIndex, columnIndex 를 반환합니다.

선택된 모든 셀 또는 행을 얻고자 한다면 getSelectedItems() 메소드를 사용하십시오.

rowIndex 는 반환값의 0 번째, columnIndex 는 반환값의 1 번째 요소입니다.

Return : (Array) rowIndex, columnIndex 를 갖는 배열(배열 요소 2개임 0번째는 rowIndex, 1번째는 columnIndex)

getSelectedItems
Type : Method   Version: 2.7.0

선택 모드(selectionMode)가 "none" 이 아닌 경우 현재 선택된 모든 셀(또는 행) 아이템을 반환합니다.

반환값은 배열로 개별 배열 요소는 다음과 같은 요소를 갖는 Object 입니다.

  • rowIndex : 행의 인덱스
  • columnIndex : 칼럼의 인덱스
  • dataField : 선택 칼럼이 출력하고 있는 그리드 데이터의 필드명
  • headerText : 선택 칼럼의 헤더 텍스트
  • editable : 선택 칼럼의 수정 가능 여부
  • value : 선택 셀의 현재 그리드 값
  • item : 선택 행 아이템들을 갖는 Object

사용 예는 다음과 같습니다.

 var selectedItems = AUIGrid.getSelectedItems(myGridID);
 if(selectedItems.length == 0) return;
 // singleRow, singleCell 이 아닌 multiple 인 경우 선택된 개수 만큼 배열의 요소가 있음
 var first = selectedItems[0];

 // first 의 값을 보고자 한다면? first.value
 // first 의 행, 칼럼 인덱스를 보고자 한다면? first.rowIndex, first.columnIndex
 // first 의 행 아이템 전체를 보고자 한다면? first.item
 console.log(first);
 alert( JSON.stringify(first) );

Return : (Array) 선택된 아이템들을 요소로 갖는 배열

관련 데모 보기

getSelectedRows
Type : Method   Version: 3.0

선택 모드(selectionMode)가 "none" 이 아닌 경우 현재 선택된 행(rows) 아이템을 반환합니다.

셀 선택 모드라 하더라도 해당 셀의 행 아이템이 반환됩니다.

반환값은 배열로 배열요소는 순수 행 아이템들의 묶음(Array)입니다.

사용 예는 다음과 같습니다.

  var selectedRows = AUIGrid.getSelectedRows(myGridID);
  console.log(selectedRows);

Return : (Array) 선택된 행 아이템들을 요소로 갖는 배열

Also See : getSelectedItems

getSelectedText
Type : Method   Version: 2.8.0

그리드 선택 셀의 값을 텍스트로 반환합니다.

다수의 셀이 선택된 경우 행, 열에 구분은 탭(\t)과 캐리지 리턴(\r\n) 으로 구분된 텍스트를 반환합니다.

Return : (String) 선택 셀 값 텍스트

getSortingFields
Type : Method   Version: 3.0.7.13

그리드가 정렬된 상태인 경우 어떤 필드로 정렬되었는지에 대한 정보 배열을 반환합니다.

Return : (Array) 정렬 필드 정보 배열

getStateCache
Type : Method   Version: 3.0.11.0

현재 그리드 추가, 삭제, 변경된 상태 정보 캐시를 반환합니다.

반환된 정보는 syncGridData 메소드에서 사용할 수 있습니다.

Return : (Object) 추가, 삭제, 변경된 상태 정보 캐시

Also See : syncGridData

getTextDataProvider
Type : Method   Version: 3.0.12.6

그리드에 출력된 현재 값을 모두 스트링(String)으로 적용한 텍스트 데이터를 반환합니다.

텍스트 데이터란 포매팅이 적용된 데이터입니다.

Return : (Array) 현재 그리드 텍스트 데이터

getTreeFilteredFlatData
Type : Method   Version: 3.0.11.2

트리 그리드가 필터링 된 경우 현재 데이터의 자손행들까지 포함하여 모두 1차원 배열 형태로 반환합니다.

부모 행(들)의 펼쳐진 상태와 무관하게 현재 데이터의 필터링 규칙에 맞는 자손행들까지 모두 반환합니다.

Return : (Array) 필터링된 상태의 행 아이템들

Also See : getTreeGridData | getTreeFlatData

getTreeFlatData
Type : Method   Version: 3.0.4

트리 그리드의 계층적 구조를 갖는 데이터의 자손행들까지 포함하여 모두 1차원 배열 형태로 반환합니다.

그리드의 현재 상태가 정렬 또는 필터링 된 상태와 무관하게 전체 데이터를 1차원 배열 형태로 반환합니다.

Return : (Array) 전체 행 아이템들

Also See : getTreeGridData | getTreeFilteredFlatData

getTreeGridData
Type : Method   Version: 2.7.0

트리 그리드의 계층적 구조를 갖는 데이터를 반환합니다.

Return : (Array) 계층적 구조 행 아이템들

Also See : getTreeFlatData

getTreeTotalDepth
Type : Method   Version: 2.7.0

트리 그리드 또는 그룹형으로 계층형으로 만든 경우 계층형 데이터의 전체 깊이(depth) 를 반환합니다.

Return : (Number) 전체 depth

hideColumnByDataField
Type : Method   Version: 2.7.0

주어진 파라메터(dataField)에 맞게 출력된 그리드 칼럼을 보이지 않도록 지정합니다.

복수의 칼럼을 보이지 않도록 지정하고자 한다면 배열로 설정하십시오. (예: ["name", "country", "product"] )

파라메터 설명

  • dataField (String or Array) : 칼럼의 데이터 필드명(들)

Also See : showColumnByDataField | 관련 데모 보기

hideColumnGroup
Type : Method   Version: 3.0.10.0

헤더를 계층형(그룹형)으로 설정한 경우 그룹(브랜치)에 해당되는 칼럼에 속한 모든 칼럼(자손 칼럼들)을 보이지 않게 지정합니다.

파라메터 설명

  • dataField (String) : 칼럼의 데이터 필드명

Also See : showColumnGroup | 관련 데모 보기

hideFooterLater
Type : Method   Version: 3.0.11.9

그리드 생성 시 푸터 출력을 한 경우 이미 출력된 그리드에서 푸터를 표시하지 않게 합니다.

Also See : showFooterLater

indentTreeDepth
Type : Method   Version: 2.7.0

편집 가능 상태인 경우 선택한 행을 들여 쓰기 하여 계층 구조로 만듭니다.

들여 쓰기 된 행은 상단 행의 자식으로 붙습니다.

그리드의 현재 상태가 정렬 또는 필터링 된 상태 그리고 그룹핑 된 상태에서는 사용 할 수 없습니다.

indexToRowId
Type : Method   Version: 2.13.0

행 인덱스(rowIndex)에 맞는 행 고유 값(rowIdField 값)을 반환합니다

파라메터 설명

  • rowIndex : (Number) 행 인덱스

Return : rowId : (String) 행 고유 값(rowIdField 값)

Also See : rowIdToIndex

isAddedById
Type : Method   Version: 2.7.0

행 고유 값(rowIdField 값)에 맞는 행 아이템이 추가된 행인지 여부를 반환합니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)

Return : (Boolean) 추가된 행인 경우 true 반환.

isAddedByRowIndex
Type : Method   Version: 3.0.12.0

행 인덱스(rowIndex)에 맞는 행 아이템이 추가된 행인지 여부를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 행 인덱스

Return : (Boolean) 추가된 행인 경우 true 반환.

isAvailabePdf
Type : Method   Version: 2.7

현재 브라우저에서 그리드의 기능인 PDF 내보내기(Export) 사용 가능 여부를 반환합니다.

완전히 HTML5 를 지원하는 브라우저에서 true를 반환합니다. 즉, 완전히 HTML5 를 지원하는 브라우저에서 PDF 내보내기 사용 가능합니다.

Return : (Boolean) PDF 내보내기 가능 여부

관련 데모 보기

isAvailableLocalDownload
Type : Method   Version: 2.11.0

엑셀(xlsx), CSV, TXT 등으로 내보내기 할 때 로컬(Local) 자원만을 갖고 다운로딩 처리 가능한지 여부를 반환합니다.

완전히 HTML5 를 지원하는 브라우저에서 true를 반환합니다. 즉, 완전히 HTML5 를 지원하는 브라우저에서 서버사이드 거치지 않고 바로 내보내기 가능합니다.

Return : (Boolean) 로컬 다운로드 가능 여부

관련 데모 보기

isCheckedRowById
Type : Method   Version: 2.11.0

엑스트라 행 체크박스가 설정된 경우 행 고유 값(rowIdField 값)을 이용해 해당 행(row)이 체크됐는지 여부를 반환합니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)

Return : (Boolean) 현재 체크 박스에 체크된 행인지 여부

관련 데모 보기

isCreated
Type : Method   Version: 2.7.0

그리드가 생성되었는지 여부를 반환합니다.

  var isCreated = AUIGrid.isCreated("#myGrid1");

예를 들어 위와 같이 작성한다면 myGrid1 을 id 로 갖는 Div 에 그리드가 생성되었는지 여부를 반환합니다.

Return : (Boolean) 생성되었는지 여부

isEditedById
Type : Method   Version: 2.7.0

행 고유 값(rowIdField 값)에 맞는 행 아이템이 수정된 행인지 여부를 반환합니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)

Return : (Boolean) 수정된 행인 경우 true 반환.

isEditedByRowIndex
Type : Method   Version: 3.0.12.0

행 인덱스(rowIndex)에 맞는 행 아이템이 수정된 행인지 여부를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 행 인덱스

Return : (Boolean) 수정된 행인 경우 true 반환.

isEditedCell
Type : Method   Version: 2.14

특정 셀(행 고유 값(rowIdField 값)에 맞는 행, dataField 에 맞는 열 부합하는 셀)이 수정되었는지 여부를 반환합니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)
  • dataField : (String) 열의 dataField

Return : (Boolean) 수정된 셀인 경우 true 반환.

 // "#Cust1" 이 행의 ID 이고, 데이터 필드명이 "name" 인 열인 셀이 현재 수정되었는지 여부 반환
 var isEdited = AUIGrid.isEditedCell(myGridID, "#Cust1", "name");
 alert(isEdited);
isEditedCellByIndex
Type : Method   Version: 3.0.12.0

특정 셀(행, 열 인덱스에에 맞는 셀)이 수정되었는지 여부를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 셀의 행 인덱스
  • columnIndex : (Number) 셀의 열 인덱스

Return : (Boolean) 수정된 셀인 경우 true 반환.

isFilteredGrid
Type : Method   Version: 2.7.0

현재 그리드 데이터가 필터링(filtering) 되었는지 여부를 반환합니다.

Return : (Boolean) 필터링 여부 반환

isItemBranchByRowId
Type : Method   Version: 2.7.0

계층형 그리드(트리 그리드)인 경우 행 고유 값(rowIdField 값)에 맞는 행 아이템이 브랜치(branch) 인지 여부를 반환합니다.

파라메터 설명

  • rowId (String) : 행 고유 값(rowIdField 값)

Return : (Boolean) 브랜치(branch) 여부

isItemOpenByRowId
Type : Method   Version: 2.7.0

계층형 그리드(트리 그리드)인 경우 행 고유 값(rowIdField 값)에 맞는 행 아이템이 현재 열려진 상태인지 여부를 반환합니다.

파라메터 설명

  • rowId (String) : 행 고유 값(rowIdField 값)

Return : (Boolean) 열린 상태 여부

isItemVisibleByRowId
Type : Method   Version: 2.7.0

행 고유 값(rowIdField 값)에 맞는 행 아이템이 현재 그리드에 출력된 상태인지 여부를 나타냅니다.

이 상태는 현재 시각적으로 눈에 보이지 않는 행이라면 false 를 반환합니다.

파라메터 설명

  • rowId (String) : 행 고유 값(rowIdField 값)

Return : (Boolean) 보여지는 행 아이템인지 여부

isLazyRequestedByIndex
Type : Method   Version: 3.0.13

treeLazyMode 에서 하위(자식) 데이터를 이미 요청하였는지 여부를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 행 인덱스

Return : (Boolean) 요청 완료하였다면 true, 아직 요청 전이라면 false 반환/p>

isMergedCell
Type : Method   Version: 3.0.6

셀이 병합된 셀인지 여부를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 셀의 행 인덱스
  • columnIndex : (Number) 셀의 열 인덱스

Return : (Boolean) 주어진 셀이 병합된 셀인지 여부 반환

  // (10, 0) 셀이 병합된 셀인지 여부 반환
  var isMerged = AUIGrid.isMergedCell(myGridID, 10, 0);
isOpenFilterLayer
Type : Method   Version: 2.9.3

그리드 필터를 설정한 경우, 필터 레이어의 현재 오픈 여부를 반환합니다.

Return : (Boolean) 현재 열려 있는지 여부 반환

Also See : openFilterLayer, closeFilterLayer | 관련 데모 보기

isRemovedById
Type : Method   Version: 2.7.0

행 고유 값(rowIdField 값)에 맞는 행 아이템이 삭제된 행인지 여부를 반환합니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)

Return : (Boolean) 삭제된 행인 경우 true 반환.

isRemovedByRowIndex
Type : Method   Version: 3.0.12.0

행 인덱스(rowIndex)에 맞는 행 아이템이 삭제된 행인지 여부를 반환합니다.

파라메터 설명

  • rowIndex : (Number) 행 인덱스

Return : (Boolean) 삭제된 행인 경우 true 반환.

isSelectionReversed
Type : Method   Version: 3.0.14

셀 선택모드(selectionMode)를 "multipleCells", "multipleRows" 로 설정한 경우 현재 선택이 역방향으로 선택되었는지 여부를 반환합니다.

예로 사용자가 현재 5행부터 시작하여 1행까지를 선택한 경우 역방향으로 선택되어 true를 반환합니다.

Return : (Boolean) 셀 선택을 역방향으로 선택한 경우 false 반환, 순방향인 경우 true 반환/p>

isSortedGrid
Type : Method   Version: 2.7.0

현재 그리드 데이터가 정렬(sorting) 되었는지 여부를 반환합니다.

Return : (Boolean) 정렬 여부 반환

isTreeGrid
Type : Method   Version: 2.7.0

현재 그리드의 상태가 트리 그리드(TreeGrid) 인지 여부를 반환합니다.

트리 그리드는 사용자가 계층형 데이터를 삽입한 경우 또는 그룹핑을 실행한 경우 트리 그리드입니다.

Return : (Boolean) 현재 그리드의 상태가 트리 그리드인지 여부

isUniqueValue
Type : Method   Version: 2.7.0

그리드 칼럼에서 특정 값(value)이 전체 데이터에 대하여 칼럼의 고유 값인지 여부를 반환합니다.

여기서 고유 값의 의미는 현재 그리드의 값으로 존재하지 않아 고유한지를 의미합니다.

파라메터 설명

  • dataField : (String) 고유 값인지 보고자 하는 데이터의 데이터필드명
  • value : (Object) 고유 값인지 알고자 하는 값(value)

Return : (Boolean) 검사하는 값이 고유 값이면 true, 중복된 값이 있다면 false 반환.

예로 다음처럼 사용할 때

AUIGrid.isUniqueValue(myGridID, "name", "ABC");

"name" 이라는 칼럼에 "ABC" 값이 유니크한지를 검사합니다. 즉, "name" 이라는 칼럼에 현재 "ABC" 값이 없는지를 검사합니다.

검사하려는 값 "ABC"가 존재 하지 않을 때 유니크하게 됩니다.

따라서 해당 값이 현재 그리드의 "name" 칼럼에 존재하지 하지 않으면 true, 1개 이상 존재하면 false 반환합니다.

movePageTo
Type : Method   Version: 2.11.0

페이징을 사용하는 경우(usePaging=true) 원하는 페이지로 이동시키는 메소드입니다.

파라메터 설명

  • pageNum (Number) : 이동하고자 하는 페이지 번호
  • keepVScrollPos (Boolean) : 이동할 때 수직 스크롤의 위치 유지 여부(기본값:false)
  • keepHScrollPos (Boolean) : 이동할 때 수평 스크롤의 위치 유지 여부(기본값:false)
moveRowsToDown
Type : Method   Version: 2.7.0

그리드 선택 행(들)의 인덱스를 아래로 한 단계 이동시킵니다.

행 이동은 일반 그리드 뿐만 아니라 트리 그리드(계층형 데이터)에서도 적용이 가능합니다.

브랜치(Branch) 를 이동시키는 경우 아래 자손들도 함께 따라 움직입니다. 트리 그리드에서 리프(Leaf)의 이동은 자신의 부모를 벗어 날 수 없습니다.

그리드의 현재 상태가 정렬 또는 필터링 된 상태 그리고 그룹핑 된 상태에서는 사용 할 수 없습니다.

Also See : moveRowsToUp | 관련 데모 보기

moveRowsToUp
Type : Method   Version: 2.7.0

그리드 선택 행(들)의 인덱스를 위로 한 단계 이동시킵니다.

행 이동은 일반 그리드 뿐만 아니라 트리 그리드(계층형 데이터)에서도 적용이 가능합니다.

브랜치(Branch) 를 이동시키는 경우 아래 자손들도 함께 따라 움직입니다. 트리 그리드에서 리프(Leaf)의 이동은 자신의 부모를 벗어 날 수 없습니다.

그리드의 현재 상태가 정렬 또는 필터링 된 상태 그리고 그룹핑 된 상태에서는 사용 할 수 없습니다.

Also See : moveRowsToDown | 관련 데모 보기

moveRowToIndex
Type : Method   Version: 3.0.12.6

그리드의 특정 단일 행을 지정한 행 인덱스(rowIndex)로 이동 시킵니다.

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)
  • toRowIndex : (Object) 이동시킬 곳의 행 인덱스

다음은 사용 예를 나타냅니다.

  // rowId 가 #Cust0 인 행을 0번 인덱스로 이동 시키기
  AUIGrid.moveRowToIndex(myGridID, "#Cust0", 3]); 

참고 : 트리 그리드(계층형 데이터)인 경우 해당 메소드는 무시됩니다.

openEditDownListLayer
Type : Method   Version: 3.0.12.0

사용자의 키 입력 또는 F2, 마우스 (더블) 클릭 등의 행위 없이 셀을 수정할 수 있게 현재 선택된 그리드의 셀에 편집기(Inputer)를 강제로 오픈합니다.

만약 달력이나 콤보박스 등과 같은 에디트렌더러(editRenderer)를 사용하는 경우 달력, 하단 리스트를 모두 오픈 시킵니다.

즉, 처음 진입 시 오픈 시킬 수 있는 모든 요소가 사용자에게 펼쳐진 채 셀 수정 진입 상태로 만듭니다.

Also See : openInputer

openFilterLayer
Type : Method   Version: 2.9.3

그리드 필터를 설정한 경우, 지정한 dataField 에 맞는 필터 레이어(필터 메뉴)를 오픈합니다.

만약, 동일한 칼럼의 필터 레이어(필터 메뉴)가 이미 열려진 경우, 이 메소드는 닫는 역할(즉, 토글 역할)을 하게 됩니다.

파라메터 설명

  • dataField (String) : 칼럼의 dataField 명
    // 이름 칼럼의 필터 레이어(필터 메뉴)를 오픈합니다.
    AUIGrid.openFilterLayer(myGridID, "name");

Also See : closeFilterLayer, isOpenFilterLayer | 관련 데모 보기

openInputer
Type : Method   Version: 2.7.0

사용자의 키 입력 또는 F2, 마우스 (더블) 클릭 등의 행위 없이 셀을 수정할 수 있게 현재 선택된 그리드의 셀에 편집기(Inputer)를 강제로 오픈합니다.

예로 달력, 콤보박스 등과 같은 에디트렌더러(editRenderer)를 사용하는 경우 해당 메소드는 달력이나 하단 리스트를 오픈시키지 않습니다. 사용자가 F2, 마우스 (더블) 클릭과 같이 최초 진입 상태로 만듭니다.

만약 달력이나 하단 리스트까지 오픈 시키려면 openEditDownListLayer 메소드를 사용하십시오.

Also See : openEditDownListLayer

outdentTreeDepth
Type : Method   Version: 2.7.0

편집 가능 상태인 경우 선택한 행을 내어 쓰기 하여 계층 구조로 만듭니다.

내어 쓰기 된 행은 부모 행(branch) 이 될 수가 있습니다.

그리드의 현재 상태가 정렬 또는 필터링 된 상태 그리고 그룹핑 된 상태에서는 사용 할 수 없습니다.

redo
Type : Method   Version: 2.7.0

편집 가능한 그리드에서 enableUndoRedo=true 설정한 경우, 다시 실행(Redo) 를 실행합니다.

Also See : undo | 관련 데모 보기

redoable
Type : Method   Version: 2.7.0

다시 실행(Redo) 이 가능한지 여부를 반환합니다.

Return : (Boolean) 다시 실행 가능 여부

Also See : undo, redo, undoable | 관련 데모 보기

refresh
Type : Method   Version: 2.7.0

그리드의 상태가 변경된 경우 이 메소드를 호출하여 실제 적용시킵니다.

그리드의 속성을 동적으로 변경한 후 그리드 상태가 시각적으로 변경되어야 할 때 이 메소드를 호출하십시오.

주의 : refresh 메소드는 속성 변경을 참조하여 DOM 을 재작성합니다.

단순 셀의 내용만 갱신하고자 한다면 update 메소드를 사용하십시오.

refresh 메소드를 불필요하게 자주 호출하지 마십시오. 성능에 영향을 미칩니다.

관련 데모 보기

refreshRows
Type : Method   Version: 2.7.0

그리드에 데이터를 삽입해 이미 출력된 모습에서 특정 행들 찾아 갱신(refresh)합니다.

예를 들어 변경된 데이터를 DB Select 할 수 있다면, 이 메소드를 통해 특정 행만 갱신할 수 있습니다.

기존에 출력된 데이터와 형식이 같아야만 유효합니다.

예를 들어 rowIdField 를 id 로 설정한 경우, id 가 20, 21, 30 인 행을 찾아 특정 셀만 업데이트 하고자 한다면 다음과 같습니다.

   var items = [ { id : 20, price : 2000, name : "A" },
                   { id : 21, price : 1000, name : "B" },
                   { id : 30, price : 4000, name : "C" }];
   AUIGrid.refreshRows(myGridID, items, "my-flash-style", 200); 

파라메터 설명

  • items (Array or Object) : 복수 또는 1개의 행을 갱신 합니다.
  • flashStyle (String) : 갱신 시 갱신된 셀이 깜빡이도록 표시해 주는 CSS 클래스명(스타일)을 지정합니다.
  • flashTime (Number) : flashStyle 이 출력되는 시간을 밀리세컨드 단위로 지정합니다. 예를 들어 이 값이 300 이라면 0.3 초 후 flashStyle 이 사라집니다.

기존 데이터 양이 수만행 이상이라면 전체 데이터 갱신(setGridData) 하는게 성능면에서 유리합니다.

참고 : refreshRows 메소드는 updateRowsById 메소드와 같은 기능을 합니다.(셀 수정 마커 표시 항상 false, 변경 셀에 깜빡이는 스타일 지정 가능이 다름)

Also See : updateRowsById

removeAjaxLoader
Type : Method   Version: 2.7.0

그리드에 표시된 프리로더가 있다면 삭제합니다.

관련 데모 보기

removeCheckedRows
Type : Method   Version: 2.7.0

체크박스 엑스트라 렌더러를 사용한 경우 체크박스에 체크된 행(들)을 그리드에서 삭제 처리 합니다.

removeColumn
Type : Method   Version: 3.0

그리드 열(column)을 삭제합니다.

파라메터 설명

  • columnIndex (Number or String) : 삭제하고자 하는 열의 인덱스, columnIndex 대신 "selectedIndex" 문자열을 설정한 경우 현재 선택된 열이 삭제됩니다.
  예1 : AUIGrid.removeColumn(myGridID, 5); // columnIndex 5 삭제
  예2 : AUIGrid.removeColumn(myGridID, "selectedIndex"); // 현재 선택된 열(들) 삭제
  예3 : AUIGrid.removeColumn(myGridID, [0,1,2]); // columnIndex 0, 1, 2 삭제(즉, 3개의 열 삭제)
removeInfoMessage
Type : Method   Version: 2.7.0

그리드에 메세지가 출력되었다면 제거합니다.

Also See : showInfoMessage | 관련 데모 보기

removeRow
Type : Method   Version: 2.7.0

그리드 행(row) 아이템을 삭제합니다.

파라메터 설명

  • rowIndex (Number or String) : 삭제하고자 하는 행의 인덱스, rowIndex 대신 "selectedIndex" 문자열을 설정한 경우 현재 선택된 행이 삭제됩니다.
  예1 : AUIGrid.removeRow(myGridID, 5); // rowIndex 5 삭제
  예2 : AUIGrid.removeRow(myGridID, "selectedIndex"); // 현재 선택된 행(들) 삭제
  예3 : AUIGrid.removeRow(myGridID, [0,1,2]); // rowIndex 0, 1, 2 삭제(즉, 3개의 행 삭제)

Also See : removeRowByRowId | 관련 데모 보기

removeRowByRowId
Type : Method   Version: 2.7.0

행 고유 값(rowIdField 값)을 통해 그리드 행(row) 아이템을 삭제합니다.

파라메터 설명

  • rowId (Array or String) : 삭제하고자 하는 행 고유 값(rowIdField 값). 만약 복수를 삭제하고자 할 때 rowId 값을 배열로 묶으십시오.

Also See : removeRow | 관련 데모 보기

removeSoftRows
Type : Method   Version: 2.7.0

그리드 삭제 모드가 소프트 삭제(softRemoveRowMode=true)인 경우 행을 삭제하면 삭제된 표시가 된 채로 그리드에 남아 있습니다.

그 표시된 삭제 행을 그리드에서 완전히 제거할 수 있는 메소드입니다.

파라메터 설명

  • rowIds (String or Array) : 삭제할 행의 rowId 값(들) (단수 또는 복수)

만약 파라메터인 rowIds 를 넣지 않으면 삭제 표시된 행 전체를 그리드에서 제거합니다.

참고 : 삭제 정보를 초기화 하는 메소드는 resetUpdatedItems 메소드입니다.

removeToastMessage
Type : Method   Version: 3.0.4

특정 셀에 출력된 메세지를 제거합니다.

Also See : showToastMessage | 관련 데모 보기

resetLazyStateByIndex
Type : Method   Version: 3.0.13

treeLazyMode 에서 하위(자식) 데이터를 이미 요청한 경우 해당 행의 요청 상태를 초기화 합니다.

기존 요청한 하위(자식) 데이터를 초기화(제거)하고 다시 요청할 수 있는 닫혀진 상태로 만듭니다.

따라서 다시 요청 아이콘 클릭하면 treeLazyRequest 이벤트가 발생합니다.

resetUpdatedColumns
Type : Method   Version: 3.0

그리드의 열(column) 을 추가, 삭제했을 때 해당 데이터필드(dataField)를 그리드가 캐시에 보관합니다.

이 보관된 데이터필드(dataField)를 모두 초기화하여 그리드 열이 수정되지 않은 상태로 만듭니다.

파라메터 설명

  • option (String) : 추가, 삭제된 해당 캐시를 초기화 할 옵션을 지정합니다. 유효 값은 "c", "d", "a" 입니다.

    "c" : 추가된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "d" : 삭제된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "a" : 추가, 삭제 모두 흔적을 제거하고 초기화 시킵니다. (기본값)

resetUpdatedItemById
Type : Method   Version: 3.0.6

편집모드에서 그리드의 데이터를 추가, 수정, 삭제했을 때 특정 행의 추가, 수정, 삭제된 상태를 초기화 합니다.

그러나 그리드 속성 softRemoveRowMode 를 false 설정한 경우 삭제 상태는 초기화 할 수 없습니다.

파라메터 설명

  • rowId (String) : 상태를 초기화 할 행의 rowId 값
  • option (String) : 추가, 수정, 삭제된 해당 데이터 캐시를 초기화 할 옵션을 지정합니다. 유효 값은 "c", "u"("e"), "d", "a" 입니다.

    "c" : 추가된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "u"(or "e") : 수정된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "d" : 삭제된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "a" : 추가, 수정, 삭제 모두 흔적을 제거하고 초기화 시킵니다. (기본값)

참고 : resetUpdatedItems 메소드는 전체 행을 대상으로 상태를 초기화합니다.

관련 데모 보기

resetUpdatedItems
Type : Method   Version: 2.7.0

편집모드에서 그리드의 데이터를 추가, 수정, 삭제했을 때 해당 데이터를 그리드가 캐시에 보관합니다.

이 보관된 데이터를 모두 초기화 하여 그리드가 수정되지 않은 상태로 만듭니다.

대상은 전체 데이터를 대상으로 합니다.

예를 들어 그리드에 추가, 수정, 삭제된 데이터를 DB에 모두 저장 했을 때 유용할 수 있습니다.

파라메터 설명

  • option (String) : 추가, 수정, 삭제된 해당 데이터 캐시를 초기화 할 옵션을 지정합니다. 유효 값은 "c", "u"("e"), "d", "a" 입니다.

    "c" : 추가된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "u"(or "e") : 수정된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "d" : 삭제된 데이터만 흔적을 제거하고 초기화 시킵니다.

    "a" : 추가, 수정, 삭제 모두 흔적을 제거하고 초기화 시킵니다. (기본값)

참고 : resetUpdatedItemById 메소드는 지정한 단일 행을 대상으로 상태를 초기화합니다.

관련 데모 보기

resize
Type : Method   Version: 2.7.0

그리드의 크기를 변경합니다.

파라메터 설명

  • width (Number) : 변경시키고자 하는 가로 사이즈
  • height (Number) : 변경시키고자 하는 세로 사이즈

만약 파라메터 없이 resize 메소드 호출 시 부모 Div의 크기를 다시 계산하여 그에 맞게 사이즈를 변경합니다.

부모(조상) Div 가 보이지 않는 상태(display : none)인 경우 부모 Div 의 크기를 알 수 없습니다. 이런 경우 그리드는 기본 크기로 변경 시킵니다.

따라서 파라메터 없이 resize 메소드 호출 시는 반드시 부모 Div 가 DOM 영역에서 보여졌을 때 호출해야 합니다.

관련 데모 보기

restoreEditedCells
Type : Method   Version: 2.7.0

그리드의 셀을 수정한 해당 셀 값을 수정 취소(복구) 합니다.

수정 취소(복구)는 최초 그리드에 삽입된 셀의 값으로 되돌립니다.

파라메터 설명

  • cells (Array or String) : 행인덱스와 dataField 를 각각 0, 1 요소로 갖는 배열, "selectedIndex" 문자열을 설정한 경우 현재 선택된 셀들이 복구됩니다
   // 현재 선택된 셀들 전체 수정 취소(복구)
   AUIGrid.restoreEditedCells(myGridID, "selectedIndex");
    // 행인덱스 5 의 dataField="country" 인 셀의 값을 수정 취소(복구)
   AUIGrid.restoreEditedCells(myGridID, [5, "country"] );
 
   // 복수의 셀 값들 지정 예제
   AUIGrid.restoreEditedCells(myGridID, [[2, "country"], [3, "country"], [3, "product"]] );
restoreEditedRows
Type : Method   Version: 2.7.0

그리드의 행을 수정한 해당 행 전체 셀 값을 수정 취소(복구) 합니다.

수정 취소(복구)는 최초 그리드에 삽입된 행의 셀 값들로 되돌립니다.

파라메터 설명

  • rowIndex (Number(Array) or String) : 삭제하고자 하는 행의 인덱스, rowIndex 대신 "selectedIndex" 문자열을 설정한 경우 현재 선택된 행이 복구됩니다.
  // 현재 선택된 행을 수정 취소(복구)
  AUIGrid.restoreEditedRows(myGridID, "selectedIndex");
 
  // 행인덱스 5의 행을 수정 취소(복구)
  AUIGrid.restoreEditedRows(myGridID, 5);
 
  // 행인덱스 5,6,7 의 복수 행을 수정 취소(복구)
  AUIGrid.restoreEditedRows(myGridID, [5, 6, 7]);
restoreSoftRows
Type : Method   Version: 2.7.0

그리드 삭제 모드가 소프트 삭제(softRemoveRowMode=true)인 경우 행을 삭제하면 삭제된 표시가 된 채로 그리드에 남아 있습니다.

그 표시된 삭제 행을 복원 할 수 있는 메소드입니다.(삭제 취소)

이 메소드로 복원된 행은 더 이상 삭제 아이템이 아니게 되며, 기존 상태로 복구됩니다.

기존 상태의 의미는 이 행이 사용자에 의해 추가되었다면 추가 아이템, 이 행이 삭제 되기 전 변경 되었다면 수정 아이템이 됩니다.

파라메터 설명

  • option (Number(Array) or String) : 복구할 대상을 지정할 수 있는 옵션. 유효 값은 "selectedIndex", "all", rowIndex 입니다.
    • "selectedIndex" : 현재 선택되어 있는 행을 복구 합니다.(선택된 행이 삭제 표시된(softRemoveRow) 아이템이여야 함)
    • "all" : 그리드의 모든 삭제 표시된 행을 복구합니다.
    • rowIndex : 지정된 행 인덱스(들)의 삭제 표시된 행(들)을 복구합니다.(Number or Array)
  // 현재 선택된 행 소프트 삭제 복구
  AUIGrid.restoreSoftRows(myGridID, "selectedIndex");
 
  // 그리드 모든 소프트 삭제 행들 복구 
  AUIGrid.restoreSoftRows(myGridID, "all");
   // 행인덱스 5 소프트 삭제 복구 
  AUIGrid.restoreSoftRows(myGridID, 5);
  
  // 행인덱스 5,6,7 소프트 삭제 복구
  AUIGrid.restoreSoftRows(myGridID, [5, 6, 7]);
rowIdToIndex
Type : Method   Version: 2.7.0

행 고유 값을 통해 행 인덱스(rowIndex)를 반환합니다

파라메터 설명

  • rowId : (String) 행 고유 값(rowIdField 값)

Return : rowIndex : (Number) 행 인덱스

Also See : indexToRowId

searchAll
Type : Method   Version: 2.13.0

그리드의 전체 칼럼을 대상으로 문자열을 검색합니다.

이 메소드는 트리그리드 또는 그룹핑이 설정된 상태에서는 무시됩니다.

즉, 트리그리드 및 그룹핑이 설정된 상태에서는 사용할 수 없습니다.

파라메터 설명

  • term : (String) 검색하고자 하는 문자열
  • options : (Object) 검색 옵션

검색 옵션(options) 은 다음과 같은 필드를 갖습니다.

  • direction (기본값 : true) : 검색 방향 (true : 다음, false : 이전 검색)
  • caseSensitive (기본값 : false) : 대소문자 구분 여부 (true : 대소문자 구별, false : 무시)
  • wholeWord (기본값 : false) : 온전한 단어 여부
  • wrapSearch (기본값 : true) : 끝에서 되돌리기 여부
 // 그리드 전체 칼럼에서 "a" 찾기
 //options 를 지정하지 않으면 기본값이 적용됨(기본값은 direction : true, wrapSearch : true)
 AUIGrid.searchAll(myGridID, "a");
selectRowsByRowId
Type : Method   Version: 2.7.0

선택 모드(selectionMode)가 "none" 이 아닌 경우 특정 행 아이템들을 선택하도록 지시합니다.

행 아이템을 선택할 때 rowId 로 지정합니다.

파라메터 설명

  • rowIds : (Array 또는 String) 선택하고자 하는 행 고유 값(rowIdField 값)들

관련 데모 보기

setAllCheckedRows
Type : Method   Version: 2.7.0

엑스트라 체크박스(showRowCheckColumn=true 로 나오는 체크박스)가 설정된 경우 모든 체크박스를 true, 또는 false 로 설정합니다.

파라메터 설명

  • checked : (Boolean) true 또는 false, true인 경우 전체 선택, false 인 경우 전체 해제

관련 데모 보기

setCellMerge
Type : Method   Version: 2.7.0

셀 병합(cell merge) 를 활성화시키거나 비활성화 시킵니다.

파라메터 설명

  • flag (Boolean) : true 인 경우 셀 병합 활성화, false 인 경우 비활성화

관련 데모 보기

setCellValue
Type : Method   Version: 2.8.0

그리드의 특정 셀의 값을 변경합니다.

파라메터 설명

  • rowIndex (Number) : 변경하고자 하는 행 인덱스
  • dataField or columnIndex(String or Number) : 변경하고자 하는 칼럼의 dataField 또는 칼럼 인덱스
  • value (Object) : 변경하고자 하는 값
   // 0번째 행의 name 칼럼의 값을 "이름 고침" 으로 변경
   AUIGrid.setCellValue(myGridID, 0, "name", "이름 고침");
  
   // 3번째 행의 1 번째 칼럼 즉, (3, 1) 의 셀의 값을 "이름 고침" 으로 변경
   AUIGrid.setCellVAlue(myGridID, 3, 1, "이름 고침");

절대 반복문법(for, while 등) 안에서 이 메소드를 사용하지 마십시오.

다수의 셀 값을 변경하고자 하는 경우 updateRow, updateRows, updateRowsById 메소드를 사용하십시오.

Also See : updateRow, updateRows, updateRowsById, getCellValue | 관련 데모 보기

setCheckedRowsByIds
Type : Method   Version: 2.7.0

엑스트라 행 체크박스가 설정된 경우행 고유 값(rowIdField 값)을 이용해 특정 행에 체크를 설정합니다.

이 메소드는 기존에 체크된 항목이 제거되고 새로 설정된 값으로만 체크됩니다.

파라메터 설명

  • rowIds : (Array) 행 고유 값(rowIdField 값)들을 요소로 갖는 배열

참고 : 기존 체크 항목에 누적해서 체크를 넣고자 한다면 addCheckedRowsByIds 메소드를 사용하십시오.

관련 데모 보기

setCheckedRowsByValue
Type : Method   Version: 2.7.0

엑스트라 행 체크박스가 설정된 경우 특정 행의 dataField 의 값과 일치하는 행에 체크를 표시합니다.

이 메소드는 기존에 체크된 항목이 제거되고 새로 설정된 값으로만 체크됩니다.

예를 들어 이름(name) 이 "Anna" 라는 사람만을 체크하고자 한다면 다음과 같습니다.

AUIGrid.setCheckedRowsByValue(myGridID, "name", "Anna");

파라메터 설명

  • dataField : (String) 행 아이템에서 체크하고자 하는 필드명
  • values : (Array or String) 행 아이템에서 체크하고자 하는 필드의 값(value), 복수의 값을 체크하고자 한다면 배열로 설정(예: ["Anna", "Steve"])

참고 : 기존 체크 항목에 누적해서 체크를 넣고자 한다면 addCheckedRowsByValue 메소드를 사용하십시오.

관련 데모 보기

setColumnChildOrder
Type : Method   Version: 2.8.0

그룹 칼럼의 자식들의 위치 순서를 지정하여 그리드를 출력하도록 합니다.

파라메터 설명

  • dataFields (Array) : 그룹 칼럼의 자식의 순서를 표현하는 dataField 값들
    // c1, c2, c3 를 dataField 로 갖는 칼럼이 Group 으로 되어 있는 경우, 순서를 c3, c1, c2 로 출력 시킴.
    AUIGrid.setColumnChildOrder(myGridID, ["c3", "c1", "c2"]);
  
    // 그룹 칼럼의 자식들 중 c2를 자식들 중 처음으로 위치시킴.
    AUIGrid.setColumnChildOrder(myGridID, ["c2"] );
setColumnOrder
Type : Method   Version: 2.8.0

칼럼의 위치 순서를 지정하여 그리드를 출력하도록 합니다.

파라메터 설명

  • dataFields (Array) : 칼럼의 순서를 표현하는 dataField 값들
    // 칼럼의 순서를 차례로 Counry, Name, Price, Date 순으로 출력시킴.
    AUIGrid.setColumnOrder(myGridID, ["country", "name", "price", "date"]);
  
    // 칼럼의 순서를 Date 를 맨 앞으로 출력하고, 나머지 칼럼은 기존 순서 유지 시킴.
    AUIGrid.setColumnOrder(myGridID, ["date"] );
setColumnProp
Type : Method   Version: 2.7.0

최초 설정한 칼럼 레이아웃의 columnIndex 에 맞는 칼럼의 속성을 변경합니다.

파라메터 설명

  • columnIndex (Number) : 변경하고자 하는 칼럼 인덱스
  • propObj (Object) : 변경하고자 하는 칼럼의 속성명과 값을 갖는 Object

예를 들어 1 번째 칼럼의 헤더 텍스트(headerText) 와 넓이(width) 를 변경하고자 한다면 다음과 같습니다.

  // 인덱스 1번째 칼럼의 헤더 명과 넓이를 각각 "헤더 텍스트 변경", 100 으로 변경
  AUIGrid.setColumnProp( myGridID, 1, { headerText : "헤더 텍스트 변경", width : 100 } );

참고 : setColumnProp 으로 renderer, children 등 DOM 이 변경되는 속성의 설정을 바꿀 수는 없습니다. 이런 경우는 destroy 후 다시 새로운 칼럼 레이아웃으로 create 하십시오.

관련 데모 보기

setColumnPropByDataField
Type : Method   Version: 2.10.0

최초 설정한 칼럼 레이아웃의 데이터필드(dataField)에 맞는 칼럼의 속성을 변경합니다.

파라메터 설명

  • dataField (String) : 변경하고자 하는 칼럼의 데이터필드명
  • propObj (Object) : 변경하고자 하는 칼럼의 속성명과 값을 갖는 Object

예를 들어 "name" 칼럼의 헤더 텍스트(headerText) 와 넓이(width) 를 변경하고자 한다면 다음과 같습니다.

  // "name" 칼럼의 헤더 명과 넓이를 각각 "헤더 텍스트 변경", 100 으로 변경
  AUIGrid.setColumnPropByDataField( myGridID, "name", { headerText : "헤더 텍스트 변경", width : 100 } );
  
  // "myGroupHeader" 를 dataField 로 갖는 그룹 헤더의 헤더 텍스트 변경
  AUIGrid.setColumnPropByDataField( myGridID, "myGroupHeader", { headerText : "그룹 헤더 텍스트 변경" } );

참고 : setColumnPropByDataField 으로 renderer, children 등 DOM 이 변경되는 속성의 설정을 바꿀 수는 없습니다. 이런 경우는 destroy 후 다시 새로운 칼럼 레이아웃으로 create 하십시오.

관련 데모 보기

setColumnSizeList
Type : Method   Version: 2.7.0

그리드 칼럼의 가로 크기(width size)를 지정할 수 있습니다.

파라메터 설명

  • sizeList : (Array) 변경할 가로 사이즈들

다음은 사용 예를 나타냅니다.

  // 그리드의 칼럼 사이즈들을 강제로 지정합니다.
  AUIGrid.setColumnSizeList(myGridID, [100, 100, 100, 100, 100, 100, 100, 100, 100]);
  
  // 만약 특정 인덱스의 사이즈는 유지하고 싶다면 다음처럼 null 삽입
  AUIGrid.setColumnSizeList(myGridID, [100, 100, null, null, 100, 100, 100, 100]);
  
  // 0, 1번째 칼럼만 100, 100으로 지정합니다. 나머지 칼럼은 기존 유지
  AUIGrid.setColumnSizeList(myGridID, [100, 100]);
setCsvGridData
Type : Method   Version: 2.7.0

그리드 데이터를 CSV로 설정합니다.

파라메터 설명

  • csvData (String) : 그리드가 표현할 CSV 데이터
  • isSimpleMode (Boolean) : 단순 컴마 구분자로 CSV 가 있는지 여부. 만약 컴마 구분자가 데이터의 값으로 존재한다면 이 속성을 false 로 처리하십시오.

Also See : setGridData, setXmlGridData | 관련 데모 보기

setEditingInputValue
Type : Method   Version: 2.7.0

편집모드(editable=true)인 경우 해당 input 의 값을 설정합니다.

이 값 설정은 (더블)클릭 또는 F2 키 등과 같이 편집 진입한 상태인 경우에만 유효합니다.

사용자 정의 편집 렌더러(customEditRenderer) 를 사용했을 때 편집 렌더러의 값에 따라 그리드의 input 값을 이 메소드를 통해 동적으로 변경 가능합니다.

파라메터 설명

  • value (Object) : 설정하고자 하는 값
setFilter
Type : Method   Version: 2.7.0

필터링을 설정하고 실행합니다.

enableFilter 속성이 true 설정되어야 가능합니다.

파라메터 설명

  • dataField (String) : 칼럼이 출력하고 있는 데이터의 필드명
  • filterFunction (Function) : 필터링 비교 함수

    사용 예는 다음과 같습니다.

     // dataField : 칼럼이 출력하고 있는 데이터의 필드명
     // value : 행의 dataField 에 맞는 값.
     // item : 행 전체 아이템
     AUIGrid.setFilter(myGridID, "name",  function(dataField, value, item) {
          return value > 10 ? true : false; // 10 보다 큰 값만 출력 
     });
setFilterByValues
Type : Method   Version: 2.9.1

칼럼의 값(들)만을 이용하여 필터링하고 실행합니다.

enableFilter 속성이 true 설정되어야 가능합니다.

파라메터 설명

  • dataField (String) : 칼럼이 출력하고 있는 데이터의 필드명
  • values (String or Array) : 해당 dataField 에서 필터링하고자 하는 값(들)

이 메소드의 사용예는 다음과 같습니다.

 // 이름의 값이 Anna, Emma 만 필터링 하기
 AUIGrid.setFilterByValues(myGridID, "name",  ["Anna", "Emma"]);

참고 : 정규식 및 비교 문(if) 등으로 필터링을 결정하고자 한다면 setFilter 메소드를 사용하십시오.

setFilterCache
Type : Method   Version: 3.0.11.9

필터링된 일괄 정보를 통하여 그리드를 필터링 상태로 만듭니다.

이 메소드는 일반적으로 getFilterCache 메소드와 같이 사용 합니다.

파라메터 설명

  • cache (Object) : 필터링 필드와 현재 필터링 된 값들에 대한 정보
  // 필터링 정보 얻기
  var filterCache = AUIGrid.getFilterCache(myGridID);
  // var filterCache = {"country" : ["네덜랜드","미국"], "quantity" : ["3"]};
  
  // 필터링된 일괄 정보를 통하여 그리드를 필터링 실행하기.
  AUIGrid.setFilterCache(myGridID, filterCache);

Also See : getFilterCache

setFilterInlineTexts
Type : Method   Version: 3.0.11.9

인라인 필터 행을 표시하여 필터링 할 수 있는 경우 해당 텍스트들(input 의 값들)을 설정하여 그리드를 필터링 상태로 만듭니다.

이 메소드는 일반적으로 getFilterInlineTexts 메소드와 같이 사용 합니다.

파라메터 설명

  • inlineTexts (Array) : 인라인 필터의 텍스트들 정보
  // 인라인 필터의 텍스트들 얻기.
  var inlineTexts = AUIGrid.getFilterInlineTexts(myGridID);
  // var inlieTexts = [{dataField : "name", text : "a" }, {dataField : "country", text : "대한"}];
  
  // 인라인 필터링 텍스트들 설정 시켜 필터링 실행하기.
  AUIGrid.setFilterInlineTexts(myGridID, inlineTexts);

Also See : getFilterInlineTexts | 관련 데모 보기

setFixedColumnCount
Type : Method   Version: 2.7.0

스크롤에 영향을 받지 않는 고정칼럼(FixedColumn)을 주어진 개수만큼 지정합니다.

0 인 경우 지정된 고정칼럼이 해제됩니다.

파라메터 설명

  • count : (Number) 고정칼럼(FixedColumn) 실행시킬 개수

관련 데모 보기

setFixedRowCount
Type : Method   Version: 2.7.0

스크롤에 영향을 받지 않는 고정행(FixedRow)을 주어진 개수만큼 지정합니다.

0 인 경우 지정된 고정행이 해제됩니다.

파라메터 설명

  • count : (Number) 고정행(FixedRow) 실행시킬 개수

관련 데모 보기

setFocus
Type : Method   Version: 2.7.0

그리드에 키보드 포커싱이 되도록 지정합니다.

그리드의 속성인 enableFocus 를 false 로 설정했다면, setFocus 메소드 호출은 의미가 없습니다.

setFooter
Type : Method   Version: 2.7.0

그리드의 푸터(footer) 출력을 위해 푸터 레이아웃을 설정합니다.

푸터 레이아웃 작성에 대한 자세한 사항은 푸터(Footer) 레이아웃 작성에 대하여 를 참고하십시오.

파라메터 설명

  • footerLayout (Array) : 푸터 출력을 위한 푸터 설정 레이아웃

관련 데모 보기

setGridData
Type : Method   Version: 2.7.0

그리드 데이터를 설정합니다. 그리드 데이터는 반드시 배열요소가 Object 인 배열(Array) 여야 합니다.

만약 XML 을 데이터로 사용하고자 하는 경우 setXmlGridData() 를, CSV 데이터를 사용하고자 한다면 setCsvGridData()를 사용하십시오.

파라메터 설명

  • data (Array) : 그리드가 표현할 데이터 배열

Also See : setXmlGridData, setCsvGridData | 관련 데모 보기

setGroupBy
Type : Method   Version: 2.7.0

특정 데이터 필드로 그룹핑을 실행합니다.

그룹핑 실행 시 소계 정보를 다시 설정할 수 있습니다. 소계 정보를 재설정하고자 한다면 groupingSummary 를 작성하십시오.

groupingSummary 작성은 그리드 속성인 groupingSummary 을 참고하여 작성하십시오.

파라메터 설명

  • groupingFields (Array) : 그룹핑을 하고자 하는 필드명을 요소로 갖는 배열
  • groupingSummary (Object) : 그룹핑 시 소계를 출력하고자 하는 경우, 소계 정보 객체

사용 예는 다음과 같습니다.

  // Country, Product 순으로 그룹핑을 하고자 하는 경우 다음과 같습니다.
  AUIGrid.setGroupBy(myGridID, ["country", "product"] );
  
  // Country 로 그룹핑하고, Price 에 대하여 소계를 출력함. 단, 소계명은 "가격 합계" 로 출력 시킴
  AUIGrid.setGroupBy(myGridID,  ["country"], {
          dataFields : [ "price" ],
          labelTexts : ["가격 합계"]
  });

See Also : groupingSummary | 관련 데모 보기

setHeaderRendererProp
Type : Method   Version: 3.0.4

최초 설정한 칼럼 레이아웃의 columnIndex 에 맞는 칼럼의 headerRenderer 속성을 변경합니다.

파라메터 설명

  • columnIndex (Number) : 변경하고자 하는 칼럼 인덱스
  • propObj (Object) : 변경하고자 하는 헤더렌더러(headerRenderer)의 속성명과 값을 갖는 Object

예를 들어 1번째 칼럼의 headerRenderer 를 다음처럼 CheckBoxHeaderRenderer 로 정의한 경우 속성 변경이 가능합니다.

   dataField : "field2",
   headerRenderer : { // 헤더 렌더러
       type : "CheckBoxHeaderRenderer",
       checked : true, // 최초 체크 여부
    }
    
  // 인덱스 1번째 칼럼의 헤더 체크박스 렌더러의 checked 속성 변경
   AUIGrid.setHeaderRendererProp(myGridID, 1, {"checked" : false} );

참고 : setHeaderRendererProp 으로 headerRenderer 의 기본인 type 설정을 바꿀 수는 없습니다.

setHoverMode
Type : Method   Version: 3.0.13

마우스 오버(hoverMode)를 변경합니다.

파라메터 설명

  • hoverMode (String) : 설정하고자 하는 hoverMode(유효값 : "singleCell", "singleRow", "none")
setHScrollPosition
Type : Method   Version: 2.7.0

수평 스크롤이 생성되어 있을 때 수평 스크롤을 칼럼 인덱스 단위로 이동 시킬 수 있는 메소드입니다.

파라메터 설명

  • columnIndex (Number) : 수평 스크롤의 시작점이 될 칼럼의 인덱스
setHScrollPositionByPx
Type : Method   Version: 2.7.0

수평 스크롤이 생성되어 있을 때 수평 스크롤을 픽셀 단위로 이동 시킬 수 있는 메소드입니다.

파라메터 설명

  • pixel (Number) : 수평 스크롤이 이동할 픽셀 단위의 값
setInfoMessage
Type : Method   Version: 2.7.0

[deprecated Ver 3.0.4]

Also See : showInfoMessage

setPageRowCount
Type : Method   Version: 3.0.5

페이징을 사용하는 경우 1 페이지에 출력되는 행의 개수를 변경합니다.

파라메터 설명

  • pageRowCount : (Number) 1 페이지에 출력 시킬 행의 개수
setProp
Type : Method   Version: 2.7.0

그리드의 속성을 변경합니다.

최초 그리드를 생성할 때 속성을 설정하나 경우에 따라 이 속성을 동적으로 변경해야 할 때가 있습니다.

이런 경우 이 메소드를 통해 속성을 변경하십시오.

파라메터 설명

  • props (Object) : 복수인 경우 속성명과 속성값이 각각 key-value 를 이루는 object, 1개의 속성인 경우 속성명
  • value (Object) : 1개의 속성 값 변경을 위한 파라메터로 1개의 속성의 새로운 값에 해당됩니다.(복수인 경우 의미없음)

그리드 수정을 토글하고자 할 때 editable 속성을 다음과 같이 변경할 수 있습니다.

AUIGrid.setProp(myGridID, "editable" , true ); 

복수의 속성을 일괄적으로 변경하고자 하는 경우는 다음과 같습니다.

AUIGrid.setProp(myGridID, { "editable" : true, "editBeginMode" : "click" } ); 

모든 속성을 이 메소드로 변경할 수 없습니다. 다음은 변경 가능한 속성 리스트입니다.

칼럼 레이아웃이나 푸터등 큰 변화가 있는 경우 destroy() 후 create() 하십시오.

blankNumericToNullOnEditing 수정 적용 시 numeric 칼럼의 빈값을 null 로 수정 완료 처리할 지 여부
blankToNullOnEditing 수정 적용 시 빈 값을 null 로 수정 완료 처리할 지 여부
copyDisplayValue 복사할 때 포매팅 데이터 복사 여부
contextMenuItems 컨텍스트 메뉴 아이템 사용자 정의 할 수 있는 속성
dropToOthers 행 드래깅 하였을 때 드랍이 가능한 그리드가 자신이 아닌 다른 곳에 있는지 여부
editable 수정 가능여부
enableDrag 행 드래깅 가능 여부
enableDrop 행 드랍 가능 여부
editableOnFixedCell 고정 칼럼, 행 지정된 셀 수정 가능여부
editBeginMode수정 시작모드
editingOnKeyDown바로 키입력으로 수정 가능 여부
enableColumnResize칼럼 크기 조절 가능 여부
enableHScrollByWheel수평 스크롤에 대한 마우스 휠 활성화 여부
enableMouseWheel마우스 휠 활성화 여부
enableMovingColumn칼럼 순서 바꾸기 가능 여부
enableSorting정렬 가능 여부
enterKeyColumnBase엔터키가 다음 칼럼으로 이동할지 여부
exportURL엑셀, CSV 등 내보내기 서버 사이드 경로
filterMenuItemMaxCount필터 메뉴 체크박스 출력 최대 개수
filterItemMoreMessage실제 필터 가능한 값보다 많을 경우 출력할 메세지
isColumnOrientedHome, End 키가 칼럼 중심인지 여부
keepEditing에디팅 완료 후 계속 에디팅 상태 유지 여부
minColumnWidth최소 칼럼 사이즈
multiSortingKey다중 정렬키 지정
noDataMessage출력할 데이터 없을 경우 출력 될 메세지
pagingBottomGap페이징 수직 스크롤에 추가될 여분 값
rowStyleFunction행 스타일 함수 지정
showAutoNoDataMessage출력할 데이터가 없을 경우 자동 출력 여부
skipReadonlyColumns읽기 전용 칼럼 설정한 경우 키보드로 셀렉션 이동 가능 여부
skipUneditableOnPaste붙여넣기 할 때 수정 불가능한 셀은 값 자체를 무시할지 여부
sortableByFormatValue정렬을 할 때 데이터 기반이 아닌 그리드에 출력된 값을 기반으로 정렬을 실행할지 여부
sortingSequence정렬의 순서를 지정
treeOpenRecursivly트리 열기 할 때 자손까지 열지 여부
triggerSelectionChangeOnCell행 선택 모드에서 옆으로 칼럼 변경할 시 selectionChange 이벤트 발생 여부
useGroupingPanel그룹핑 패널 사용 여부

Also See : getProp | 관련 데모 보기

setRendererProp
Type : Method   Version: 2.7.0

최초 설정한 칼럼 레이아웃의 columnIndex 에 맞는 칼럼의 renderer 속성을 변경합니다.

renderer 속성의 기본인 type 을 제외한 속성을 변경할 수 있습니다.

파라메터 설명

  • columnIndex (Number) : 변경하고자 하는 칼럼 인덱스
  • propObj (Object) : 변경하고자 하는 렌더러(renderer)의 속성명과 값을 갖는 Object

예를 들어 1번째 칼럼의 renderer 를 다음처럼 BarRenderer 로 정의한 경우 BarRenderer 의 세부 속성 변경이 가능합니다.

   dataField : "field2",
   headerText : "-100 ~ 100 범위",
   renderer : {
   type : "BarRenderer",
         min : -100,
         max : 100
   }
   
  // 인덱스 1번째 칼럼의 renderer 인 BarRenderer 의 min, max 속성 변경
  AUIGrid.setRendererProp( myGridID, 1, { min : 0, max : 150 } );

참고 : setRendererProp 으로 renderer 의 기본인 type 설정을 바꿀 수는 없습니다. type 설정을 변경하고자 한다면, 전체 그리드를 destroy 후 다시 create 하여 새로운 칼럼 레이아웃으로 그리드를 재생성 하십시오.

관련 데모 보기

setRowPosition
Type : Method   Version: 2.7.0

수직 스크롤이 생긴 경우 해당 rowIndex 에 해당하는 행을 그리드 최상단에 보이도록 지정합니다.

페이징 모드(usePaging=true)인 경우 최상단이 아닌 해당 행이 현재 화면에 없는 경우 보이도록 이동 합니다.

파라메터 설명

  • rowPosition (Number) : 그리드 상단으로 위치할 rowIndex
setScaleFactor
Type : Method   Version: 3.0.7.7

그리드 상위 태그의 좌표 공간이 변형(transform)된 경우 그리드에 일관된 좌표 공간이 되도록 동일한 scale 값을 설정합니다.

파라메터 설명

  • scaleFactor (Number) : transform 에 적용될 값

See Also : scaleFactor

setSelectionBlock
Type : Method   Version: 2.7.0

그리드의 셀에 선택 블록(selection block) 을 강제로 지정합니다.

이 메소드는 selectionMode 를 "multipleCells" 로 설정했을 때 사용자의 의도대로 출력됩니다.

만약 "multipleCells" 가 아닌 다른 값이라면 해당 속성값에 맞게 선택이 자동 변경되어 지정됩니다.

파라메터 설명

  • startRowIndex (Number) : 블록을 만들 시작 행 인덱스
  • endRowIndex (Number) : 블록을 만들 종료 행 인덱스
  • startColumnIndex (Number) : 블록을 만들 시작 칼럼 인덱스
  • endColumnIndex (Number) : 블록을 만들 종료 칼럼 인덱스
  // (1,1) 셀에서 시작하여 (4,4) 셀에서 끝나는 선택 블록 지정하기
  AUIGrid.setSelectionBlock(myGridID, 1, 4, 1, 4);
setSelectionByIndex
Type : Method   Version: 2.7.0

선택 모드(selectionMode)가 "none" 이 아닌 경우 특정 아이템을 선택하도록 지시합니다.

만약 columnIndex 를 생략하면 행을 선택합니다.

파라메터 설명

  • rowIndex : (Number) 선택하고자 하는 행 인덱스
  • columnIndex : (Number) 선택하고자 하는 칼럼 인덱스

관련 데모 보기

setSelectionMode
Type : Method   Version: 2.7.0

선택 모드(selectionMode) 를 변경합니다.

파라메터 설명

  • selectionMode (String) : 설정하고자 하는 selectionMode(유효값 : "singleCell", "singleRow", "multipleCells", "multipleRows", "none")
setSorting
Type : Method   Version: 2.7.0

정렬(Sorting)을 설정하고 실행합니다.

파라메터 설명

  • sortingInfo (Array) : 정렬 실행 시킬 정보를 담은 배열
    정보를 담은 배열의 요소는 Object 로 다음 요소를 갖습니다.
    • dataField (String) : 정렬을 실행 시킬 데이터 필드명
    • sortType (Number) : 오름차순인 경우 1, 내림차순인 경우 -1
  • onlyLastDepthSorting (Boolean) : 트리 그리드 인 경우 최하단 깊이(depth) 만 정렬 실행할 지 여부, 기본적으로 그리드의 onlyTreeLastDepthSorting 속성을 따름.

예를 들어 차례로 Country, Name, Price 에 대하여 각각 오름차순, 내림차순, 오름차순 지정하고자 한다면 다음과 같이 설정하십시오.

 var sortingInfo = [];
 // 차례로 Country, Name, Price 에 대하여 각각 오름차순, 내림차순, 오름차순 지정.
 sortingInfo[0] = { dataField : "country", sortType : 1 }; // 오름차순 1
 sortingInfo[1] = { dataField : "name", sortType : -1 }; // 내림 차순 -1
 sortingInfo[2] = { dataField : "price", sortType : 1 };
 AUIGrid.setSorting(myGridID, sortingInfo);

위와 같이 원하는 개수만큼 다중 정렬 및 단일 정렬 sortingInfo 배열을 만들어 setSorting 파라메터로 지정하십시오.

setXmlGridData
Type : Method   Version: 2.7.0

그리드 데이터를 XML로 설정합니다.

파라메터 설명

  • xmlData (Object) : 그리드가 표현할 XML 데이터
  • tagName (String) : XML 에서 개별 행(row)을 구성하는 태그명을 지정합니다. 예를 들어 "<item><col1>1</col1><col2>2</col2></item>" 과 같이 구성된 XML 인 경우 tagName 으로 "item" 을 지정하십시오.(기본값:"row")

Also See : setGridData, setCsvGridData | 관련 데모 보기

showAjaxLoader
Type : Method   Version: 2.7.0

그리드에 프리로더를 표시합니다.

관련 데모 보기

showAllColumns
Type : Method   Version: 2.7.0

그리드 칼럼을 숨기기 한 경우, 원래 설정한 칼럼 모두를 보이는 상태로 만듭니다.

Also See : showColumnByDataField, hideColumnByDataField

showColumnByDataField
Type : Method   Version: 2.7.0

주어진 파라메터(dataField)에 맞게 출력된 그리드 칼럼을 보이도록 지정합니다.

복수의 칼럼을 보이도록 지정하고자 한다면 배열로 설정하십시오. (예: ["name", "country", "product"] )

파라메터 설명

  • dataField (String or Array) : 칼럼의 데이터 필드명(들)

Also See : hideColumnByDataField | 관련 데모 보기

showColumnGroup
Type : Method   Version: 3.0.10.0

헤더를 계층형(그룹형)으로 설정한 경우 그룹(브랜치)에 해당되는 칼럼에 속한 모든 칼럼(자손 칼럼들)을 보이도록 지정합니다.

파라메터 설명

  • dataField (String) : 칼럼의 데이터 필드명

Also See : hideColumnGroup | 관련 데모 보기

showFooterLater
Type : Method   Version: 3.0.11.9

그리드 생성 시 푸터 출력을 하지 않은 경우 이미 출력된 그리드에서 푸터를 표시하게 합니다.

Also See : hideFooterLater

showInfoMessage
Type : Method   Version: 3.0.4

그리드에 메세지를 출력시킵니다.

파라메터 설명

  • msgHTML (String) : 그리드에 표시될 메세지를 포함한 HTML 구문입니다.

만약 데이터가 존재하지 않아 데이터가 없다는 메세지를 출력시키는 예는 다음과 같습니다.

AUIGrid.showInfoMessage(myGridId, "<div>출력할 데이터가 없습니다.</div>");

Also See : removeInfoMessage | 관련 데모 보기

showItemsOnDepth
Type : Method   Version: 2.7.0

계층형 그리드(트리 그리드)인 경우 주어진 depth 까지만 Open 하여 보이도록 지정합니다.

깊이(depth) 는 Root 가 1에 해당되며 하위 브랜치로 내려갈 수록 1씩 증가합니다.

파라메터 설명

  • depth (Number) : 표현하고자 하는 계층 깊이(depth)
showToastMessage
Type : Method   Version: 3.0.4

지정한 특정 셀에 메세지를 출력합니다.

파라메터 설명

  • rowIndex (Number) : 행 인덱스
  • columnIndex (Number) : 칼럼 인덱스
  • message (String) : 행, 열로 대표되는 셀에 출력할 메시지

Also See : removeToastMessage | 관련 데모 보기

syncGridData
Type : Method   Version: 3.0.11.0

칼럼 레이아웃이 동일한 타 그리드에서 얻은 데이터를 삽입할 때 상태 정보(추가, 삭제, 수정)까지 모두 동일하게 동기화 시켜 데이터를 삽입합니다.

이 메소드는 상태 정보를 갖는 getStateCache 메소드와 같이 사용해야 합니다.

파라메터 설명

  • data (Array) : 삽입할 데이터
  • cache (Object) : getStateCache 메소드로 얻은 상태 정보 캐시
   // 그리드1에서 데이터 얻기
   var d = AUIGrid.getGridData(myGridID1);
  
   // 그리드1의 추가, 삭제, 변경된 정보 캐시 얻기
   var cache = AUIGrid.getStateCache(myGridID1);
   
   // 그리드2에 그리드1과 동일한 데이터 및 상태 정보(추가, 삭제, 변경) 캐시를 동기화 시켜 삽입하기
   AUIGrid.syncGridData(myGridID2, d, cache);

Also See : getStateCache

unbind
Type : Method   Version: 2.7.0

그리드 이벤트 핸들링을 마무리 짓습니다. 즉, 언바인딩하는 메소드입니다.

파라메터 설명

  • type : (String or Array) 언바인딩하고자 하는 이벤트 유형

예를 들면 cellClick 이벤트를 언바인당하고자 하는 경우 다음과 같습니다.

 AUIGrid.unbind(myGridID, "cellClick"); 
undo
Type : Method   Version: 2.7.0

편집 가능한 그리드에서 enableUndoRedo=true 설정한 경우, 실행 취소(Undo) 를 실행합니다.

Also See : redo | 관련 데모 보기

undoable
Type : Method   Version: 2.7.0

실행 취소(Undo) 가 가능한지 여부를 반환합니다.

Return : (Boolean) 실행 취소 가능 여부

Also See : undo, redo, redoable | 관련 데모 보기

update
Type : Method   Version: 2.7.0

그리드 셀의 내용을 갱신합니다.

그리드 셀의 내용 갱신의 의미는 현재 출력되고 셀의 텍스트를 재처리하여 출력시킵니다.

예를 들어 특정 칼럼에 labelFunction, formatString 등이 정의 되어 있다면, 해당 로직을 다시 실행해서 셀에 출력 시킵니다.

따라서 labelFunction 에 전역 변수를 참고하고 있을 경우, 전역 변수의 값이 변했을 때 사용하면 유효합니다.

기존 속성의 변경에 반응하지 않습니다. 기존 속성 변경을 한 경우 refresh 메소드를 사용하십시오.

refresh 메소드를 불필요하게 자주 호출하지 마십시오. 성능에 영향을 미칩니다.

updateAllToValue
Type : Method   Version: 2.7.0

그리드 전체 데이터를 대상으로 지정한 dataField 의 값을 지정한 value 로 모두 변경합니다.

updateAllToValue 메소드는 그리드 전체의 특정 필드를 일괄적으로 변경할 수 있습니다.

updateAllToValue 로 값을 변경할 때 updateRow 이벤트 발생지 않고, cellEditedMark 와 stateCoulumn 에 수정 표시가 나타나지 않습니다.

뿐만 아니라 getEditedRowItems, getEditedRowColumnItems 메소드로 수정된 행을 얻을 수 없습니다. getGridData 메소드를 활용하여 전체 데이터를 얻어야 합니다.

행 전체에 대하여 특정 필드를 일괄적으로 변경하고자 할 때 사용하십시오. 가장 빠르게 행 전체의 특정 필드를 변경합니다.

파라메터 설명

  • dataField : (String) 데이터 필드 명
  • value : (Object) 변경할 값

Also See : updateRowBlockToValue

updateGrouping
Type : Method   Version: 3.0.7.0

그룹핑(Grouping) 및 소계(Summary Rows) 를 다시 계산하여 갱신합니다.

그룹핑 및 소계를 설정한 경우 그리드 데이터의 값이 변경되어 재그룹핑 및 소계 계산이 필요한 경우 실행하십시오.

현재 데이터에 맞게 다시 그룹핑 및 소계를 계산하여 출력합니다.

그룹핑 및 소계 설정을 변경하고자 하는 경우 setGroupBy 메소드를 사용하십시오. 이 메소드는 그룹핑 및 소계 설정은 유지하고 단순 갱신만을 합니다.

See Also : setGroupBy

updateRow
Type : Method   Version: 2.7.0

그리드 행(row) 아이템을 수정합니다.

그리드의 속성 editable 과 무관하게 이 메소드를 통해 아이템을 수정할 수 있습니다.

파라메터 설명

  • item (Object) : 수정하고자 하는 행 아이템
  • rowIndex (Number or String) : 수정하고자 하는 행의 인덱스, , rowIndex 대신 "selectedIndex" 문자열을 설정한 경우 현재 선택된 행이 수정됩니다.
  • isMarkEdited (Boolean) : 셀 수정 마커(marker) 표시를 할지 여부를 나타냅니다.(기본값 : true)

예를들어, 행인덱스(rowIndex) 5 인 행의 name 필드를 "우리" 로 바꾸고자 한다면 다음과 같습니다.

  var item = { name : "우리" }; 
  AUIGrid.updateRow(myGridID, item, 5);

행인덱스(rowIndex) 5인 행의 name 필드를 "우리", country 필드를 "나라", product 필드를 "제품" 로 바꾸고자 한다면 다음과 같습니다.

  var item = { name : "우리", country : "나라", product : "제품" }; 
  AUIGrid.updateRow(myGridID, item, 5);

절대 반복문법(for, while 등) 안에서 이 메소드를 사용하지 마십시오.

다수의 행에 대하여 값을 변경하고자 하는 경우 updateRows, updateRowsById 메소드를 사용하십시오.

Also See : updateRows, updateRowsById, updateRowBlockToValue | 관련 데모 보기

updateRowBlockToValue
Type : Method   Version: 3.0.4

지정한 다수의 행을 대상으로 지정한 dataFields(단수 or 복수)의 값을 일괄적으로 모두 변경합니다.

다수의 행을 빠르게 변경할 뿐만 아니라 getEditedRowItems, getEditedRowColumnItems 메소드를 통하여 수정된 행으로 얻을 수 있습니다.

파라메터 설명

  • startRowIndex : 시작 행 인덱스
  • endRowIndex : 종료 행 인덱스
  • dataFields : (String or Array) 데이터 필드 명
  • values : (Object or Array) 변경할 값

dataFields 와 values 를 배열로 삽입하면 블록 단위의 행 일괄 수정이 가능합니다.

  // 0~100 행의 name 필드를 "Anna" 로 일괄 수정
  AUIGrid.updateRowBlockToValue(myGridID, 0, 100, "name", "Anna");
 
  // 0~100 행의 name, country 필드를 각각 "Anna", "Korea" 로 일괄 수정
  AUIGrid.updateRowBlockToValue(myGridID, 0, 100, ["name", "country"], ["Anna", "Korea"]);
 
  // 0~100 행의 name 필드를 "Anna", "John", "Kim" 이 3행마다 반복되게 일괄 수정
  AUIGrid.updateRowBlockToValue(myGridID, 0, 100, "name", [["Anna"], ["John"], ["Kim"]]);
 
  // 0~100 행의 name, country 필드를 블럭으로 일괄 수정 
  AUIGrid.updateRowBlockToValue(myGridID, 0, 100, ["name", "country"], [["Anna", "USA"], ["John", "UK"], ["Kim", "Korea"]]);

관련 데모 보기

updateRows
Type : Method   Version: 3.0.11

다수의 행에 대하여 지정한 필드(들)의 값을 일괄적으로 수정합니다.

다수의 행에 대해(복수의 필드 값에 대해) 가장 빠르게 변경 시킬 수 있는 메소드입니다.

그리드의 속성 editable 과 무관하게 이 메소드를 통해 다수의 행 아이템을 수정할 수 있습니다.

파라메터 설명

  • items (Array) : 수정하고자 하는 복수의 행 아이템
  • rowIndexes (Array) : 수정하고자 하는 행 인덱스(rowIndex) 의 묶음입니다.
  • isMarkEdited (Boolean) : 셀 수정 마커(marker) 표시를 할지 여부를 나타냅니다.(기본값 : true)

rowIndex 각각 1, 2, 3 에 해당되는 3개의 행에 대하여 각각 price, name 2개 필드들을 일괄 수정 시키고자 한다면 다음과 같습니다.

  var items = [{ price : 2000, name : "우리" }, { price : 2001, name : "우리-1" }, { price : 2002, name : "우리-2" }];
  var rowIndexes = [1, 2, 3];
  AUIGrid.updateRows(myGridID, items, rowIndexes); // 행인덱스(rowIndex) 각각 1, 2, 3 인 행들 한번에 업데이트

Also See : updateRowsById, updateRowBlockToValue | 관련 데모 보기

updateRowsById
Type : Method   Version: 2.7.0

그리드 행 고유 값(rowIdField 값)에 해당되는 행(들)의 원하는 필드(들)를 수정합니다.

다수의 행에 대해(복수의 필드 값에 대해) 가장 빠르게 변경 시킬 수 있는 메소드입니다.

그리드의 속성 editable 과 무관하게 이 메소드를 통해 아이템을 수정할 수 있습니다.

파라메터 설명

  • items (Array or Object) : 복수 또는 1개의 행을 업데이트 합니다.
  • isMarkEdited (Boolean) : 셀 수정 마커(marker) 표시를 할지 여부를 나타냅니다.(기본값 : true)

예를 들어 rowIdField 를 id 로 설정한 경우, id 가 20 인 행을 찾아 특정 셀(price, name 2개만) 업데이트 하고자 한다면 다음과 같습니다.

   var item = { id : 20, price : 2000, name : "우리" }; // ID 가 20인 행을 찾아 price=2000, name=우리로 변경
   AUIGrid.updateRowsById(myGridID, item); // 1개 업데이트

다수의 행을 한번에 변경 시킬려면 다음처럼 배열로 정의하여 사용합니다.

  var items = [{ id : 20, price : 2000, name : "우리" }, { id : 21 price : 2001, name : "우리-1" }, { id : 22, price : 2002, name : "우리-2" }];
  AUIGrid.updateRowsById(myGridID, items); // id 가 각각 20, 21, 22 인 행들 한번에 업데이트

Also See : updateRows, updateRowBlockToValue | 관련 데모 보기

validateChangedGridData
Type : Method   Version: 3.0.6

그리드 데이터를 사용자가 수정 또는 행 추가를 한 경우 그 수정, 추가된 행의 필드들 중 빈값(undefined, null, "")에 해당되는 값이 있는지 검사합니다.

사용자가 반드시 입력해야 하는 값이 있다면 이 메소드로 체크 할 수 있습니다.

빈값에 해당되는 값이 존재한다면 해당 셀에 지정된 메세지를 띄우고 값을 입력 하도록 요구합니다.

파라메터 설명

  • requireFields (String or Array) : 필수로 값이 있어야 하는 dataField 들. 즉, 모두 값이 채워 졌는지 체크 하고자 하는 dataField
  • message (String) : 빈값, null 이 존재할 때 적용 시킬 toast alert 메세지. message 파라메터를 설정하지 않으면 toast 는 출력되지 않음.

Return : (Boolean) 빈값 없이 모두 정상적이라면 true 반환

  // 수정, 추가한 행에 대하여 전체 필드에 대하여 검사
  // name 과 country 는 필수로 입력되어야 하는 필드임. 이것을 검사
  var isValid = AUIGrid.validateChangedGridData(myGridID, ["name", "country"], "반드시 유효한 값을 직접 입력해야 합니다.");
  
  // 다른 JS 에서 제공하는 toast 나 alert 으로 경고문을 띄우고자 하는 경우 다음처럼 message 파라메터 생략.
  // AUIGrid.validateChangedGridData(myGridID);
  
  if(isValid) {
   alert("정상적으로 모두 입력됨. 서버로 전송하십시오.");
  }

관련 데모 보기

validateGridData
Type : Method   Version: 3.0.4

그리드 데이터의 필드들 중 빈값(undefined, null, "")에 해당되는 값이 있는지 검사합니다.

사용자가 반드시 입력해야 하는 값이 있다면 이 메소드로 체크 할 수 있습니다.

빈값에 해당되는 값이 존재한다면 해당 셀에 지정된 메세지를 띄우고 값을 입력 하도록 요구합니다.

파라메터 설명

  • requireFields (String or Array) : 필수로 값이 있어야 하는 dataField 들. 즉, 모두 값이 채워 졌는지 체크 하고자 하는 dataField
  • message (String) : 빈값, null 이 존재할 때 적용 시킬 toast alert 메세지. message 파라메터를 설정하지 않으면 toast 는 출력되지 않음.

Return : (Boolean) 빈값 없이 모두 정상적이라면 true 반환

  // name 과 country 는 필수로 입력되어야 하는 필드임. 이것을 검사
  var isValid = AUIGrid.validateGridData(myGridID, ["name", "country"], "필수 필드는 반드시 값을 직접 입력해야 합니다.");
  
  // 다른 JS 에서 제공하는 toast 나 alert 으로 경고문을 띄우고자 하는 경우 다음처럼 message 파라메터 생략.
  // AUIGrid.validateGridData(myGridID, ["name", "country"]);
  
  if(isValid) {
   alert("정상적으로 모두 입력됨. 서버로 전송하십시오.");
  }

관련 데모 보기

validateGridDataByFunc
Type : Method   Version: 3.0.12.6

그리드 데이터의 필드들 중 원하는 조건에 맞지 않는 값이 존재하는지 검사합니다.

사용자가 반드시 입력해야 하는 값 또는 수정되어야 하는 값 등이 있다면 이 메소드로 체크 할 수 있습니다.

조건에 맞지 않는 값이 존재한다면 해당 셀에 지정된 메세지를 띄우고 값을 입력(변경) 하도록 요구합니다.

파라메터 설명

  • requireFields (String or Array) : 체크하고자 하는 dataField 들.
  • validFunc (Function) : 조건에 맞지 않는 값을 체크 하는 함수.

    function signature(item, dataField) { }

  • message (String) : 조건에 맞지 않는 값이 존재할 때 적용 시킬 toast alert 메세지. message 파라메터를 설정하지 않으면 toast 는 출력되지 않음.
  • onlyByFunc (Boolean) : validFunc 반환값으로만 메세지 출력시킬지 여부. true를 설정하면 requireFields 가 null, "" 인 경우에도 validFunc 함수의 반환값으로만 결정함.

Return : (Boolean) 유효성 검사 통과한다면(모두 정상적이라면) true 반환

  // name 은 필수로 입력되어야 하며 Anna 인 값은 수정되어야 함.
  var isValid = AUIGrid.validateGridDataByFunc(myGridID, ["name"], function(item, dataField) {
        var v = item[dataField];
        if(v === "Anna" || v === null || v === "") { // Anna 값, null 값 존재하면 안됨.
            return false; // false 반환하면 조건에 맞지 않는 값으로 정해진 toast 메세지 띄움
        }
  }, "Anna 값은 수정되어야 하며 공백으로 존재해선 안됩니다.");
  
  if(isValid) {
   alert("정상적으로 모두 입력됨. 서버로 전송하십시오.");
  }