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

파라메터 설명

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

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

 AUIPivot.bind(myPivotID, "cellClick", function( event ) {
       alert(event.value + " clicked");
       //alert(JSON.stringify(event));
 });

 // 복수의 이벤트를 한번에 핸들링 하기 (이벤트 유형을 배열로 설정)
 AUIPivot.bind(myPivotID, ["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);
 });

히트맵 출력을 사용한 경우(useHeatmap=true) 개별 필드, 연산자에 히트맵 스펙트럼 컬러를 변경하고, 업데이트 합니다.

파라메터 설명

• dateField : (String) 필드명
• operation : (String or null) 연산자명, 만약 null 지정 시 모든 연산자로 대체함.
• colors : (Array) 히트맵으로 표현할 컬러 스펙트럼

 // 매출액(TOTAL) 이 "합계" 연산에 대하여 흰색~빨갱색 스펙트럼 변경
 AUIPivot.changeHeatmapColors(myPivotID, "TOTAL", "SUM",  ["#ffffff", "#ff0000"]);
 // 매출액(TOTAL) 이 모든 연산에 대하여 흰색~빨갱색 스펙트럼 변경
 AUIPivot.changeHeatmapColors(myPivotID, "TOTAL", null,  ["#ffffff", "#ff0000"]);
 

피벗 그리드에 필터링이 된 경우 완전 해제 후 피벗 그리드를 갱신 합니다.

설정된 행, 열, 값, 필터의 모든 설정 및 원본 데이터(source data)를 초기화한 후 업데이트 합니다.

피벗 보고서 작성을 위해 삽입된 원본 데이터까지 초기화하므로 단순히 행, 열, 값 등의 피벗 설정만 초기화를 원한다면 clearPivotFieldsAll 메소드를 사용하십시오.

See Also : clearPivotFieldsAll

설정된 행, 열, 값, 필터의 모든 설정을 초기화합니다.

dateTypeField 를 지정했다면 dateTypeField 역시 해제 됩니다.

참고 : clearPivotFieldsAll 메소드는 피벗팅을 업데이트 하지 않습니다. 업데이트를 원하면 updatePivot 메소드를 사용하십시오.

  // 모든 필드 초기화
  AUIPivot.clearPivotFieldsAll(myPivotID);
  // 새로 피벗팅 업데이트
  AUIPivot.updatePivot(myPivotID);
  

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

필터 레이어(필터 메뉴)가 오픈되어 있을 때 닫도록 지시합니다.

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

행이 트리 형태인 경우 모든 행들을 닫고 최상위 요약 행 만 표시합니다.

열이 트리 형태인 경우 모든 열들을 닫고 요약 열 만 표시합니다.

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

파라메터 설명

• pid : (String) 피벗 그리드가 생성될 DIV 의 id
• props : (Object) 피벗 그리드 생성 시 설정할 속성(key-value) 객체

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

피벗 필드 패널을 생성하는 메소드입니다.

파라메터 설명

• gridPID : (String) 피벗 그리드가 생성된 DIV 의 id (예제상 myPivotID 값을 설정하십시오.)
• panelPID : (String) 피벗 필드 패널이 생성될 DIV 의 id

작성된 AUIPivot 을 완전히 제거합니다.

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

피벗 필드 패널을 완전히 제거합니다.

행이 트리 형태인 경우 모든 요약 행들을 열어 전체 펼치기를 실행합니다.

열이 트리 형태인 경우 모든 열들을 열어 전체 펼치기를 실행합니다.

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

파라메터 설명

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

■ exportProps 파라메터 설명 ■

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

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

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

PDF 로 내보내기 시 셀 병합 관련 속성(layoutType="tableCellMerge" 설정)은 무시되며 동일한 행 높이만 내보내기 됩니다.

최소한의 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"}
         }]
  };
  // 내보내기 실행
  AUIPivot.exportToPdf(myPivotID, exportProps);

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

파라메터 설명

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

