WebSquare.uiplugin.pivot

피봇. 데이터를 2차원으로 표시. 데이터를 2차원 축에 표시하여 통계치를 표시. Sum, Avg, Count, Minimum, Maximum 등의 통계치를 지원. 사용자 함수를 통한 통계치 정의도 가능. Excel의 pivotTable과 비슷한 기능을 제공. (지원 브라우저: IE10 이상.)

Type

uiplugin

Property Summary

aggregatorName: [default:Sum]기본 aggregator(통계함수)를 설정하는 옵션이다. field에 정의된 aggregator가 우선순위가 높으며, field에 정의된 aggregator가 없을 경우 해당 옵션의 aggregator를 사용한다.
allTotalName: 총합계 부분 label
autoFit: [lastColumn, allColumn] pivot table에 정의 된 width에 맞춰 여백이 없이 가득 채워주는 기능으로 가로 스크롤이 생기지 않는다.
autoFitMinWidth: pivot의 최소 width(px단위)를 지정하는 기능으로 autoFit속성의 값이 allColumn일 때 적용된다
autoPopupInvalidMessage: key 입력시 regExp에 정의되지 않은 문자 입력시 자동으로 경고창 띄워줄지 여부
bodyTextAlign: [default:center, left, right] header를 제외한 body 항목의 text 정렬 방법
chartDataSeperator: chart data 생성시 x,y data label sepator [default:'-']
chartLegendSeperator: chart data 생성시 범례의 label sepator [default:'-']
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
cols: pivot을 초기에 보여줄 때 column축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
dataList: pivot과 연동할 dataList id
decimalSep: 소수 정수 구분 문자
digitsAfterDecimal: 소수점 자릿수
excludeHiddenList: Header의 hiddenList에서도 제외할 column
grandTotalDisplayType: 전체 총계를 표시할 위치 선택
grandTotalName: header의 vals 합계 부분 label
headerListOrder: HeaderList 순서 정의
headerTextAlign: [default:center, left, right] header에 대한 text 정렬 방법
hiddenHeaderList: Header에서 보여주지 않을 headerList 정의
id: 컴포넌트 ID.
invalidMessage: validate API의 검증 결과가 실패일 경우 표시할 메시지. displaymessage="true"일 경우만 유효.
noColumnMove: pivot data영역의 header column을 마우스로 drag하여 컬럼을 이동할 수 있는 기능 사용 여부
noResultMessage: pivot의 조회 결과가 없을 시 표시되는 메세지
noResultMessageClass: pivot의 결과 없음 메시지의 class
noResultMessageStyle: pivot의 결과 없음 메시지의 style
noResultMessageVisible: pivot의 조회 결과가 없을 시 메시지 표시 여부
prefix: data 앞에 붙일 문자
rows: pivot을 초기에 보여줄 때 row축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
scaler: 배수 값
showGrandTotal: 합계 부분을 보여줄지 여부
showZero: data가 없을 경우 0으로 보여줄지 여부
sortFunction: rows,cols,vals 축 각각에 해당하는 data의 순서를 전체적으로 직접 정의하고 싶은 경우 column id를 인자로 받는 사용자함수를 작성한 후 함수명을 해당 옵션으로 입력한다.
suffix: data 뒤에 붙일 문자
textAlign: [default:center, left, right] 항목의 text 정렬 방법
thousandsSep: 3자리 마다 구분 문자
totalTextAlign: [default:center, left, right] pivot 전체 항목의 text 정렬 방법
useNumberFormat: 사용자 정의 number format 옵션 사용 여부
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성
vals: pivot을 초기에 보여줄 때 value축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
valuesAxis: [default:row] Σ값 레이블이 생성된 경우 (value축 컬럼이 2개 이상인경우) Σ값 레이블의 위치를 설정하는 옵션이다

Event Summary

oncellclick: 셀이 클릭 된 경우 발생한다
onrefresh: pivot 설정이 동적으로 바뀐경우 (축을 옮기거나, aggregator가 바뀌거나, exclusions이 바뀌는 등) 발생하는 이벤트

Method Summary

