PropertyEventMethod찾아보기
WebSquare.uiplugin.pivot - 5.0_1.3521B.20190311.114514

Pivot은 2차원형태의 데이터를 각각의 축에 대한 통계치를 표로 보여준다. 통계치는 Sum, Avg, Count, Minimum, Maximum 등이 있으며 사용자함수로 통계치를 정의할 수 있다. (지원 브라우저: IE10 이상.)

Type

uiplugin

Property Summary

autoFit
[lastColumn, allColumn] pivot table에 정의 된 width에 맞춰 여백이 없이 가득 채워주는 기능으로 가로 스크롤이 생기지 않는다.
autoFitMinWidth
pivot의 최소 width(px단위)를 지정하는 기능으로 autoFit속성의 값이 allColumn일 때 적용된다
autoPopupInvalidMessage
key 입력시 regExp에 정의되지 않은 문자 입력시 자동으로 경고창 띄워줄지 여부
cols
pivotTable을 초기에 보여줄 때 column축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
columnNameFormatter
header의 컬럼 name을 변경할 수 있는 formatter
dataList
pivotTable과 연동할 dataList id
decimalSep
소수 정수 구분 문자
defaultAggregator
[default:Sum]기본 aggregator(통계함수)를 설정하는 옵션이다. field에 정의된 aggregator가 우선순위가 높으며, field에 정의된 aggregator가 없을 경우 해당 옵션의 aggregator를 사용한다.
digitsAfterDecimal
소수점 자릿수
excludeHiddenList
Header의 hiddenList에서도 제외할 column
fixedColumn
pivot의 세로 틀고정 column의 마지막 인덱스
fixedRow
pivot의 가로 틀고정 row의 마지막 인덱스
headerListOrder
HeaderList 순서 정의
hiddenHeaderList
Header에서 보여주지 않을 headerList 정의
id
컴포넌트 id
invalidMessage
validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.
prefix
data 앞에 붙일 문자
renderMode
[default:full]pivotTable을 그릴 때 레이블 영역을 전부 그릴지(full), 레이블 영역을 전부 감추고 테이블만 그릴지(compact)를 선택하는 모드
rows
pivotTable을 초기에 보여줄 때 row축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
scaler
배수 값
showGrandTotal
[default:false]pivotTable의 합계를 출력할지 여부
showZero
data가 없을 경우 0으로 보여줄지 여부
sortFunction
rows,cols,vals 축 각각에 해당하는 data의 순서를 전체적으로 직접 정의하고 싶은 경우 column id를 인자로 받는 사용자함수를 작성한 후 함수명을 해당 옵션으로 입력한다.
suffix
data 뒤에 붙일 문자
thousandsSep
3자리 마다 구분 문자
useNumberFormat
사용자 정의 number format 옵션 사용 여부
userData1
사용자 정의 데이터 속성
userData2
사용자 정의 데이터 속성
userData3
사용자 정의 데이터 속성
vals
pivotTable을 초기에 보여줄 때 value축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
valuesAxis
[default:row] Σ값 레이블이 생성된 경우 (value축 컬럼이 2개 이상인경우) Σ값 레이블의 위치를 설정하는 옵션이다

Event Summary

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

Method Summary

addClass( className )
컴포넌트에 class를 추가한다
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
focus( )
컴포넌트에 focus를 준다
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다
getID( )
웹스퀘어 컴포넌트의 id를 반환한다
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName )
컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style )
[deprecated]getStyle로 사용.
getTitle( )
title 속성값을 반환한다
getTotalRow( )
행의 개수를 반환한다
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( )
컴포넌트를 화면에서 보이지 않도록 숨긴다.
pivotCSVDownload( options )
데이터를 CSV 파일로 저장한다
pivotCSVUpload( options )
csv 파일을 읽어 Pivot의 데이터를 설정한다
pivotExcelDownload( options , infoArr )
Pivot의 데이터를 엑셀 파일로 저장한다
pivotExcelUpload( options )
엑셀 파일을 읽어 Pivot의 데이터를 설정한다
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다
setFixedColumn( fixedColNum )
세로 틀고정을 설정한다
setFixedRow( fixedRow )
세로 틀고정을 설정한다
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPivotInit( valsStr )
pivotTable의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivotTable을 다시 그립니다
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly )
readOnly 속성값을 설정한다
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다
setStyle( propertyName , value )
컴포넌트의 property별 style을 설정한다
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다
setvals( valsStr )
pivotTable의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivotTable을 다시 그립니다
show( displayType )
컴포넌트를 화면에 보이도록 설정한다.
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
trigger( type , array )
컴포넌트에 등록 된 특정 이벤트를 발생시킨다
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

Property Detail