■ exportProps 파라메터 작성 설명 ■

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

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

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

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

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

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

  // 엑셀 내보내기 속성
  var exportProps = {
         // 저장하기 파일명
         fileName : "2020년_지역별_매출_내역(AUIPivot)",
         // 저장 할 때 dataField 가 name, product 인 칼럼들 저장에서 제외시킴.
         exceptColumnFields : ["name", "product"],
         // 헤더 내용
         headers : [ {
              text : "", height:20 // 첫행 빈줄
         }, {
              text : "2020년 지역별 매출 내역", height:24, style : 
                   { fontSize:20, textAlign:"center", fontWeight:"bold", underline:true, background:"#DAD9FF"}
         }, {
              text : "작성자 : 에이유아이", style : { textAlign:"right"}
         }, {
              text : "작성일 : 2017. 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 2021 AUISoft", height:24, style : 
                   { textAlign:"right", fontWeight:"bold", color:"#ffffff", background:"#222222"}
         }]
  };
  // 내보내기 실행
  AUIPivot.exportToXlsx(myPivotID, exportProps);

대상 데이터(원본 데이터)의 필드명의 별칭(alias)을 지시한 경우 dataField에 맞는 별칭을 반환합니다.

파라메터 설명

• dateField : (String) 필드명

Return : (String) 지정한 dataField 에 맞는 별칭

  // "NAME" 필드의 별칭(alias) 반환. 즉 NAME 의 별칭을 "이름" 이라고 지정했다면..."이름"을 얻음.
  var nameAlias = AUIPivot.getAliasByDataField(myPivotID, "NAME");

특정 셀의 피벗팅된 값이 원본 데이터 중 소스로 사용된 데이터가 무엇인지를 반환합니다.

파라메터 설명

• rowIndex : (Number) 행 인덱스
• columnIndex : (Number) 칼럼 인덱스

Return : (Array) 원본 데이터에서 해당 셀의 소스로 사용된 데이터 리스트

  // 행, 열 인덱스 5, 4 를 기반으로 소스로 사용된 상세 리스트를 얻어옴.
  var detailList = AUIPivot.getCellDetailList(myPivotID, 5, 4);
  console.log(JSON.stringify(detailList));
  

피벗 차원에서 열(columns) 차원에 설정한 필드를 반환합니다.

Return : (Array) 열 차원에 설정한 필드

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

파라메터 설명

• dataField : (String) 데이터 아이템의 key 에 해당되는 필드명

Return : (Number) 칼럼인덱스

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

만약 열(columns) 차원이 2개 이상으로 설정한 경우, 열 차원은 계층 구조를 이루게 됩니다. 이런 경우 이 메소드의 반환 값은 최하위 자식들의 정보만을 담은 배열입니다.

열 차원이 계층 구조가 아닌 경우, 이 반환값은 getColumnLayout() 메소드의 값과 같습니다.

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

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

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

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

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

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

파라메터 설명

• columnIndex : (Number) 칼럼 인덱스

Return : (String) 데이터 필드명

원본 데이터(sourceData) 에서 얻을 수 있는 데이터 필드(dataField) 의 리스트들을 반환합니다.

파라메터 설명

• all : (Boolean) setExceptFields 메소드로 제외한 필드까지 모두 반환할지 여부 (기본값 : false)

Return : (Array) 피벗 필드 리스트는 Array 형태로 반환되며 배열 요소로 Object 이며 개별 Object 에 다음과 같은 정보가 담겨 있습니다.