addClass( className ): 컴포넌트에 CSS class를 추가
bind( eventType , function ): 컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeClass( oldClassName , newClassName ): 웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
focus( ): 웹스퀘어 컴포넌트에 포커스를 줌
getDisabled( ): 현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( ): 컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( ): 웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS ): 웹스퀘어 컴포넌트의 초기 스타일을 반환
getOpacity( ): 웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
getOriginalID( ): 웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
getPluginName( ): 웹스퀘어 컴포넌트의 이름(pluginName)을 반환
getPosition( positionName ): 웹스퀘어 컴포넌트의 위치(left, top)를 반환. (웹스퀘어 컴포넌트 공통.)
getReadOnly( ): 현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환
getScope( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getScopeWindow( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getSize( sizeName ): 웹스퀘어 컴포넌트의 크기(width, height)를 반환. (웹스퀘어 컴포넌트 공통.)
getStyle( propertyName ): 웹스퀘어 컴포넌트의 CSS 속성 값을 반환
getStyleValue( style ): [deprecated]
getTitle( ): 컴포넌트의 title 속성 값을 반환
getTotalRow( ): 행의 개수를 반환한다
getUdcHome( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
getUdcRoot( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
getUserData( key ): setUserData로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환
hasClass( className ): 웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( ): 웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
pivotCSVDownload( options ): 데이터를 CSV 파일로 저장한다
pivotCSVUpload( options ): csv 파일을 읽어 Pivot의 데이터를 설정한다
pivotExcelDownload( options , infoArr ): Pivot의 데이터를 엑셀 파일로 저장한다
pivotExcelUpload( options ): 엑셀 파일을 읽어 Pivot의 데이터를 설정한다
removeClass( className ): 웹스퀘어 컴포넌트에서 class를 삭제. (웹스퀘어 컴포넌트 공통.)
setDisabled( disabled ): 웹스퀘어 컴포넌트의 disabled 속성을 설정
setEventPause( evList , flag ): 지정한 이벤트를 중단함
setFixedColumn( fixedColNum ): 세로 틀고정을 설정한다
setFixedRow( fixedRow ): 세로 틀고정을 설정한다
setInitStyle( property ): 웹스퀘어 컴포넌트의 초기 스타일을 복구
setOpacity( value ): 웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPivotInit( valsStr ): pivot의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivot을 다시 그립니다
setPosition( left , top , mode ): 웹스퀘어 컴포넌트의 위치(left, top)를 설정
setReadOnly( readOnly ): 웹스퀘어 컴포넌트의 readOnly 속성을 설정
setSize( width , height ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value ): 웹스퀘어 컴포넌트의 CSS 속성을 설정
setUserData( key , value ): 웹스퀘어 컴포넌트에 임의의 데이터를 설정. (웹스퀘어 컴포넌트 공통.)
setvals( valsStr ): pivot의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivot을 다시 그립니다
show( displayType ): 웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className ): 웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array ): 컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function ): 컴포넌트에서 이벤트를 제거
visible( flag ): [deprecated]

Property Detail

aggregatorName: [default:Sum]기본 aggregator(통계함수)를 설정하는 옵션이다. field에 정의된 aggregator가 우선순위가 높으며, field에 정의된 aggregator가 없을 경우 해당 옵션의 aggregator를 사용한다.
aggregator는 Sum, Average, Count, Minimum, Maximum 등 기본적으로 제공되는 aggregator외에 사용자 정의 함수 aggregator를 등록할 수 있다.
allTotalName: 총합계 부분 label
autoFit: [lastColumn, allColumn] pivot table에 정의 된 width에 맞춰 여백이 없이 가득 채워주는 기능으로 가로 스크롤이 생기지 않는다.
allColumn은 여백을 모든 컬럼에 분배하여 조절하며 lastColumn은 마지막 컬럼을 allColumn은 모든 컬럼의 너비를 조정한다.
autoFitMinWidth: pivot의 최소 width(px단위)를 지정하는 기능으로 autoFit속성의 값이 allColumn일 때 적용된다.
autoPopupInvalidMessage: key 입력시 regExp에 정의되지 않은 문자 입력시 자동으로 경고창 띄워줄지 여부
bodyTextAlign: [default:center, left, right] header를 제외한 body 항목의 text 정렬 방법.
chartDataSeperator: chart data 생성시 x,y data label sepator [default:'-']
chartLegendSeperator: chart data 생성시 범례의 label sepator [default:'-']
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
Engine 내부에서 각 컴포넌트 별로 지정된 class를 적용하나, class 속성을 이용하여 컴포넌트의 CSS를 제어 가능.
cols: pivot을 초기에 보여줄 때 column축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
입력된 column의 순서에 따라 결과가 달라진다.
(ex1) cols="col3,col4,col5" (ex2) cols="col5,col3,col4"
dataList: pivot과 연동할 dataList id
decimalSep: 소수 정수 구분 문자. useNumberFormat true일 경우 적용.
digitsAfterDecimal: 소수점 자릿수. useNumberFormat true일 경우 적용.
excludeHiddenList: Header의 hiddenList에서도 제외할 column.
grandTotalDisplayType: 전체 총계를 표시할 위치 선택. [default: both, vertical, horizontal]
grandTotalName: header의 vals 합계 부분 label
headerListOrder: HeaderList 순서 정의.
headerTextAlign: [default:center, left, right] header에 대한 text 정렬 방법.
hiddenHeaderList: Header에서 보여주지 않을 headerList 정의.
id: 컴포넌트 ID.
컴포넌트 ID는 전역 객체로 할당됨. 각 컴포넌트 ID를 통해 Script에서 해당 컴포넌트에 접근 가능.
invalidMessage: validate API의 검증 결과가 실패일 경우 표시할 메시지. displaymessage="true"일 경우만 유효.
invalidMessageFunc과 동시 적용 불가.
noColumnMove: pivot data영역의 header column을 마우스로 drag하여 컬럼을 이동할 수 있는 기능 사용 여부.
noResultMessage: pivot의 조회 결과가 없을 시 표시되는 메세지
noResultMessageClass: pivot의 결과 없음 메시지의 class
noResultMessageStyle: pivot의 결과 없음 메시지의 style
noResultMessageVisible: pivot의 조회 결과가 없을 시 메시지 표시 여부
prefix: data 앞에 붙일 문자. useNumberFormat true일 경우 적용.
rows: pivot을 초기에 보여줄 때 row축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
입력된 column의 순서에 따라 결과가 달라진다.
(ex1) rows="col1,col2" (ex2) rows="col2,col1"
scaler: 배수 값. useNumberFormat true일 경우 적용.
showGrandTotal: 합계 부분을 보여줄지 여부
showZero: data가 없을 경우 0으로 보여줄지 여부. useNumberFormat true일 경우 적용.
sortFunction: rows,cols,vals 축 각각에 해당하는 data의 순서를 전체적으로 직접 정의하고 싶은 경우 column id를 인자로 받는 사용자함수를 작성한 후 함수명을 해당 옵션으로 입력한다.
field 각각의 sortOrder 속성을 통해 보다 쉽게 출력되는 data 순서를 조작할 수 있다.
이 속성이 정의되어있고 해당 사용자함수가 존재하는경우 field에 정의된 sortOrder 속성은 무시된다.
suffix: data 뒤에 붙일 문자. useNumberFormat true일 경우 적용.
textAlign: [default:center, left, right] 항목의 text 정렬 방법.
thousandsSep: 3자리 마다 구분 문자. useNumberFormat true일 경우 적용.
totalTextAlign: [default:center, left, right] pivot 전체 항목의 text 정렬 방법.
useNumberFormat: 사용자 정의 number format 옵션 사용 여부. (digitsAfterDecimal, scaler, showZero, decimalSep, thousandsSep, prefix, suffix)
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있음.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있음.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있음.
vals: pivot을 초기에 보여줄 때 value축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
vals로 설정된 column이 2개 이상일 경우 Σ값 레이블이 생성된다.
입력된 column의 순서에 따라 결과가 달라진다.
(ex1) vals="col6,col7" (ex2) cols="col5,col3,col4"
valuesAxis: [default:row] Σ값 레이블이 생성된 경우 (value축 컬럼이 2개 이상인경우) Σ값 레이블의 위치를 설정하는 옵션이다.

Event Detail

oncellclick

셀이 클릭 된 경우 발생한다.

Parameter
name	type	description
info	Object	rowIndex, colIndex, rowData를 포함한 오브젝트를 반환한다.

onrefresh

pivot 설정이 동적으로 바뀐경우 (축을 옮기거나, aggregator가 바뀌거나, exclusions이 바뀌는 등) 발생하는 이벤트.

Parameter
name	type	description
options	JSON	pivot의 options(rows, cols, vals 등) 객체

Method Detail

addClass( className )

컴포넌트에 CSS class를 추가. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
className	String	Y	추가할 class의 이름

Sample

// (예제) // input1 컴포넌트에 oddClass라는 class를 추가 input1.addClass("oddClass");

bind( eventType , function )

컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
eventType	String	Y	할당할 이벤트
function	Function	Y	이벤트에 대한 핸들러 함수.

Sample

// (예제 1) // input1의 onclick 이벤트에 대한 핸들러 함수를 직접 정의하여 할당. input1.bind("onclick", function(e){ alert(input1.getValue();})); // (예제 2) // 미리 commObj.ev_click 함수를 정의. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; // input1 컴포넌트에 onclick 이벤트와 정의한 핸들러 함수를 동적으로 할당. input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
기본적으로 addClass를 통해 추가된 class만 변경 가능.
웹스퀘어 컴포넌트의 class 속성에 직접 정의된 class를 삭제하려면 config.xml 파일에 아래 설정을 추가해야 함. // config.xml에 아래 설정을 추가. <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
oldClassName	String	Y	변경할 class
newClassName	String	Y	새로 사용할 class

Sample

// inputBox 컴포넌트에 class가 속성으로 직접 정의됨. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // config.xml 파일에 아래를 추가. <style> <removeDefaultClass value="true" /> </style> // class를 변경 가능. // (tmpInputClass class를 tmpInputWarninClass로 변경.) input1.changeClass("tmpInputClass","tmpInputWarninClass");

focus( )

웹스퀘어 컴포넌트에 포커스를 줌. (웹스퀘어 컴포넌트 공통.)

getDisabled( )

현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
Boolean	disabled 속성 값

Sample

// 컴포넌트의 disabled 속성 값 확인 예제 var returnValue = componentId.getDisabled(); // (반환 값 예시) false

getGenerator( )

컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
Object	부모 Generator 객체

Sample

//부모 Generator가 자식으로 Trigger를 생성한 예제 <w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> // 아래 예제의 경우 trigger1을 클릭하면 generator1 객체가 console에 표시됨. scwin.trigger1.onclick = function(){ console.log(this.getGenerator());}

getID( )

웹스퀘어 컴포넌트의 ID를 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
String	웹스퀘어 컴포넌트 ID

Sample

// 동적으로 웹스퀘어 컴포넌트를 받을 경우, 아래와 같이 ID 확인 가능. function fn_validCheck(tmpObj){ var compID = tmpObj.getID(); } // 위의 예제 에서 tmpObj가 "input1" ID를 가지고 있는 경우, // (반환 값) "input1"

getInitStyle( CSS )

웹스퀘어 컴포넌트의 초기 스타일을 반환. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
CSS	String	N	속성 (지정하지 않으면 모든 정보 출력)

getOpacity( )

웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
엔진 내부적으로 CSS의 opacity 속성 값을 반환.

Return
type	description
Integer	Opacity 값

Sample

// inputBox 컴포넌트에 opacity CSS를 적용. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> // inputBox 컴포넌트의 opacity 값을 반환. var returnValue = input1.getOpacity(); // returnValue는 0 ~ 1 사이의 실수. // (반환 값) "0.2"

getOriginalID( )

웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
originalID는 Scope 기능을 사용할 경우 존재.
scope="true"인 WFrame를 사용할 경우, WFrame 내부의 컴포넌트 ID는 원래 사용자가 정의한 값(originalID) 앞에 prefix(wframeID + "_")가 추가되는 방식으로 변경됨.
originalID는 이 때, prefix가 추가되기 전 ID를 의미.

Return
type	description
String	컴포넌트의 originalID

Sample

// WFrame을 사용하는 다중 화면 구조 예시 // WFrame을 포함한 메인 화면 (main.xml) <w2:wframe id="wframe1" src="text.xml" scope="true"/> // 메인 화면 WFrame에 연결되는 소스 화면 (text.xml) <w2:textbox id="textbox1"/> // text.xml 화면의 내부 스크립트에서 ID 및 originalID 확인하는 예제. // getID 실행 textbox1.getID(); // 실행 결과는 "wframe1_textbox1" // getOriginalID 실행 textbox1.getOriginalID(); // 실행 결과는 "textbox1"

getPluginName( )

웹스퀘어 컴포넌트의 이름(pluginName)을 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
String	웹스퀘어 컴포넌트의 이름 (pluginName)

Sample

// 아래와 같이 공통 함수에서 동적으로 웹스퀘어 객체를 받는 경우, 컴포넌트 종류에 따른 분기 처리가 가능. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); // 컴포넌트 ID var tmpCompType = tmpObj.getPluginName(); // 컴포넌트 이름 if(tmpCompType == "input"){ //..로직.. }else if(tmpCompType == "gridView"){ //..로직 .. }else{ //..로직.. } };

getPosition( positionName )

웹스퀘어 컴포넌트의 위치(left, top)를 반환. (웹스퀘어 컴포넌트 공통.)
위치 값이 %로 설정된 경우, 픽셀로 변환된 값을 반환.

Parameter
name	type	required	description
positionName	String	Y	[left, top] 위치 종류

Return
type	description
Number	컴포넌트의 위치 값

Sample

// 아래와 같이 input 컴포넌트에 CSS 속성 margin이 적용된 경우, <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> // (예제) 위의 inputBox 컴포넌트의 top 값을 확인 var returnValue = input1.getPosition("top"); // 픽셀 단위의 위치 값이 반환됨. // (반환 값) 10

getReadOnly( )

현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
Boolean	현재 설정되어있는 readOnly 속성

Sample

// 컴포넌트의 readOnly 속성 값 확인 예제 var returnValue = componentId.getReadOnly(); // (반환 값 예시) false

getScope( )

scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
scope="true"인 WFrame의 자식 컴포넌트가 아닌 경우, null을 반환.

Return
type	description
Object	WFrame 객체 또는 null

Sample

// (예제) // 메인페이지에 wframe1이 있고, wframe1 내부에 wframe11이 존재. // 그리고, wframe11 내부에 textbox1이 존재. textbox1.getScope(); // (반환 값) wframe11 객체

getScopeWindow( )

scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
scope="true"인 WFrame의 자식 컴포넌트가 아닌 경우, 전역 window 객체를 반환.

Return
type	description
Object	WFrame 객체의 scope 객체 또는 전역 window 객체

Sample

// (예제) // 메인페이지에 wframe1이 있고, wframe1 내부에 wframe11이 존재. // 그리고, wframe11 내부에 textbox1이 존재. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSize( sizeName )

웹스퀘어 컴포넌트의 크기(width, height)를 반환. (웹스퀘어 컴포넌트 공통.)
%로 설정된 경우, 픽셀로 변환된 값을 반환.

Parameter
name	type	required	description
sizeName	String	Y	크기 값의 종류. sizeName 별 계산 방법은 아래 표를 참고.

Return
type	description
Number	컴포넌트의 크기 값

Sample

var returnValue = componentId.getSize("width"); // (반환 예) 100 // 픽셀 단위의 크기 값이 반환됨. // %로 설정된 경우, 픽셀로 변환된 값이 반환됨.

getStyle( propertyName )

웹스퀘어 컴포넌트의 CSS 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
propertyName	String	Y	반환할 CSS 속성

Return
type	description
String	CSS 속성 값

Sample

//아래와 같이 input 컴포넌트가 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;"></xf:input> // (예제) 위의 inputBox 컴포넌트의 width 값을 확인 var returnValue = input1.getStyle("width"); // (반환 값) "144px"

getStyleValue( style )

[deprecated]
getStyle 사용 권장.
웹스퀘어 컴포넌트에 적용된 해당 CSS 속성 값을 반환.

Parameter
name	type	required	description
style	String	Y	반환하려는 CSS 속성.

Return
type	description
String	style 해당 CSS 속성 값 (색을 반환하는 경우, HexCode로 반환됨.)

getTitle( )

컴포넌트의 title 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
String	title 속성 값.

Sample

// 아래와 같이 input 컴포넌트의 title 속성이 "이름 입력"으로 정의된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); // (반환 값 예시) "이름 입력"

getTotalRow( )

행의 개수를 반환한다.

Return
type	description
Number	행의 개수

getUdcHome( )

UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
파일명은 마지막 .xml까지 포함. .xml을 제외한 경로는 getUdcRoot를 사용해서 반환.
UDC 객체가 아닌 컴포넌트에서 호출된 경우에는 undefined가 반환됨.

Return
type	description
String	UDC 파일 경로. (UDC가 아닌 경우, undefined가 반환됨.)

Sample

// 예제 // UDC 파일 경로는 /a/b/udc.xml // 화면 XML은 /a/c/main.xml // UDC 객체의 ID는 udc1 udc1.getUdcHome(); // (실행 결과) /a/b/udc.xml

getUdcRoot( )

UDC 객체가 자신을 정의한 UDC 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
파일명을 포함하지 않음. 파일명을 포함한 경로는 getUdcHome을 사용해서 반환.
UDC 객체가 아닌 컴포넌트에서 호출된 경우에는 undefined가 반환됨.

Return
type	description
String	UDC 파일 경로. (UDC가 아닌 경우, undefined가 반환됨.)

Sample

// 예제 // UDC 파일 경로는 /a/b/udc.xml // 화면 XML은 /a/c/main.xml // UDC 객체의 ID는 udc1 udc1.getUdcHome(); // (실행 결과) /a/b/

getUserData( key )

setUserData로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
key	String	Y	데이터의 key

Return
type	description
String	key에 해당하는 value

Sample

// Input 컴포넌트에 사용자 속성(setTest)을 설정하는 예제 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" setTest="Hello"></xf:input> // 위에서 설정한 setTest을 값을 반환하는 예제. input1.getUserData("setTest"); // (반환 값) "Hello" //setUserData를 통해 'valueTest'(key)와 'WebSquare'(data)로 설정하는 예제. input1.setUserData("valueTest","WebSquare"); // 위에서 설정한 setTest을 값을 반환하는 예제. input1.getUserData("WebSquare"); // (반환 값) "WebSquare"

hasClass( className )

웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
className	String	Y	검색할 class 이름

Return
type	description
Boolean	class의 포함 여부

Sample

// inputBox 컴포넌트에 class가 속성으로 직접 정의됨. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> var returnValue = input1.hasClass("tmpInputClass"); // (반환 값) true

hide( )

웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
display:none; 및 visibility:hidden; CSS를 적용.

Sample

// (예제) 컴포넌트를 숨김 componentId.hide();

pivotCSVDownload( options )

데이터를 CSV 파일로 저장한다. (JDK 1.5이상에서 사용 가능)

Parameter
name	type	required	description
options	JSON	Y	JSON형태로 저장된 Pivot의 csv 다운로드 옵션

Sample

//저장 할 컬럼 정의 var colArr = []; colArr[0] = "name"; colArr[1] = "corp"; //저장 옵션 var options = { fileName: "saveCSV.csv", delim: ";" }; pivotTable.pivotCSVDownload(options); //별도의 옵션이 없을 경우 빈 객체를 파라메터로 넘겨줘야 한다. pivotTable.pivotCSVDownload({});

pivotCSVUpload( options )

csv 파일을 읽어 Pivot의 데이터를 설정한다. (JDK 1.5이상에서 사용 가능)

Parameter
name	type	required	description
options	JSON	Y	JSON형태로 저장된 Pivot의 csv 업로드 옵션

Sample

var options = { delim: ",", escapeChar: "'", startRowIndex: 1 }; pivotTable.pivotCSVUpload(options); //별도의 옵션이 없을 경우 빈 객체를 파라메터로 넘겨줘야 한다. pivotTable.pivotCSVUpload({});

pivotExcelDownload( options , infoArr )

Pivot의 데이터를 엑셀 파일로 저장한다. (JDK 1.5이상에서 사용 가능)

Parameter
name	type	required	description
options	Object	Y	JSON형태로 저장된 Pivot의 엑셀 다운로드 옵션
infoArr	Object	N	Pivot에 대한 내용을 추가로 다른 셀에 표현하는 경우 사용하는 배열

Sample

//별도의 옵션 없이 excel을 download 할 경우 var excelOpt = {}; //excel download 옵션 excelOpt.fileName = "excelData.xls"; //또는 xlsx 확장자 사용 pivotTable.pivotExcelDownload( excelOpt );

pivotExcelUpload( options )

엑셀 파일을 읽어 Pivot의 데이터를 설정한다. (JDK 1.5이상에서 사용 가능)

Parameter
name	type	required	description
options	Object	Y	JSON형태로 저장된 Pivot의 엑셀 업로드 옵션

Sample

//별도의 옵션 없이 excel을 upload 할 경우 pivotTable.pivotExcelUpload( {} ); //별도의 옵션을 지정하지 않는 경우 빈 객체를 넘겨야 오류가 나지 않는다.

removeClass( className )

웹스퀘어 컴포넌트에서 class를 삭제. (웹스퀘어 컴포넌트 공통.)
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 config.xml 파일에 아래 설정을 추가해야 함. // config.xml 파일에 아래 설정 추가 <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	삭제 할 class명

Sample

// inputBox의 속성으로 class가 직접 정의된 경우, <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // config.xml 파일에 아래 항목을 추가. <style> <removeDefaultClass value="true" /> </style> // removeClass를 통해 삭제 가능. input1.removeClass("tmpInputClass");

setDisabled( disabled )

웹스퀘어 컴포넌트의 disabled 속성을 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
disabled	Boolean	Y	disabled 상태.

Sample

// 컴포넌트의 disabled 속성을 활성화. componentId.setDisabled(true);

setEventPause( evList , flag )

지정한 이벤트를 중단함. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
evList	String	N	중단할 이벤트 목록. (null을 지정할 경우 해당 컴포넌트의 모든 사용자 이벤트가 중단되거나 중단 해제됨.)
flag	Boolean	Y	이벤트 중단 여부.

Sample

// (예제 1) // onclick 이벤트를 중단. input1.setEventPause("onclick", true); // (예제 2) // onfocus 및 onblur 이벤트의 중단을 해제. input1.setEventPause("onfocus,onblur", false); // (예제 3) // input1에 등록된 모든 사용자 이벤트를 중단. input1.setEventPause(null, true);

setFixedColumn( fixedColNum )

세로 틀고정을 설정한다.

Parameter
name	type	required	description
fixedColNum	Number	Y	맨 왼쪽부터 시작해서 영역을 고정시킬 컬럼들의 수.

Sample

//앞에서 2개 컬럼 틀고정 pivot1.setFixedColumn(1);

setFixedRow( fixedRow )

세로 틀고정을 설정한다.

Parameter
name	type	required	description
fixedRow	Number	Y	맨 왼쪽부터 시작해서 영역을 고정시킬 컬럼들의 수.

Sample

//앞에서 2개 행 틀고정 pivot1.setFixedRow(1);

setInitStyle( property )

웹스퀘어 컴포넌트의 초기 스타일을 복구. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
property	String	N	CSS 속성 (지정하지 않으면 모든 속성의 초기 값으로 복구.)

Sample

// (예제) group1.setInitStyle();

setOpacity( value )

웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
엔진 내부적으로 CSS 속성인 opacity(불투명도)를 설정.

Parameter
name	type	required	description
value	Number	Y	Opacity 값 (0과 1 사이의 실수)

Sample

// (예제) 불투명도를 0.45로 설정 componentId.setOpacity(0.45);

setPivotInit( valsStr )

pivot의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivot을 다시 그립니다. 여러 영역을 한꺼번에 변경할 경우에는 setOption API를 대신 사용합니다.

Parameter
name	type	required	description
valsStr	String	Y	vals영역에 넣을 필드들을 구분자 ,를 이용하여 나열한다. 순서가 바뀌면 그려지는 모양 또한 바뀐다.

Sample

pivotTable.setPivotInit( );

setPosition( left , top , mode )

웹스퀘어 컴포넌트의 위치(left, top)를 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
left	Number	Y	설정할 left 위치 값 또는 null.
top	Number	Y	설정할 top 위치 값 또는 null.
mode	String	N	위치 설정 방법. [default: absolute, delta]

Sample

// (예제) 컴포넌트의 top만 100px로 설정. componentId.setPosition(null, 100);

setReadOnly( readOnly )

웹스퀘어 컴포넌트의 readOnly 속성을 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
readOnly	Boolean	Y	readOnly 속성 활성화 여부. ( "true" : 활성화, "false" : 비활성화)

Sample

// 컴포넌트의 readOnly 속성을 true로 설정하는 예. componentId.setReadOnly(true);

setSize( width , height )

웹스퀘어 컴포넌트의 크기(width, height)를 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
width	Number	Y	새로 설정할 컴포넌트의 width 값 또는 null
height	Number	Y	새로 설정할 컴포넌트의 height 값 또는 null

Sample

// (예제) 컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);

setStyle( propertyName , value )

웹스퀘어 컴포넌트의 CSS 속성을 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
propertyName	String	Y	설정할 CSS 속성
value	String	Y	해당 CSS 속성에 적용할 값

Sample

// (예제 1) 컴포넌트의 width를 200px로 설정 componentId.setStyle("width", "200px"); // (예제 2) 배경색을 olive로 변경 componentId.setStyle("background-color","olive");

setUserData( key , value )

웹스퀘어 컴포넌트에 임의의 데이터를 설정. (웹스퀘어 컴포넌트 공통.)
컴포넌트에 설정 가능한 key를 입력해야 함. 설정 가능한 key가 아닌 경우, 해당 내용이 로그에 출력됨.

Parameter
name	type	required	description
key	String	Y	설정할 데이터의 key
value	String	Y	설정한 데이터의 value

Sample

// 컴포넌트에 'data'라는 key로 'WebSquare'라는 value를 설정하는 예제. componentId.setUserData("data", "WebSquare"); // 컴포넌트에 설정이 불가능한 key를 임력할 경우, key 설정이 불가능. componentId.setUserData("title", "WebSquare"); // 아래와 같이 로그가 출력됨. // !!!WARNING - [title] can't be defined as UserData.

setvals( valsStr )

pivot의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivot을 다시 그립니다. 여러 영역을 한꺼번에 변경할 경우에는 setOption API를 대신 사용합니다.

Parameter
name	type	required	description
valsStr	String	Y	vals영역에 넣을 필드들을 구분자 ,를 이용하여 나열한다. 순서가 바뀌면 그려지는 모양 또한 바뀐다.

Sample

pivotTable.setvals( "field5, field5" ); // vals 영역에 field5,6를 위치시킨다. pivotTable.setvals( "field6, field5" ); // vals 영역에 field6,5를 위치시킨다. 위의 명령과 실행결과가 다르다는 것에 유의한다.

show( displayType )

웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
CSS display 속성을 주어진 값으로 설정하고 "visibility: show;"를 적용.

Parameter
name	type	required	description
displayType	String	N	적용할 CSS display 속성의 값.

Sample

// (예제) display: block; CSS를 설정. componentId.show(); // (예제) 위제 설정한 display 속성 값을 취소하고 원래의 display 값을 복구. componentId.show("");

toggleClass( className )

웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
웹스퀘어 컴포넌트가 파라미터로 주어진 class를 포함한 경우, 해당 class를 제거.
웹스퀘어 컴포넌트에 파라미터로 주어진 class가 없는 경우, 해당 class를 추가.
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
웹스퀘어 컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 config.xml 파일에 아래 설정을 추가. // config.xml 파일에 아래 설정 추가 <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	추가/삭제할 class

Sample

// inputBox 컴포넌트에 class가 속성으로 직접 정의됨. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> //config.xml 파일에 아래를 추가. <style> <removeDefaultClass value="true" /> </style> // tmpInputClass class를 삭제. input1.toggleClass("tmpInputClass"); // (위에서 삭제된) tmpInputClass class를 다시 추가. input1.toggleClass("tmpInputClass");

trigger( type , array )

컴포넌트에서 특정 이벤트를 발생시킴. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
type	String	Y	발생시킬 이벤트
array	Array	N	이벤트 핸들러에 전달할 파라미터 배열

Sample

// (예제 1) // input1 컴포넌트에 onclick 이벤트를 발생시킴. input1.trigger("onclick"); // (예제 2) // input1에 onviewchange 이벤트를 발생시키고 핸들러 함수에 (1,2) 인자를 전달하여 호출. input1.trigger("onviewchange", [1,2]);

unbind( type , function )

컴포넌트에서 이벤트를 제거. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
type	String	N	제거할 이벤트. (생략할 경우 해당 컴포넌트의 모든 이벤트를 제거.)
function	Function	N	제거할 이벤트의 핸들러 함수. (생략할 경우 해당 위에 지정한 이벤트에 등록된 모든 핸들러 함수를 제거.)

Sample

// (예제 1) // input1에 등록된 모든 이벤트를 제거. input1.unbind(); // (예제 2) // input1의 onviewchange 이벤트에 대한 모든 핸들러 함수를 제거. input1.unbind("onviewchange"); // (예제 3) // input1의 onviewchange 이벤트에 대한 func1 이벤트 핸들러 함수를 제거. input1.unbind("onviewchange", func1);

visible( flag )

[deprecated]
show/hide 혹은 setStyle 사용을 권장.
엔진 내부적으로 CSS visibility 속성을 설정.

Parameter
name	type	required	description
flag	Boolean	Y	설정할 CSS visibility 속성 값