autoFit
[lastColumn, allColumn] pivot table에 정의 된 width에 맞춰 여백이 없이 가득 채워주는 기능으로 가로 스크롤이 생기지 않는다.
allColumn은 여백을 모든 컬럼에 분배하여 조절하며 lastColumn은 마지막 컬럼을 allColumn은 모든 컬럼의 너비를 조정한다.
autoFitMinWidth
pivot의 최소 width(px단위)를 지정하는 기능으로 autoFit속성의 값이 allColumn일 때 적용된다.
autoPopupInvalidMessage
key 입력시 regExp에 정의되지 않은 문자 입력시 자동으로 경고창 띄워줄지 여부
cols
pivotTable을 초기에 보여줄 때 column축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
입력된 column의 순서에 따라 결과가 달라진다.
columnNameFormatter
header의 컬럼 name을 변경할 수 있는 formatter
dataList
pivotTable과 연동할 dataList id
decimalSep
소수 정수 구분 문자. useNumberFormat true일 경우 적용.
defaultAggregator
[default:Sum]기본 aggregator(통계함수)를 설정하는 옵션이다. field에 정의된 aggregator가 우선순위가 높으며, field에 정의된 aggregator가 없을 경우 해당 옵션의 aggregator를 사용한다.
aggregator는 Sum, Average, Count, Minimum, Maximum 등 기본적으로 제공되는 aggregator외에 사용자 정의 함수 aggregator를 등록할 수 있다.
digitsAfterDecimal
소수점 자릿수. useNumberFormat true일 경우 적용.
excludeHiddenList
Header의 hiddenList에서도 제외할 column.
fixedColumn
pivot의 세로 틀고정 column의 마지막 인덱스.
fixedRow
pivot의 가로 틀고정 row의 마지막 인덱스.
headerListOrder
HeaderList 순서 정의.
hiddenHeaderList
Header에서 보여주지 않을 headerList 정의.
id
컴포넌트 id
invalidMessage
validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.
invalidMessageFunc과 동시 적용이 불가하다.
prefix
data 앞에 붙일 문자. useNumberFormat true일 경우 적용.
renderMode
[default:full]pivotTable을 그릴 때 레이블 영역을 전부 그릴지(full), 레이블 영역을 전부 감추고 테이블만 그릴지(compact)를 선택하는 모드.
rows
pivotTable을 초기에 보여줄 때 row축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
입력된 column의 순서에 따라 결과가 달라진다.
scaler
배수 값. useNumberFormat true일 경우 적용.
showGrandTotal
[default:false]pivotTable의 합계를 출력할지 여부
showZero
data가 없을 경우 0으로 보여줄지 여부. useNumberFormat true일 경우 적용.
sortFunction
rows,cols,vals 축 각각에 해당하는 data의 순서를 전체적으로 직접 정의하고 싶은 경우 column id를 인자로 받는 사용자함수를 작성한 후 함수명을 해당 옵션으로 입력한다.
field 각각의 sortOrder 속성을 통해 보다 쉽게 출력되는 data 순서를 조작할 수 있다.
이 속성이 정의되어있고 해당 사용자함수가 존재하는경우 field에 정의된 sortOrder 속성은 무시된다.
suffix
data 뒤에 붙일 문자. useNumberFormat true일 경우 적용.
thousandsSep
3자리 마다 구분 문자. useNumberFormat true일 경우 적용.
useNumberFormat
사용자 정의 number format 옵션 사용 여부. (digitsAfterDecimal, scaler, showZero, decimalSep, thousandsSep, prefix, suffix)
userData1
사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2
사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3
사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
vals
pivotTable을 초기에 보여줄 때 value축에 둘 컬럼을 정의한다. 구분자","를 통해 column id를 입력한다.
vals로 설정된 column이 2개 이상일 경우 Σ값 레이블이 생성된다.
입력된 column의 순서에 따라 결과가 달라진다.
valuesAxis
[default:row] Σ값 레이블이 생성된 경우 (value축 컬럼이 2개 이상인경우) Σ값 레이블의 위치를 설정하는 옵션이다.

Event Detail

onrefresh
pivotTable 설정이 동적으로 바뀐경우 (축을 옮기거나, aggregator가 바뀌거나, exclusions이 바뀌는 등) 발생하는 이벤트.
Parameter
nametypedescription
optionsJSONpivotTable의 options(rows, cols, vals 등) 객체

Method Detail