• dataField : 데이터 필드명
• labelText : 데이터 필드의 별칭(alias)
• dataType : 데이터 필드 값의 형식

  // 원본데이터에서 setExceptFields 로 지정한 필드는 제외하고 얻음.
  var myFieldList = AUIPivot.getDataFieldList(myPivotID);
  alert(JSON.stringify(myFieldList);
  
  // 원본데이터에서 얻을 수 있는 데이터 필드(dataField)들의 리스트를 반환 (setExceptFields 무시하고 모두 얻음)  
  var myFieldList = AUIPivot.getDataFieldList(myPivotID, true);
  alert(JSON.stringify(myFieldList);
  

지정한 셀(rowIndex, columnIndex)을 기반으로 피벗의 다차원 큐브에서 얻을 수 있는 행, 열, 값 정보를 반환합니다.

즉, 지정한 셀의 행, 열, 값 정보를 알 수 있습니다.

파라메터 설명

• rowIndex : (Number) 행 인덱스
• columnIndex : (Number) 칼럼 인덱스

Return : (Object) 해당 셀의 다차원 정보를 갖는 Object

반환된 Object 에 다음과 같은 정보가 담겨 있습니다.

• displayName (String) : 해당 셀의 정체성을 알 수 있는 출력명
• rows (Array) : 해당 셀의 행 계층 관계를 알 수 있는 배열
• columns (Array) : 해당 셀의 열 계층 관계를 알 수 있는 배열
• values (String) : 해당 셀의 값 정보를 알 수 있는 배열

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

  // (0, 3) 셀의 다차원 정보를 얻음.
  var dimensions = AUIPivot.getDimensionValues(myPivotID, 0, 3);
  console.log( JSON.stringify(dimensions) ); 

setDisplayOrderRules 메소드로 설정한 피벗 보고서 출력 순서를 반환합니다.

Return : (Array) 출력 순서를 담은 배열

See Also : setDisplayOrderRules

행 차원에 설정한 필드 중 요약 행을 출력하지 않을 필드를 지정한 경우 해당 필드들을 반환합니다.

Return : (Array) "요약 행" 출력을 하지 않는 필드들

See Also : setExceptSumRowFields

대상 데이터(원본 데이터)의 필드명의 별칭(alias)을 지시한 경우 해당 별칭을 반환합니다.

Return : (Object) 설정한 별칭 Object

  // 별칭(alias) 반환
  var aliasObj = AUIPivot.getFieldAlias(myPivotID);

피벗 차원에서 필터(filters) 차원에 설정한 필드를 반환합니다.

Return : (Array) 필터 차원에 설정한 필드

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

파라메터 설명

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

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

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

푸터(Footer)에 출력된 값을 반환합니다.

Return : (Array) 모든 푸터의 값을 배열로 반환

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

파라메터 설명

• rowIndex (Number) : 행인덱스

Return : (Object) 행아이템 객체

피벗 그리드에 출력된 즉, 피벗팅 된 현재 데이터를 반환합니다.

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

Return : (Array) 피벗팅된 데이터

피벗 필드 패널을 사용하는 경우, 현재 피벗 필드 패널의 상태를 반환합니다.

Return : (String) 피벗 필드 패널 상태값 ( 유효 반환값 : "shown", "hidden" )

  if(AUIPivot.getPivotPanelState(myPivotID) == "shown") { // 현재 피벗 필드 상태
     AUIPivot.hidePivotPanel(myPivotID); // 감추기
  } else {
     AUIPivot.showPivotPanel(myPivotID); // 보이기
  }

AUIPivot 속성의 값을 반환합니다.

파라메터 설명

• name (String) : 속성명

Return : (Object) 속성값

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

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

Return : (Number) 전체 행 수

피벗 차원에서 행(rows) 차원에 설정한 필드를 반환합니다.

Return : (Array) 행 차원에 설정한 필드

피벗팅의 대상이 되었던 원본 데이터(source data)를 반환합니다.

이는 사용자가 최초 피벗팅 데이터로 삽입한 데이터와 일치합니다.

Return : (Array) 원본 데이터(source data)

피벗 대상이 되었던 원본 데이터(sourceData)에서 주어진 필드명(fieldName) 의 값(value) 과 일치하는 1개의 아이템을 반환합니다.

원본 데이터에 필드명의 값과 일치하는 아이템이 여러개 인 경우에도 최초의 1개만을 반환합니다.

파라메터 설명

• dataField (String) : 필드명
• value (Object) : 필드의 값

Return : (Object) 주어진 필드명의 값과 일치하는 아이템 객체

참고 : 값과 일치하는 모든 아이템을 얻고자 한다면, getSourceItemsByValue 를 사용하십시오.

  // 원본 데이터에서 REGION 이 광주지점인 아이템 1개  반환. 
  var srcItem = AUIPivot.getSourceItemByValue(myPivotID, "REGION", "광주 지점");

피벗 대상이 되었던 원본 데이터(sourceData)에서 주어진 필드명(fieldName) 의 값(value) 과 일치하는 모든 아이템을 반환합니다.

파라메터 설명

• dataField (String) : 필드명
• value (Object) : 필드의 값

Return : (Array) 주어진 필드명의 값과 일치하는 아이템 객체들의 묶음

참고 : 값과 일치하는 1개의 아이템을 얻고자 한다면, getSourceItemByValue 를 사용하십시오.

  // 원본 데이터에서 REGION 이 광주지점인 아이템들 모두 반환. 
  var srcItemArr = AUIPivot.getSourceItemsByValue(myPivotID, "REGION", "광주 지점");

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

Return : (Number) 전체 depth

피벗 차원에서 값(values) 차원에 설정한 필드를 반환합니다.

Return : (Array) 값 차원에 설정한 필드

피벗 필드 패널을 사용하는 경우, 피벗 필드 패널을 감추도록 지시합니다.

  if(AUIPivot.getPivotPanelState(myPivotID) == "shown") { // 현재 피벗 필드 상태
     AUIPivot.hidePivotPanel(myPivotID); // 감추기
  } else {
     AUIPivot.showPivotPanel(myPivotID); // 보이기
  }
  

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

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

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

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

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

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

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

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

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

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

현재 피벗 그리드에 필터링이 된 경우인지 여부를 반환하빈다.

Return : (Boolean) 필터링 되었는지 여부

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

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

파라메터 설명

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

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

피벗 필드 패널의 크기를 변경합니다.

파라메터 설명

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

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

피벗 차원에서 열(columns) 차원에 설정할 필드를 지정합니다.

일반적인 피벗팅을 실시하기 위해서는 기본 3개의 차원(행, 열, 값) + 1개의 옵션(필터) 로 구성됩니다. 이 기본 3개의 차원 중 열 차원에 해당되는 필드를 지정하는 메소드입니다.

파라메터 설명

• fields : (Array) 피벗팅 대상의 열 차원 필드명들

예를 들어 반기, 분기, 월 을 열 차원 필드로 지정하고자 한다면 다음과 같습니다.

 // 칼럼 필드
 AUIPivot.setColumnFields(myPivotID, [ "DATE_HALF", "DATE_QTR", "DATE_MONTH"]);
 

속성 layoutType 을 "table" 또는 "tableCellMerge" 설정했을 때 열 차원 분석 값의 유형이 날짜(date)나 숫자(numeric)인 경우 헤더 텍스트의 포맷스트링(formatString) 을 설정합니다.

setColumnFormatString 은 Obejct 요소의 배열을 설정합니다.

다음은 Obejct 요소에 대한 설명입니다.

• dataField(String) : 행 차원 필드
• formatString(String) : 포맷 스트링

 // 열 차원 분석 값 헤더 포맷 스트링 정의
  AUIPivot.setColumnFormatString(myPivotID, [{
      dataField : "TOTAL", formatString : "#,##0" // TOTAL 필드를 열 차원에 설정한 경우 "#,##0" 으로 포매팅하여 출력함
  }, {
      dataField : "DATE", formatString : "yyyy. mm. dd." // DATE 필드를 열 차원에 설정한 경우 "yyyy. mm. dd." 로 포매팅하여 출력함
  }]);

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

파라메터 설명

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

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

// 그리드의 칼럼 사이즈들을 강제로 지정합니다.

AUIPivot.setColumnSizeList(myPivotID, [100, 100, 100, 100, 100, 100, 100, 100, 100]);

// 만약 특정 인덱스의 사이즈는 유지하고 싶다면 다음처럼 null 삽입

AUIPivot.setColumnSizeList(myPivotID, [100, 100, null, null, 100, 100, 100, 100]);

// 0, 1번째 칼럼만 100, 100으로 지정합니다. 나머지 칼럼은 기존 유지

AUIPivot.setColumnSizeList(myPivotID, [100, 100]);

원본 데이터(sourceData)의 필드들의 데이터 유형(dataTye) 을 명시적으로 지정합니다.

지정하지 않은 경우, 피벗 그리드가 필드 값으로 유형을 판단하게 됩니다.

파라메터 설명

• dataTypeObj : (Object) 필드명을 key 로 데이터 유형(dataType) 를 value 로 갖는 Object. 설정 가능한 데이터 유형은 "string", "numeric" 두 가지가 존재합니다.

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

  // 데이터 Type 을 명시적으로 지정합니다.
  AUIPivot.setDataType(myPivotID, {
      "REGION" : "string",
      "NAME" : "string",
      "MODEL" : "string",
      "PRICE" : "numeric"
  });

피벗 원본(source) 데이터에서 사용되는 필드의 형식이 날짜(Date) 인 경우, 해당 필드의 날짜 포맷 스트링을 지정합니다.

예를 들어 DATE 라는 필드를 열(column) 필드에 설정한 경우, DATE 는 전혀 포맷팅 되지 않은 2016/01/01 형태로 헤더에 출력 될 것입니다.

이 출력되는 날짜 형식을 바꿀 수 있도록 하는 메소드입니다.

   // 날짜 포맷팅 지정하기
   AUIPivot.setDateFormatString(myPivotID, {
         "DATE" : "yyyy. mm. dd." // DATE 필드는 2015. 01. 01. 형식으로 포맷팅함.
   });
  

대상 데이터(원본 데이터)에서 날짜에 해당되는 필드가 있는 경우, 해당 날짜를 "연", "반기", "분기", "월"로 나누어 필드 구성시키는 메소드입니다.

날짜에 해당되는 필드는 온전히 일(day) 로 구성된 값이여야 가능합니다.

"연", "반기", "분기", "월" 로 생성되는 필드명은 각각 "_YEAR", "_HALF", "_QTR", "_MONTH" 의 접미사가 붙습니다.

예를 들어 "DATE" 필드를 파라메터로 삽입한 경우(즉, 날짜에 해당되는 필드명이 "DATE" 인 경우) 각각 "DATE_YEAR", "DATE_HALF", "DATE_QTR", "DATE_MONTH" 로 필드가 구성됩니다.

파라메터 설명

• dateField : (String) 날짜에 해당되는 필드명

 // 데이터 중 날짜 필드를 명시하여 연, 반기, 분기 등으로 나눠 표시하도록 지시
 AUIPivot.setDateTypeField(myPivotID, "DATE");
 

피벗 보고서 출력 순서를 결정합니다. 속성 displayAutoAscending 을 false 을 설정한 경우만 유효합니다.

원본 데이터(source data) 의 개별 행들에 있는 필드를 기준으로 정렬을 시켜 최종 보고서를 출력시킵니다.

이 규칙은 단일 규칙이 아닌 보고서 전체에 대한 규칙입니다. 즉, 다중 키 정렬과 동일합니다.

파라메터 설명

• rules (Array) : 출력 순서를 Object 를 요소로 갖는 배열
  • dataField (String) : 정렬할 필드명
  • sortyType (Number) : 오름 차순(1), 내림차순(-1) 을 설정
  • nullsLast (Boolean) : null 값을 최하단으로 보낼지 여부(nullsLast 의 기본값은 true 임. 즉, 없어도 되는 규칙)

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

 // 아래처럼 설정한 경우 원본 데이터에 REGION_CODE, NAME_CODE 필드가 존재해야 합니다. (DATE_MONTH 는 setDateTypeField 메소드에 의해 생성된 필드)
  // 설정한 배열의 0번 필드부터 차례로 정렬을 시켜 나갑니다.
  // 정렬을 시킨 후 상단에 있는 행 순서로 보고서에 출력됩니다.
  // 만약 서버사이드에서 가져온 원본 데이터(source data) 순서를 그대로 따르고자 하는 경우
  // 원본 데이터가 원하는 순서로 정렬되었다면 이 메소드 설정은 따로 할 필요 없습니다.
  AUIPivot.setDisplayOrderRules(myPivotID, [
          { dataField : "REGION_CODE", sortType : -1 }, // 판매지점 코드로 내림차순
          { dataField : "NAME_CODE", sortType : 1 }, // 모델로 오름차순
          { dataField : "DATE_MONTH", sortType : -1 } // 월로 내림차순
  ]);

See Also : getDisplayOrderRules

원본 데이터의 필드에서 사용자가 피벗팅에 사용할 수 없도록 특정 필드를 제외시킵니다.

  // 피벗 패널 필드 목록에서 "MODEL", "DATE", "PRICE", "COUNT" 를 제외 시킴.
  // 즉, "MODEL", "DATE", "PRICE", "COUNT" 항목은 피벗 영역에 속하지 못하도록 제한함.
  AUIPivot.setExceptFields(myPivotID, ["MODEL", "DATE", "PRICE", "COUNT"]);
  

행 차원에 설정한 필드 중 요약 행을 출력하지 않을 필드를 지정합니다.

"요약 행" 을 선택적으로 지정 하여 보고서를 출력할 수 있습니다.(즉, 부분적으로 요약행 출력하지 않음)

layoutType 속성을 "table" 또는 "tableCellMerge" 로 설정한 경우만 유효합니다.("tree"는 브랜치가 요약이기 때문에 의미 없음)

참고 : 요약 행을 전체 또는 부분적으로 출력하지 않은 경우 속성 showTreeIcon 은 자연적으로 false 처리 됩니다.

파라메터 설명

• fields (Array) : 제외 시킬 행 차원 필드명

 // 행 필드를 REGION, NAME, MODEL 로 설정했을 때 요약 행으로 출력하지 않을 필드 설정
 // 즉, 요약행은 REGION, NAME 은 하지 않음. 결과적으로 MODEL에 대한 요약 행만 출력함.
 AUIPivot.setExceptSumRowFields(myPivotID, ["REGION", "NAME"]);

See Also : getExceptSumRowFields

대상 데이터(원본 데이터)의 필드명의 별칭(alias)을 지시합니다.

기본적으로 필드의 이름은 JSON 의 필드명을 그대로 따릅니다.

따라서 JSON 의 필드명을 일반 사용자가 직관적으로 구별하기에는 부족합니다. 이런 경우 필드명의 별칭(alias) 를 지정할 필요가 있습니다.

파라메터 설명

• aliasObj : (Object) 필드명 - alias 명 구조의 Object

다음은 각각 한글명으로 바꿔서 표시한 모습입니다.

  // 주어진 JSON 데이터의 필드명을 구분하기 쉽게 alias 를 지정합니다.
  // 만약 완전히 다른 데이터로 다시 설정된다면 alias 들도 다시 설정하십시오.
  AUIPivot.setFieldAlias(myPivotID, {
      "REGION" : "판매 지점",
      "NAME" : "차종",
      "MODEL" : "모델",
      "COLOR" : "색상"
  });

피벗 필드 패널에 출력되는 필드들의 순서를 지시합니다.

파라메터 설명

• orders (Array) : 필드 순서를 정의한 배열

  // 배열에 필드명(JSON 의 key 값)을 원하는 순서로 지정
  // REGION, NAME, PRICE, COUNT, TOTAL 이 순서대로 최상단에 출력되고, 지정하지 않은 남은 필드가 TOTAL 밑에 출력됨.
  AUIPivot.setFieldOrder(myPivotID, ["REGION", "NAME", "PRICE", "COUNT", "TOTAL"]);

피벗 차원에서 필터(filters)에 설정할 필드를 지정합니다.

일반적인 피벗팅을 실시하기 위해서는 기본 3개의 차원(행, 열, 값) + 1개의 옵션(필터) 로 구성됩니다. 이 옵션에 해당되는 차원인 필터에 해당되는 필드를 지정하는 메소드입니다.

필터 필드로 지정되면 상단에 필터 메뉴가 형성됩니다.

파라메터 설명

• fields : (Array) 피벗팅에서 추가로 필터 메뉴 구성 할 필터 필드명들

예를 들어 색상을 필터 차원 필드로 지정하고자 한다면 다음과 같습니다.

 // 필터 필드
 AUIPivot.setFilterFields(myPivotID, ["COLOR"]);
 

피벗팅을 실시할 대상 데이터(원본 데이터)를 삽입합니다.

데이터는 반드시 배열요소가 Object 인 배열(Array) 여야 합니다.(즉, JSON 유형)

파라메터 설명

• data : (Array) 피벗팅 대상 데이터, 원본 데이터(source data)

히트맵 출력을 사용한 경우(useHeatmap=true) 개별 필드, 연산자에 히트맵 스펙트럼 컬러를 지정합니다.

파라메터 설명

• dateField : (String) 필드명
• operation : (String or null) 연산자명, 만약 null 지정 시 모든 연산자로 대체함.
• colors : (Array) 히트맵으로 표현할 컬러 스펙트럼

  // TOTAL 필드의 합계 출력 시 ["#FFFFFF", "#4374D9"] 를 사용함.
  AUIPivot.setHeatmapColors(myPivotID, "TOTAL", "SUM",  ["#FFFFFF", "#4374D9"]);
  // COUNT 필드의 합계 출력 시 ["#FFFFFF", "#4374D9"] 를 사용함.
  AUIPivot.setHeatmapColors(myPivotID, "COUNT", "SUM",  ["#FFFFFF", "#2F9D27"]);
  // PRICE 필드의 모든 연산식 관계 없이  ["#FFFFFF", "#4374D9"] 사용함.
  AUIPivot.setHeatmapColors(myPivotID, "PRICE", null,  ["#FFFFFF", "#4374D9"]);
  

행 필드로 설정한 필드가 차지하는 넓이(width) 의 최대값을 지정합니다.

기본적으로 넓이(width)는 피벗 그리드가 자동으로 조절합니다. 이때 최대값을 지정하면, 최대값보다 커지지 않습니다.

파라메터 설명

• widthObj : (Object) 필드명을 key 로 maxWidth 를 value 로 갖는 Object

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

  // 행필드 설정을 다음처럼 한 경우
  AUIPivot.setRowFields(myPivotID, ["REGION", "NAME", "MODEL"]);
  
  // 행필드 maxWidth 지정
  // REGION 과 MODEL 에 각각 지정, NAME 은 자동 처리
  AUIPivot.setMaxWidthOfRowFields(myPivotID, {
      "REGION" : 100,
      "MODEL" : 80
  });

속성 layoutType 을 "table" 또는 "tableCellMerge" 설정했을 때 행 차원 분석 값에 동적 스타일을 정의합니다.

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

• rowField : 행 차원 필드
• columnIndex : 열 인덱스

 // 행 차원 분석 값 스타일 정의
  AUIPivot.setRowDimStyleFunction(myPivotID, function(rowField, columnIndex) {
       if(rowField == "TOTAL") // 행 차원에 TOTAL 필드를 설정한 경우 my-right-align 스타일 적용
            return "my-right-align";
       return "my-style";
  });

함수의 반환값은 CSS 에서 이미 선언되어 있는 CSS 클래스여야 합니다.

다중의 CSS 클래스는 지원하지 않습니다. 예를 들어 "right-style bold-style font12-style" 과 같은 구조는 지원하지 않습니다.

피벗 차원에서 행(rows) 차원에 설정할 필드를 지정합니다.

일반적인 피벗팅을 실시하기 위해서는 기본 3개의 차원(행, 열, 값) + 1개의 옵션(필터) 로 구성됩니다. 이 기본 3개의 차원 중 행 차원에 해당되는 필드를 지정하는 메소드입니다.

파라메터 설명

• fields : (Array) 피벗팅 대상의 행 차원 필드명들

예를 들어 지역, 이름을 행 차원 필드로 지정하고자 한다면 다음과 같습니다.

 // 지역(REGION), 이름(NAME) 을 행 차원 필드로 설정
 AUIPivot.setRowFields(myPivotID, ["REGION", "NAME"]);
 

속성 layoutType 을 "table" 또는 "tableCellMerge" 설정했을 때 행 차원 분석 값의 유형이 날짜(date)나 숫자(numeric)인 경우 포맷스트링(formatString) 을 설정합니다.

setRowFormatString 은 Obejct 요소의 배열을 설정합니다.

다음은 Obejct 요소에 대한 설명입니다.

• dataField(String) : 행 차원 필드
• formatString(String) : 포맷 스트링

 //행 차원 분석 값 포맷 스트링 정의
  AUIPivot.setRowFormatString(myPivotID, [{
      dataField : "TOTAL", formatString : "#,##0" // TOTAL 필드를 행 차원에 설정한 경우 "#,##0" 으로 포매팅하여 출력함
  }, {
      dataField : "DATE", formatString : "yyyy. mm. dd." // DATE 필드를 행 차원에 설정한 경우 "yyyy. mm. dd." 로 포매팅하여 출력함
  }]);

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

예를 들어 차례로 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 };
      AUIPivot.setSorting(myPivotID, sortingInfo);
 

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

파라메터 설명

• sortingInfo (Array) : 정렬 실행 시킬 정보를 담은 배열
• onlyLastDepthSorting (Boolean) : 트리 그리드 인 경우 최하단 깊이(depth) 만 정렬 실행할 지 여부, 기본적으로 그리드의 onlyTreeLastDepthSorting 속성을 따름.

피벗 차원에서 값(values) 차원에 설정할 필드를 지정합니다.

일반적인 피벗팅을 실시하기 위해서는 기본 3개의 차원(행, 열, 값) + 1개의 옵션(필터) 로 구성됩니다. 이 기본 3개의 차원 중 값 차원에 해당되는 필드를 지정하는 메소드입니다.

값 필드 연산은 "합계", "최소값", "최대값", "개수", "평균", "곱", "분산", "표준 편차" 를 지원합니다.

파라메터 설명

• fields : (Array) 피벗팅 대상의 값 차원 필드와 연산 정보, 포매팅 정보를 포함한 Object 요소 배열

값 차원의 파라메터는 Object 를 요소로 갖는 Array 를 삽입해야 합니다.

해당 Object 는 다음과 같은 요소를 갖습니다.

• dataField : 피벗팅 대상 값 차원 필드명(필수 지정 요망)
• operation : 피벗팅 대상 연산자명 (유효값 : "SUM", "MIN", "MAX", "COUNT", "AVG", "RATIO", "MULTIPLY", "VARIANCE", "STD_DEVIATION". 기본값:"SUM")
• formatString : 피벗팅 연산 후 출력시킬 숫자 포맷 형식 지정(예: "#,##0", "#,##0.00")
• customLabelText : 값 차원의 이름 사용자 정의 텍스트, 기본값은 "연산자 : dataField" 형식임

예를 들어 매출의 합을 값 필드로 지정하고자 한다면 다음과 같습니다.

 // 값 필드
 // 작성예 1. formatString 지정하지 않았기 때문에 기본 포맷 스트링(defaultFormatStirng) 을 따릅니다.
 AUIPivot.setValueFields(myPivotID, [{"dataField":"TOTAL", "operation":"SUM"}]);
 // 작성예 2. formatStirng "#,##0" 으로 지정하여 컴마 붙인 정수로 "매출 : 합계" 출력 시킴.
 AUIPivot.setValueFields(myPivotID, [{"dataField":"TOTAL", "operation":"SUM", "formatString" : "#,##0"}]);
  // 작성예 3. formatStirng "#,##0" 으로 지정하여 컴마 붙인 정수로 "매출 합" 으로 텍스트 출력 시킴.
 AUIPivot.setValueFields(myPivotID, [{"dataField":"TOTAL", "operation":"SUM", "formatString" : "#,##0", "customLabelText" : "매출 합"}]);
 

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

트리 형태인 경우 주어진 depth 까지만 Open 하여 보이도록 지정합니다.

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

파라메터 설명

• depth (Number) : 표현하고자 하는 계층 깊이(depth)

피벗 필드 패널을 사용하는 경우, 피벗 필드 패널을 보이도록 지시합니다.

  if(AUIPivot.getPivotPanelState(myPivotID) == "shown") { // 현재 피벗 필드 상태
     AUIPivot.hidePivotPanel(myPivotID); // 감추기
  } else {
     AUIPivot.showPivotPanel(myPivotID); // 보이기
  }
  

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

파라메터 설명

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

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

 AUIPivot.unbind(myPivotID, "cellClick");
 

피벗팅을 업데이트하도록 지시 합니다.

예를 들어 값 차원 필드, 또는 행 차원 필드를 수정한 경우 이 메소드로 업데이트 시켜야 피벗그리드에 반영됩니다.

다음은 사용 예입니다.

  // 칼럼 새로 수정
  AUIPivot.setColumnFields(myPivotID, [ "COLOR""]);
  // 새로 피벗팅 업데이트
  AUIPivot.updatePivot(myPivotID);