AUISoft
AUIGrid 3.0.13 Documentation
DropDownHeaderRenderer

드랍다운 헤더 렌더러는 특정 칼럼의 헤더에 드랍다운리스트가 출력되는 헤더 렌더러입니다.

드랍다운 헤더 렌더러는 칼럼 레이아웃을 정의할 때 개별 칼럼의 headerRenderer 속성 값인 Object 형태로 선언되어야 합니다.

칼럼의 headerRenderer 속성의 type 으로만 설정 가능합니다.

아래는 설정 예제 입니다.
var columnLayout = [ {
     dataField : "country",
     headerText : "Country",
     width : 80,
     headerRenderer : {
            type : "DropDownHeaderRenderer",
            onClick : function(event) { // 항목 클릭 이벤트 핸들러
                alert("columnIndex : " + event.columnIndex + ", value : " + event.value);
            }
      }
}, {
 ...
}];
NameDescription
applyHeaderText
Type : Boolean   Version: 3.0.13

드랍다운 리스트의 항목을 선택하면 선택한 값으로 헤더 텍스트를 변경 시킬지 여부를 지정합니다.

기본값(default) : true.
keyField
Type : String   Version: 3.0.13

list 속성의 값이 key-value 를 갖는 Object 요소 배열인 경우 key 에 해당되는 필드명을 지정합니다.

실제 적용되는 데이터 값의 필드명입니다.

기본값(default) : null.
list
Type : Array   Version: 3.0.13

드랍다운 리스트에 출력될 리스트 항목을 지정합니다.

리스트는 배열로 지정합니다. 여기서 지정된 리스트 중 하나를 사용자는 선택할 수 있습니다.

드랍다운 리스트를 사용하기 위해서 반드시 선언되어야 할 속성이지만 listFunction 으로 대체 될 수 있습니다.

만약 listFunction 을 설정한다면 이 속성은 무시됩니다.

기본값(default) : null.
listAlign
Type : String   Version: 3.0.13

리스트 항목들의 텍스트 정렬 방식을 지정합니다. 유효값은 "left", "right", "center" 입니다.

기본값(default) : "center".
listFunction
Type : Function   Version: 3.0.13

드랍다운 리스트에 출력될 리스트 항목을 동적으로 변경할 수 있는 함수입니다.

기본적으로 list 속성에 정의된 항목이 드랍다운 리스트에 출력되나 이 함수의 반환값으로 출력되는 항목을 바꿀 수 있습니다.

  • columnIndex : 칼럼 인덱스
  • dataField : 해당 칼럼이 출력하고 있는 행 아이템의 필드명(String)
  • cItem : 해당 칼럼의 데이터
listFunction : function(columnIndex, dataField, cItem) {
      if(조건)
           return ["A", "B", "C"]; // 조건에 따른 리스트 반환
      return ["1", "2", "3"]; // 기본 리스트
}

이 함수의 반환값이 곧 해당 항목의 출력 리스트가 됩니다.(반드시 Array를 반환하십시오.)

listHeight
Type : Number   Version: 3.0.13

드랍다운 항목 리스트의 높이를 명시적으로 지정합니다. 이 값으로 설정한 값보다 항목 리스트의 높이는 커지지 않습니다.

기본값(default) : NaN.
listTemplateFunction
Type : Function   Version: 3.0.13

드랍다운 리스트에 출력될 리스트의 텍스트를 사용자 정의 할 수 있는 함수입니다.

기본적으로 list 속성에 정의된 항목이 드랍다운 리스트에 출력되나 이 함수로 출력되는 항목의 HTML 템플릿을 바꿀 수 있습니다.

리스트의 출력 모습을 복잡하거나, 다양한 정보를 출력시키고자 할 때 사용하십시오.

listTemplateFunction 은 함수를 지정해야 하며 함수 형태는 다음과 같습니다.

  • columnIndex : 칼럼 인덱스
  • dataField : 해당 칼럼이 출력하고 있는 행 아이템의 필드명(String)
  • listItem : list 속성에서 정의한 배열에서 개별 아이템(Object Or String)
listTemplateFunction : function(columnIndex, dataField, listItem) { return '<img src="./assets/' + listItem.img + '" height="20" width="20"/><span>' + value + '</span>'; }

이 함수의 반환값이 곧 해당 항목의 출력 HTML 이 됩니다.(innerHTML 처리됨)

offsetRight
Type : Number   Version: 3.0.13

헤더에 출력되는 드랍다운의 오른쪽 여백을 지정합니다.

이 여백은 헤더 클릭으로 정렬을 실행하고자 할 때 지정할 필요가 있습니다.

기본값(default) : 0.
onClick
Type : Function   Version: 3.0.13

드랍다운 리스트의 항목을 클릭했을 때 발생하는 이벤트 핸들러를 선언합니다.

이벤트 핸들러로 전달되는 파라메터의 event 객체 요소는 다음과 같습니다.

  • type : 이벤트 유형으로 "headerDropDownItemClick" 임
  • pid : 사용자에 의해 작성된 그리드의 부모 DIV ID (샘플 상의 myGridID 와 일치함)
  • columnIndex : 칼럼 인덱스
  • dataField : 행 아이템에서 현재 칼럼이 출력되고 있는 데이터의 KeyField
  • depth : 그룹형 헤더인 경우 해당 헤더의 깊이(depth)
  • isBranch : 그룹형 헤더인 경우 그룹 헤더인지 여부
  • key : key-value 모드인 경우 드랍다운 리스트에서 클릭한 항목의 key 값
  • value : 드랍다운 리스트에서 클릭한 항목의 값

onClick 은 함수를 지정해야 하며 함수 형태는 다음과 같습니다.

onClick : function(event) {
  alert( event.columnIndex + " , " + event.value );
}

관련 데모 보기

기본값(default) : null.
valueField
Type : String   Version: 3.0.13

list 속성의 값이 key-value 를 갖는 Object 요소 배열인 경우 value 에 해당되는 필드명을 지정합니다.

드랍다운리스트에 출력되는 데이터의 필드명입니다.

기본값(default) : null.