addClass( className )
컴포넌트에 class를 추가한다.
Parameter
nametyperequireddescription
classNameStringY추가하고 싶은 class의 이름
Sample
//input1 컴포넌트에 oddClass 라는 class를 추가 할 때 input1.addClass("oddClass");
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다.
Parameter
nametyperequireddescription
eventTypeStringY할당 할 이벤트명.
functionFunctionY동적으로 할당 할 이벤트의 핸들러 function.
Sample
//input1에 onclick 이벤트에 핸들러 function을 직접 정의하여 bind. input1.bind("onclick", function(e){ alert(input1.getValue();})); //input1에 onclick 이벤트에 미리 정의 한 commObj.ev_click function을 bind. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; input1.bind("onclick", commObj.ev_click );
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
oldClassNameStringY삭제 할 class의 이름
newClassNameStringY추가 할 class의 이름
Sample
//아래와 같이 input 컴포넌트에 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를 tmpInputWarninClass로 변경 input1.changeClass("tmpInputClass","tmpInputWarninClass");
focus( )
컴포넌트에 focus를 준다.
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다.
Return
typedescription
Booleandisabled 속성값
Sample
var returnValue = componentId.getDisabled(); return 예시 ) false
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다.
Return
typedescription
Object부모 generator 객체
Sample
<w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> scwin.trigger1.onclick = function(){ console.log(this.getGenerator());} // trigger1 클릭 시 generator1 객체가 console에 찍힌다. // https://inswave.com/jira/browse/WPF-1425 참조
getID( )
웹스퀘어 컴포넌트의 id를 반환한다.
Return
typedescription
String웹스퀘어 컴포넌트의 id
Sample
//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다.
Return
typedescription
IntegerOpacity 값
Sample
//아래와 같이 input 컴포넌트에 opcacity css를 적용 한 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> var returnValue = input1.getOpacity(); // returnValue는 0~1사이의 실수이다. //return 예시 ) "0.2"
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다.
Return
typedescription
String웹스퀘어 컴포넌트의 pluginName
Sample
//아래와 같이 공통 function에서 동적으로 웹스퀘어 객체를 받았을 때 컴포넌트의 종류에 따른 분기처리를 할수 있다. 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
nametyperequireddescription
positionNameStringY[left,top]위치 종류
Return
typedescription
Number컴포넌트의 위치 값
Sample
//아래와 같이 input 컴포넌트에 margin css를 적용했을 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> var returnValue = input1.getPosition("top"); // returnValue는 픽셀 단위의 위치 값이다. //return 예시 ) 10
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다.
Return
typedescription
Boolean현재 설정되어있는 readOnly 속성
Sample
var returnValue = componentId.getReadOnly(); //return 예시 ) false
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다.%로 설정된 경우, 픽셀로 변환하여 반환한다.
Parameter
nametyperequireddescription
sizeNameStringY[height,innerHeight,outerHeight,outerMarginHeight,width,innerWidth,outerWidth,outerMarginWidth]크기 값의 종류. szieName별 계산 방법은 아래를 참고.
height : element.clientHeight innerHeight : element.clientHeight + padding outerHeight : element.clientHeight + padding + border outerMarginHeight : element.clientHeight + padding + border + margin width : element.clientWidth innerWidth : element.clientWidth + padding outerWidth : element.clientWidth + padding + border outerMarginWidth : element.clientWidth + padding + border + margin
Return
typedescription
Number컴포넌트의 크기 값
Sample
var returnValue = componentId.getSize("width"); // returnValue는 픽셀 단위의 크기 값이다. %로 설정된 경우, 픽셀로 변환하여 반환한다. //return 예시 ) 100
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.
Parameter
nametyperequireddescription
propertyNameStringY반환 할 style의 property 이름
Return
typedescription
Stringstyle의 속성값
Sample
//아래와 같이 input 컴포넌트가 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;"></xf:input> var returnValue = input1.getStyle("width"); //return 예시 ) "144px"
getStyleValue( style )
[deprecated]getStyle로 사용.
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.
Parameter
nametyperequireddescription
styleStringY정의 된 style에서 사용자가 반환 받고자하는 속성명.
Return
typedescription
Stringstyle 속성에 정의 된 값(색을 반환하는 경우에는 색HexCode로 반환)
getTitle( )
title 속성값을 반환한다.
Return
typedescription
Stringtitle 속성값.
Sample
//아래와 같이 input 컴포넌트에 title이 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); //return 예시 ) "이름 입력"
getTotalRow( )
행의 개수를 반환한다. (5.0_1.2701A.20170714.211228 버전에서 추가.)
Return
typedescription
Number행의 개수
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다.
Parameter
nametyperequireddescription
keyStringY임의 데이터의 키
Return
typedescription
Stringkey에 해당하는 데이터
Sample
//아래와 같이 input 컴포넌트의 사용자 속성(eduTest)이 적용 된 경우. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" eduTest="Hello"></xf:input> input1.getUserData("eduTest"); //return 예시 ) "Hello" //setUserData를 통해 set한 경우 input1.setUserData("eduTest","WebSquare"); input1.getUserData("WebSquare"); //return 예시 ) "Hello"
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다.
Parameter
nametyperequireddescription
classNameStringY검색 할 className
Return
typedescription
Booleanclass를 가지고 있는지의 여부
Sample
//아래와 같이 input 컴포넌트에 class가 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> var returnValue = input1.hasClass("tmpInputClass"); //return 예시 ) true
hide( )
컴포넌트를 화면에서 보이지 않도록 숨긴다.
엔진 내부적으로는 CSS를 display:none;과 visibility:hidden;으로 처리한다.
Sample
componentId.hide();
pivotCSVDownload( options )
데이터를 CSV 파일로 저장한다. (JDK 1.5이상에서 사용 가능)
Parameter
nametyperequireddescription
optionsJSONYJSON형태로 저장된 Pivot의 csv 다운로드 옵션
<String:N> options.fileName [default: csvfile.csv] 엑셀파일 선택 대화상자가 나타날 때 기본으로 지정 될 파일 이름 <String:N> options.delim [default: ';'] CSV 파일에서 데이터를 구분할 구분자 <String:N> options.useHeaderX [default: false] Axis 영역을 포함한 headerX 저장 여부 (true: 저장, false: 저장 하지 않음) <String:N> options.useHeaderY [default: false] Axis 영역을 포함한 headerY 저장 여부 (true: 저장, false: 저장 하지 않음) <String:N> options.useTotal [default: false] 합계 영역 저장 여부 (true: 저장, false: 저장 하지 않음)
Sample
//저장 할 컬럼 정의 var colArr = []; colArr[0] = "name"; colArr[1] = "corp"; //저장 옵션 var options = { fileName: "saveCSV.csv", delim: ";" }; pivotTable1.pivotCSVDownload(options); //별도의 옵션이 없을 경우 빈 객체를 파라메터로 넘겨줘야 한다. pivotTable1.pivotCSVDownload({});
pivotCSVUpload( options )
csv 파일을 읽어 Pivot의 데이터를 설정한다. (JDK 1.5이상에서 사용 가능)
Parameter
nametyperequireddescription
optionsJSONYJSON형태로 저장된 Pivot의 csv 업로드 옵션
<String:N> options.delim [default: ',']CSV 파일에서 데이터를 구분할 구분자 <String:N> options.escapeChar CSV 데이터에서 제거해야 되는 문자셋 ( ex) '\'' ) <Number:N> options.startRowIndex [defalut: 0] csv파일에서 Pivot의 데이터가 시작되는 행의 번호, startRowIndex가 설정되면, header 설정은 무시된다. <String:N> options.skipSpace [defalut: 0, 1]공백무시 여부(1이면 무시 0이면 포함) <String:N> options.append [defalut: 0, 1]csv파일에서 가져온 데이터를 Pivot에 append시킬지 여부(1이면 현재 Pivot에 데이터를 추가로 넣어줌 0이면 현재 Pivot의 데이터를 삭제하고 넣음) <String:N> options.popupUrl 업로드시에 호출할 popup의 url
Sample
var options = { delim: ",", escapeChar: "'", startRowIndex: 1 }; pivotTable1.pivotCSVUpload(options); //별도의 옵션이 없을 경우 빈 객체를 파라메터로 넘겨줘야 한다. pivotTable1.pivotCSVUpload({});
pivotExcelDownload( options , infoArr )
Pivot의 데이터를 엑셀 파일로 저장한다. (JDK 1.5이상에서 사용 가능)
Parameter
nametyperequireddescription
optionsObjectYJSON형태로 저장된 Pivot의 엑셀 다운로드 옵션
<String:Y> options.fileName : [defalut: excel.xls] 다운로드하려는 파일의 이름으로 필수 입력 값이다. <String:N> options.sheetName : [defalut: sheet] excel의 sheet의 이름 <Number:N> options.startRowIndex : [defalut: 0] excel파일에서 Pivot의 데이터가 시작되는 행의 번호(헤더 포함) <Number:N> options.startColumnIndex : [defalut: 0] excel파일에서 Pivot의 데이터가 시작되는 열의 번호(헤더 포함) <String:N> options.axisLColor : [defalut: #FFFFFF] excel파일에서 좌측 상단 axis 영역의 색 <String:N> options.axisLFontName : [defalut: 없음] excel파일에서 좌측 상단 axis 영역의 font name <String:N> options.axisLFontSize : [defalut: 10] excel파일에서 좌측 상단 axis 영역의 font size <String:N> options.axisLFontColor : [defalut: 없음] excel파일에서 좌측 상단 axis 영역의 font색 <String:N> options.axisLFontWeight : [defalut: 없음] excel파일에서 좌측 상단 axis 영역의 Bold 지정( ex) "bold" ); <String:N> options.axisLTextAlign : [defalut: 없음] excel파일에서 좌측 상단 axis 영역의 정렬값 ("center", "right", "left") <String:N> options.axisRColor : [defalut: #FFFFFF] excel파일에서 우측 상단 axis 영역의 색 <String:N> options.axisRFontName : [defalut: 없음] excel파일에서 우측 상단 axis 영역의 font name <String:N> options.axisRFontSize : [defalut: 10] excel파일에서 우측 상단 axis 영역의 font size <String:N> options.axisRFontColor : [defalut: 없음] excel파일에서 우측 상단 axis 영역의 font색 <String:N> options.axisRFontWeight : [defalut: 없음] excel파일에서 우측 상단 axis 영역의 Bold 지정( ex) "bold" ); <String:N> options.axisRTextAlign : [defalut: 없음] excel파일에서 우측 상단 axis 영역의 정렬값 ("center", "right", "left") <String:N> options.axisBColor : [defalut: #FFFFFF] excel파일에서 하단 상단 axis 영역의 색 <String:N> options.axisBFontName : [defalut: 없음] excel파일에서 하단 상단 axis 영역의 font name <String:N> options.axisBFontSize : [defalut: 10] excel파일에서 하단 상단 axis 영역의 font size <String:N> options.axisBFontColor : [defalut: 없음] excel파일에서 하단 상단 axis 영역의 font색 <String:N> options.axisBFontWeight : [defalut: 없음] excel파일에서 하단 상단 axis 영역의 Bold 지정( ex) "bold" ); <String:N> options.axisBTextAlign : [defalut: 없음] excel파일에서 하단 상단 axis 영역의 정렬값 ("center", "right", "left") <String:N> options.headerXColor : [defalut: #FFFFFF] excel파일에서 상단 header 영역의 색 <String:N> options.headerXFontName : [defalut: 없음] excel파일에서 상단 header 영역의 font name <String:N> options.headerXFontSize : [defalut: 10] excel파일에서 상단 header 영역의 font size <String:N> options.headerXFontColor : [defalut: 없음] excel파일에서 상단 header 영역의 font색 <String:N> options.headerXFontWeight : [defalut: 없음] excel파일에서 상단 header 영역의 Bold 지정( ex) "bold" ); <String:N> options.headerXTextAlign : [defalut: 없음] excel파일에서 상단 header 영역의 정렬값 ("center", "right", "left") <String:N> options.headerXWidth : [defalut: 없음] excel파일에서 상단 header 컬럼의 width 값 <String:N> options.headerYColor : [defalut: #FFFFFF] excel파일에서 좌측축 영역의 색 <String:N> options.headerYFontName : [defalut: 없음] excel파일에서 좌측축 영역의 font name <String:N> options.headerYFontSize : [defalut: 10] excel파일에서 좌측축 영역의 font size <String:N> options.headerYFontColor : [defalut: 없음] excel파일에서 좌측축 영역의 font색 <String:N> options.headerYFontWeight : [defalut: 없음] excel파일에서 좌측축 영역의 Bold 지정 ( ex) "bold" ) <String:N> options.headerYTextAlign : [defalut: 없음] excel파일에서 좌측축 영역의 정렬값 ("center", "right", "left") <String:N> options.headerYWidth : [defalut: 없음] excel파일에서 좌측축 컬럼의 width 값 <String:N> options.totalXColor : [defalut: #FFFFFF] excel파일에서 상단 header의 합계 영역의 색 <String:N> options.totalXFontName : [defalut: 없음] excel파일에서 상단 header의 합계 영역의 font name <String:N> options.totalXFontSize : [defalut: 10] excel파일에서 상단 header의 합계 영역의 font size <String:N> options.totalXFontColor : [defalut: 없음] excel파일에서 상단 header의 합계 영역의 font색 <String:N> options.totalXFontWeight : [defalut: 없음] excel파일에서 상단 header의 합계 영역의 Bold 지정 ( ex) "bold" ) <String:N> options.totalXTextAlign : [defalut: 없음] excel파일에서 상단 header의 합계 영역의 정렬값 ("center", "right", "left") <String:N> options.totalXWidth : [defalut: 없음] excel파일에서 상단 header의 합계 컬럼의 width 값 <String:N> options.totalYColor : [defalut: #FFFFFF] excel파일에서 좌측축의 합계 영역의 색 <String:N> options.totalYFontName : [defalut: 없음] excel파일에서 좌측축의 합계 영역의 font name <String:N> options.totalYFontSize : [defalut: 10] excel파일에서 좌측축의 합계 영역의 font size <String:N> options.totalYFontColor : [defalut: 없음] excel파일에서 좌측축의 합계 영역의 font색 <String:N> options.totalYFontWeight : [defalut: 없음] excel파일에서 좌측축의 합계 영역의 Bold 지정 ( ex) "bold" ) <String:N> options.totalYTextAlign : [defalut: 없음] excel파일에서 좌측축의 합계 영역의 정렬값 ("center", "right", "left") <String:N> options.totalYFormat : [defalut: 없음] excel파일에서 좌측축의 합계 영역의 format (ex) #,###) <String:N> options.totalYWidth : [defalut: 없음] excel파일에서 좌측축의 합계 영역 컬럼의 width값 <String:N> options.bodyColor : [defalut: #FFFFFF] excel파일에서 body영역의 색 <String:N> options.bodyFontName : [defalut: 없음] excel파일에서 body영역의 font name <String:N> options.bodyFontSize : [defalut: 10] excel파일에서 body영역의 font size <String:N> options.bodyFontColor : [defalut: 없음] excel파일에서 body영역의 font색 <String:N> options.bodyFontWeight : [defalut: 없음] excel파일에서 body영역의 Bold 지정 ( ex) "bold" ) <String:N> options.bodyTextAlign : [defalut: 없음] excel파일에서 body영역의 정렬값 ("center", "right", "left") <String:N> options.bodyFormat : [defalut: 없음] excel파일에서 body영역의 format (ex) #,###) <String:N> options.bodyWidth : [defalut: 없음] excel파일에서 body영역 컬럼의 width 값 <String:N> options.bodyDefaultValue : [defalut: 없음] excel파일에서 body영역 컬럼값이 비어있는 경우 대체할 수 있는 값설정 <String:N> options.sumColor : [defalut: #FFFFFF] excel파일에서 body 영역의 합계부분의 색 <String:N> options.sumFontName : [defalut: 없음] excel파일에서 body 영역의 합계부분의 font name <String:N> options.sumFontSize : [defalut: 10] excel파일에서 body 영역의 합계부분의 font size <String:N> options.sumFontColor : [defalut: 없음] excel파일에서 body 영역의 합계부분의 font색 <String:N> options.sumFontWeight : [defalut: 없음] excel파일에서 body 영역의 합계부분의 Bold 지정 ( ex) "bold" ) <String:N> options.sumTextAlign : [defalut: 없음] excel파일에서 body 영역의 합계부분의 정렬값 ("center", "right", "left") <String:N> options.sumFormat : [defalut: 없음] excel파일에서 body 영역의 합계부분의 format (ex) #,###) <String:N> options.sumWidth : [defalut: 없음] excel파일에서 body 영역 컬럼의 width 값 <Boolean:N> options.showProcess : [defalut: true] 다운로드 시 프로세스 창을 보여줄지 여부 <Boolean:N> options.bodyWordwrap : [defalut: false] 다운로드시 바디의 줄 바꿈 기능 <String:N> options.useHeaderX : [defalut: true] 다운로드시 상단 Header를 출력 할지 여부( "true"인경우 출력, "false"인경우 미출력) <String:N> options.useHeaderY : [defalut: true] 다운로드시 좌측 Header를 출력 할지 여부( "true"인경우 출력, "false"인경우 미출력) <String:N> options.useTotal : [defalut: true] 다운로드시 합계를 출력 할지 여부( "true"인경우 출력, "false"인경우 미출력) <String:N> options.separator : [defalut: ,] 다운로드시 서버로 데이터 전송할때, 데이터를 구분짓는 구분자, default는 comma(,) <String:N> options.freezePane : [defalut: ""] 틀고정을 위한 좌표값 및 좌표값의 오픈셋 ( ex) freezePane="3,4" X축 3, Y축 4에서 틀고정, freezePane="0,1,0,5" X축 0, Y축 1에서 X축으로 0, Y축으로 5로 틀공정 ) <String:N> options.autoSizeColumn : [defalut: false] 너비자동맞춤 설정 유무 <String:N> options.displayGridlines : [defalut: false] 엑셀 전체 셀의 눈금선 제거 유무 <String:N> options.useDataFormat : [defalut: 없음] Pivot dataType이 text인 경우, 엑셀의 표시형식 '텍스트' 출력 유무( "true"인 경우 표시형식 텍스트, "false"인 경우 표시형식 일반 출력) <Object:N> options.printSet JSON형태로 저장된 Excel Print관련 설정 <String:N> options.printSet.fitToPage : [defalut: false] 엑셀 프린터 출력시 쪽맞춤 사용 유무 <String:N> options.printSet.landScape : [defalut: false] 엑셀 프린터 출력시 가로 방향 출력 유무 <String:N> options.printSet.fitWidth : [defalut: 1] 엑셀 프린터 출력시 용지너비 <String:N> options.printSet.fitHeight : [defalut: 1] 엑셀 프린터 출력시 용지높이 <String:N> options.printSet.scale : [defalut: 100] 엑셀 프린터 출력시 확대/축소 배율, scale을 사용할 경우 fitToPage는 false로 설정 해야 한다. <String:N> options.printSet.pageSize : [defalut: A4] 엑셀 프린터 출력시 인쇄 용지 크기 (예: "A3", "A4", "A5", "B4") 단, fitToPage: true 인 경우에만 유효.
infoArrObjectNPivot에 대한 내용을 추가로 다른 셀에 표현하는 경우 사용하는 배열
<Number:N> infoArr.rowIndex : 내용을 표시할 행번호 <Number:N> infoArr.colIndex : 내용을 표시할 열번호 <Number:N> infoArr.rowSpan : 병합할 행의 수 <Number:N> infoArr.colSpan : 병합할 열의 수 <String:N> infoArr.text : 표시할 내용 <String:N> infoArr.textAlign : 표시할 내용의 정렬 방법 (left, center, right) <String:N> infoArr.fontSize : font size 설정 ( ex) "20px" ) <String:N> infoArr.fontName : font name 설정 <String:N> infoArr.color : font color 설정 ( ex) "red" ) <String:N> infoArr.fontWeight : font weight 설정 ( ex) "bold" ) <String:N> infoArr.drawBorder : cell의 border 지정 ( ex) true ) <String:N> infoArr.wordWrap : cell의 줄 바꿈 기능 ( ex) "true" ) <String:N> infoArr.bgColor : cell의 배경 color 설정 ( ex) "red" )
Sample
//별도의 옵션 없이 excel을 download 할 경우 var excelOpt = {}; //excel download 옵션 excelOpt.fileName = "excelData.xls"; //또는 xlsx 확장자 사용 pivotTable1.pivotExcelDownload( excelOpt );
pivotExcelUpload( options )
엑셀 파일을 읽어 Pivot의 데이터를 설정한다. (JDK 1.5이상에서 사용 가능)
Parameter
nametyperequireddescription
optionsObjectYJSON형태로 저장된 Pivot의 엑셀 업로드 옵션
<Number:N> options.sheetNo : [defalut: 0] excel파일에서 Pivot의 데이터가 있는 sheet번호 <String:N> options.delim : 업로드시 데이터를 구분하는 구분자 (default: , ) <Number:N> options.startRowIndex : [defalut: 0] excel파일에서 Pivot의 데이터가 시작되는 행의 번호(헤더 포함) <Number:N> options.startColumnIndex: [defalut: 0] excel파일에서 Pivot의 데이터가 시작되는 열의 번호 <Number:N> options.endColumnIndex : [defalut: 0] excel파일에서 Pivot의 데이터가 끝나는 열의 index ( 엑셀컬럼수가 Pivot컬럼수 보다 작은 경우 Pivot 컬러수를 설정) <String:N> options.skipSpace [defalut: 0, 1]공백무시 여부(1이면 무시 0이면 포함) <String:N> options.append : [defalut: 0] excel파일에서 가져온 데이터를 Pivot에 append시킬지 여부(1이면 현재 Pivot에 데이터를 추가로 넣어줌 0이면 현재 Pivot의 데이터를 삭제하고 넣음) <String:N> options.popupUrl : 업로드시에 호출할 popup의 url
Sample
//별도의 옵션 없이 excel을 upload 할 경우 pivotTable1.pivotExcelUpload( {} ); //별도의 옵션을 지정하지 않는 경우 빈 객체를 넘겨야 오류가 나지 않는다.
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
classNameStringY삭제 할 class명
Sample
//아래와 같이 input 컴포넌트에 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.removeClass("tmpInputClass");
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다. disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력한다.
Parameter
nametyperequireddescription
disabledBooleanYdisabled 속성을 활성화 시키려면 true 비활성화 시키려면 false
Sample
//컴포넌트의 disabled 적용 componentId.setDisabled(true);
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다.
Parameter
nametyperequireddescription
evListStringN대상 이벤트 목록. 해당 인자가 주어지지 않을 경우 해당 컴포넌트의 모든 사용자 이벤트가 대상이 된다. (null을 지정하면 된다.)
flagBooleanYtrue인 경우 pause시키며, false인 경우 pause를 해제한다.
Sample
input1.setEventPause("onclick", true); //onclick이벤트를 동적으로 pause 한다. input1.setEventPause("onfocus,onblur", false); //onfocus이벤트와 onblur이벤트의 pause를 해제한다. input1.setEventPause(null, true); //input에 등록된 모든 사용자 이벤트를 pause 한다.
setFixedColumn( fixedColNum )
세로 틀고정을 설정한다.
Parameter
nametyperequireddescription
fixedColNumNumberY맨 왼쪽부터 시작해서 영역을 고정시킬 컬럼들의 수.
Sample
//앞에서 2개 컬럼 틀고정 pivot1.setFixedColumn(1);
setFixedRow( fixedRow )
세로 틀고정을 설정한다.
Parameter
nametyperequireddescription
fixedRowNumberY맨 왼쪽부터 시작해서 영역을 고정시킬 컬럼들의 수.
Sample
//앞에서 2개 행 틀고정 pivot1.setFixedRow(1);
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다.
Parameter
nametyperequireddescription
valueNumberYOpacity 값 (0과 1사이의 실수)
Sample
componentId.setOpacity(0.45);
setPivotInit( valsStr )
pivotTable의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivotTable을 다시 그립니다. 여러 영역을 한꺼번에 변경할 경우에는 setOption API를 대신 사용합니다.
Parameter
nametyperequireddescription
valsStrStringYvals영역에 넣을 필드들을 구분자 ,를 이용하여 나열한다. 순서가 바뀌면 그려지는 모양 또한 바뀐다.
Sample
pivotTable1.setPivotInit( );
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다.
Parameter
nametyperequireddescription
leftNumberYleft의 값 또는 null.
topNumberYtop의 값 또는 null.
modeStringN[defulat:absolute, delta]absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정.
Sample
//컴포넌트의 top만 100px로 설정. componentId.setPosition(null, 100);
setReadOnly( readOnly )
readOnly 속성값을 설정한다. readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.
Parameter
nametyperequireddescription
readOnlyBooleanYreadOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false
Sample
//컴포넌트의 readonly 적용. componentId.setReadOnly(true);
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다.
Parameter
nametyperequireddescription
widthNumberY새로 설정할 컴포넌트의 width값 또는 null
heigthNumberY새로 설정할 컴포넌트의 height값 또는 null
Sample
//컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);
setStyle( propertyName , value )
컴포넌트의 property별 style을 설정한다.
Parameter
nametyperequireddescription
propertyNameStringYstyle 속성 이름
valueStringY적용 할 style의 값
Sample
//컴포넌트의 width를 200px로 설정 할 경우 componentId.setStyle("width", "200px"); //배경색을 olive로 변경 할 경우 componentId.setStyle("background-color","olive");
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다. 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하며 log에 관련 내용이 출력 된다.
Parameter
nametyperequireddescription
keyStringY임의 데이터의 키
valueStringY임의 데이터의 값
Sample
//컴포넌트에 'data'라는 key로 'WebSquare'라는 값을 설정 할 경우 componentId.setUserData("data", "WebSquare"); //아래와 같이 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare"); //log 표현 예시 ) !!!WARNING - [title] can't define as UserData
setvals( valsStr )
pivotTable의 vals 영역을 새로 설정한 후 해당 설정에 맞게 pivotTable을 다시 그립니다. 여러 영역을 한꺼번에 변경할 경우에는 setOption API를 대신 사용합니다.
Parameter
nametyperequireddescription
valsStrStringYvals영역에 넣을 필드들을 구분자 ,를 이용하여 나열한다. 순서가 바뀌면 그려지는 모양 또한 바뀐다.
Sample
pivotTable1.setvals( "field5, field5" ); // vals 영역에 field5,6를 위치시킨다. pivotTable1.setvals( "field6, field5" ); // vals 영역에 field6,5를 위치시킨다. 위의 명령과 실행결과가 다르다는 것에 유의한다.
show( displayType )
컴포넌트를 화면에 보이도록 설정한다.
엔진 내부적으로는 CSS를 display속성과 visibility:show;으로 처리한다.
Parameter
nametyperequireddescription
displayTypeStringN[default:block ,inline ,none ,""]display의 속성 값.
Sample
//display 속성이 "block"이 된다. componentId.show(); //class에 적용된 display 속성 값을 다시 복구. componentId.show("");
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
기본 설정은 addClass API를 통해 추가 된 class만 삭제되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
classNameStringY설정 할 className
Sample
//아래와 같이 input 컴포넌트에 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
nametyperequireddescription
typeStringY발생시킬 이벤트 이름
arrayArrayN이벤트 핸들러에 전달할 파라미터 배열
Sample
//input1 컴포넌트에 onclick이벤트를 발생시킨다. input1.trigger("onclick"); //input1에 onviewchange이벤트를 발생시키고 핸들러 함수에 (1,2) 인자를 전달하여 호출한다. input1.trigger("onviewchange", [1,2]);
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다.
Parameter
nametyperequireddescription
typeStringN제거할 이벤트 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
functionFunctionN제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 type으로 등록된 모든 핸들러 함수를 제거한다.
Sample
//input1에 등록된 모든 이벤트를 제거 input1.unbind(); //input1에 등록된 onviewchange이벤트 핸들러 함수를 모두 제거 input1.unbind("onviewchange"); //input1에 등록된 onviewchange이벤트에서 func1 이벤트 핸들러를 제거 input1.unbind("onviewchange", func1);
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.
컴포넌트의 style 중 visibility 값을 설정한다. true이면 "visible", false이면 "hidden"을 설정.
Parameter
nametyperequireddescription
flagBooleanYvisibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)