WebSquare.uiplugin.chart

다양한 통계를 출력할 수 있는 컴포넌트로 type속성을 이용하여 차트의 타입 변경이 가능하다.
기본적으로 ColumnChart, BarChart, LineChart, RadialChart, PieChart외 3D타입 등 대략 22종 정도가 지원되며 2가지 타입의 차트를 적용하는 2중차트까지 사용할 수있다.
본 컴포넌트는 모바일에서 사용을 권장하고 있지않으며 FusionChart 컴포넌트를 권장한다.
컴포넌트의 최상위는 HTML div Tag로 이루어져있으며 하위로 복합 Tag들로 구성되어있다.

Type

uiplugin

Property Summary

axis3dBackgroundColor: X,Y축의 배경의 색상값으로 type속성의 값이 3D 차트인 경우만 적용된다
axis3dBorderColor: X,Y축의 선의 색상값으로 type속성의 값이 3D 차트인 경우만 적용된다
backgroundBorderColor: 컴포넌트 상위 테두리의 선의 색상값
backgroundBorderWidth: 컴포넌트 상위 테두리의 선의 굵기값
backgroundGradient: [default:true, false]상위 레이아웃의 배경 그라데이션의 사용 여부
bgColorPalette: [default:#ECEDED #FFFFFF]상위 레이아웃의 배경 그리드(가이드라인)의 홀/짝의 배경 색상값으로 공백으로 구분하여 정의한다.
dataAxisChanged: [default:false, true]series의 묶음 기준을 데이터 기반으로 표현할지의 여부
displayFormat: 데이터에 적용할 format으로 화면에 표현되는 데이터의 label에 적용된다
displayFormatter: 화면에 표현되는 데이터의 label에 format을 적용할 Function명
displayXAxis: [default:true, false]X축의 label을 표시할지의 여부
displayYAxis: [default:true, false]Y축의 label을 표시할지의 여부
elementTitle: 차트가 표현되는 영역에 HTML의 title속성을 정의한다.
fitGuidLine: [default:false, true]가이드라인의 영역(갯수)을 타이트하게 구성하여 차트를 그릴지의 여부
gradientColorPalette: [default:#d8dfe0 #fafdfe]상위 레이아웃의 배경에 그라데이션을 사용할 경우 그라데이션의 시작과 끝의 색상값으로 공백으로 구분하여 정의한다.
guidLineStyle: 가이드라인 영역의 선의 색과 굵기를 설정한다
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
labelData: [default:false, true]데이터가 표현되는 label에 항목의 이름(labelNode속성에 입력한 컬럼/노드의 값)을 포함할지 여부
labelNode: 데이터의 기준축의 label로 표현될 컬럼의 ID 또는 XPath
labelPerValue: 차트의 데이터가 muliti일 경우 내부에 표시되는 label에 Series의 백분율 값을 포함할지 여부
labelSeparator: 차트 내부에 표시되는 label에 포함되는 값들 사이에 위치할 구분자
labelSeries: 차트 내부에 표시되는 label에 계열(series)이름을 포함할지 여부
labelValue: 차트 내부에 표시되는 label에 값(value)을 포함할지 여부
lineStyle: 차트 series의 기본 라인 스타일 // 사용 예 border-width:2px</xmp>
mainGrid: 주축 눈금 선을 표시할지 여부
mainGridLineOnly: 주축 눈금선만 표시(투명 그리드 배경)
maxYAxis: 차트의 Y축의 최대값
minYAxis: 차트의 Y축의 최소값
ref: dataCollection으로 chart 데이터 연동 시 사용
rootNode: 차트에서 쓰일 데이터 xml의 xpath
roundRectangle: 배경 둥근 모서리 사용 여부
seriesBorderColor: 차트의 series들이 가지는 border 색상 코드 값들을 공백으로 구분한 string
seriesBorderWidth: 차트의 series들이 가지는 border width값들을 공백으로 구분한 string
seriesColor: 차트의 series들이 가지는 색상 코드 값들을 공백으로 구분한 string
seriesPosition: series 표시 위치
seriesShow: series 표시 유무
seriesSymbol: 차트의 series들이 symbol의 값들을 공백으로 구분한 string "square" "circle" "triangle-down" "diamond" "triangle-down"</xmp>
subGrid: 보조축 눈금선 표시 여부
tableDisplayFormat: 테이블 display format string
tableDisplayFormatter: 테이블 display 사용자 정의 formatter function name
tableShow: 차트의 data table의 표시 유무
title: 차트 타이틀
titlePosition: 차트의 title이 가지는 css position 속성 값
titleShow: 차트 타이틀 표시 유무
titleStyle: 차트 타이틀 Style
toolTip: 컴포넌트 toolTip
type: 차트 유형
usePopup: popup 사용 여부
valueType: 차트 value의 타입
xAxisTitle: X축 타이틀
xAxisTitleShow: X축 타이틀 표시 여부
xAxisTitleStyle: X축 타이틀 style
y1AxisTitle: Y축 타이틀
y1AxisTitleShow: Y축 타이틀 표시 여부
y1AxisTitleStyle: Y축 타이틀 style
y1DisplayFormat: Y 축 display format string
y1DisplayFormatter: Y 축 display 사용자 정의 formatter function name
y2DisplayFormat: 이중 차트에서 Y 축 display format string
y2DisplayFormatter: 이중 차트에서 Y 축 display 사용자 정의 formatter function name

Event Summary

Method Summary

addClass( className ): 컴포넌트에 class를 추가한다
appendXML( data , maxCount , modify ): xml data를 입력받아 기존 data에 추가합니다
applySeriesConfig( useDoubleChart , seriesUseChk , seriesAxisChk , chartType , chartType ): chart의 series에 관한 설정을 합니다
bind( eventType , function ): 컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName ): 컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
deleteData( ): chart의 데이터를 지웁니다
excelDownload( options ): 차트의 데이터를 엑셀로 내려 받습니다
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 속성값을 반환한다
getUserData( key ): setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
hasClass( className ): 컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( ): 컴포넌트를 화면에서 보이지 않도록 숨긴다.
redraw( ): chart를 다시 그립니다
removeClass( className ): 컴포넌트에 className의 class를 삭제한다.
setAccessibility( flag ): WebSquare Chart에 접근성을 지원합니다
setChartType( chartType ): 차트의 타입을 변경합니다
setDataCollection( dataList , labelId , append , modify ): 주어진 dataCollection형태의 data를 chart에 반영합니다
setDisabled( disabled ): 컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag ): 컴포넌트의 이벤트를 disable 또는 enable시킨다
setMaxYAxis( maxYaxis ): max YAxis 값을 설정하고, 출력 합니다
setMinYAxis( minYaxis ): min YAxis 값을 설정하고, 출력 합니다
setOpacity( value ): 컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode ): 컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly ): readOnly 속성값을 설정한다
setSeriesAxis( seriesAxisChk ): chart의 draw layer에 보여질 series를 설정합니다
setSize( width , height ): chart의 크기를 설정합니다
setTitle( title ): chart의 title을 설정합니다
setUserData( key , value ): 컴포넌트에 사용자 데이터를 설정한다
setValue( value , seriesIndex , dataIndex ): seriesIndex와 dataIndex를 받아 해당 값을 value로 설정합니다
setXML( data , append , modify ): 주어진 XML data를 chart에 반영합니다
show( displayType ): 컴포넌트를 화면에 보이도록 설정한다.
toggleClass( className ): 컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
trigger( type , array ): 컴포넌트에 등록 된 특정 이벤트를 발생시킨다
unbind( type , function ): 컴포넌트에 등록 된 이벤트를 제거한다
visible( flag ): [deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

Property Detail

axis3dBackgroundColor: X,Y축의 배경의 색상값으로 type속성의 값이 3D 차트인 경우만 적용된다.
axis3dBorderColor: X,Y축의 선의 색상값으로 type속성의 값이 3D 차트인 경우만 적용된다.
backgroundBorderColor: 컴포넌트 상위 테두리의 선의 색상값.
backgroundBorderWidth: 컴포넌트 상위 테두리의 선의 굵기값.
backgroundGradient: [default:true, false]상위 레이아웃의 배경 그라데이션의 사용 여부
bgColorPalette: [default:#ECEDED #FFFFFF]상위 레이아웃의 배경 그리드(가이드라인)의 홀/짝의 배경 색상값으로 공백으로 구분하여 정의한다.
ex) MistyRose #fff
dataAxisChanged: [default:false, true]series의 묶음 기준을 데이터 기반으로 표현할지의 여부
X축 기준을 데이터를 기반으로 표현할지의 여부 / 데이터 축 변환 여부
displayFormat: 데이터에 적용할 format으로 화면에 표현되는 데이터의 label에 적용된다.
displayFormatter: 화면에 표현되는 데이터의 label에 format을 적용할 Function명.
displayXAxis: [default:true, false]X축의 label을 표시할지의 여부
displayYAxis: [default:true, false]Y축의 label을 표시할지의 여부
elementTitle: 차트가 표현되는 영역에 HTML의 title속성을 정의한다.
"$blank"로 입력 시 빈 문자열로 처리할 수 있다.
fitGuidLine: [default:false, true]가이드라인의 영역(갯수)을 타이트하게 구성하여 차트를 그릴지의 여부.
gradientColorPalette: [default:#d8dfe0 #fafdfe]상위 레이아웃의 배경에 그라데이션을 사용할 경우 그라데이션의 시작과 끝의 색상값으로 공백으로 구분하여 정의한다.
backgroundGradient속성이 false로 정의된 경우 첫번째 정의된 색상값이 배경색으로 설정된다.
guidLineStyle: 가이드라인 영역의 선의 색과 굵기를 설정한다. ex) border-width:2px;border-color:green;
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
labelData: [default:false, true]데이터가 표현되는 label에 항목의 이름(labelNode속성에 입력한 컬럼/노드의 값)을 포함할지 여부
예시 ) "1월,1000" : 데이터가 "1000"이고 labelNode속성에 정의된 컬럼의 값이 "1월"
labelNode: 데이터의 기준축의 label로 표현될 컬럼의 ID 또는 XPath. 차트를 구성하기위한 필수입력값이다.
labelPerValue: 차트의 데이터가 muliti일 경우 내부에 표시되는 label에 Series의 백분율 값을 포함할지 여부
labelSeparator: 차트 내부에 표시되는 label에 포함되는 값들 사이에 위치할 구분자
labelSeries: 차트 내부에 표시되는 label에 계열(series)이름을 포함할지 여부
labelValue: 차트 내부에 표시되는 label에 값(value)을 포함할지 여부
lineStyle: 차트 series의 기본 라인 스타일
mainGrid: 주축 눈금 선을 표시할지 여부
mainGridLineOnly: 주축 눈금선만 표시(투명 그리드 배경)
maxYAxis: 차트의 Y축의 최대값
minYAxis: 차트의 Y축의 최소값
ref: dataCollection으로 chart 데이터 연동 시 사용. dataCollection 경로를 설정한다.labelNode 옵션과 함께 사용한다.
rootNode: 차트에서 쓰일 데이터 xml의 xpath
roundRectangle: 배경 둥근 모서리 사용 여부
seriesBorderColor: 차트의 series들이 가지는 border 색상 코드 값들을 공백으로 구분한 string
seriesBorderWidth: 차트의 series들이 가지는 border width값들을 공백으로 구분한 string
seriesColor: 차트의 series들이 가지는 색상 코드 값들을 공백으로 구분한 string
seriesPosition: series 표시 위치
seriesShow: series 표시 유무
seriesSymbol: 차트의 series들이 symbol의 값들을 공백으로 구분한 string
subGrid: 보조축 눈금선 표시 여부
tableDisplayFormat: 테이블 display format string
tableDisplayFormatter: 테이블 display 사용자 정의 formatter function name
tableShow: 차트의 data table의 표시 유무
title: 차트 타이틀
titlePosition: 차트의 title이 가지는 css position 속성 값
titleShow: 차트 타이틀 표시 유무
titleStyle: 차트 타이틀 Style
toolTip: 컴포넌트 toolTip
type: 차트 유형
usePopup: popup 사용 여부
valueType: 차트 value의 타입
xAxisTitle: X축 타이틀
xAxisTitleShow: X축 타이틀 표시 여부
xAxisTitleStyle: X축 타이틀 style
y1AxisTitle: Y축 타이틀
y1AxisTitleShow: Y축 타이틀 표시 여부
y1AxisTitleStyle: Y축 타이틀 style
y1DisplayFormat: Y 축 display format string
y1DisplayFormatter: Y 축 display 사용자 정의 formatter function name
y2DisplayFormat: 이중 차트에서 Y 축 display format string
y2DisplayFormatter: 이중 차트에서 Y 축 display 사용자 정의 formatter function name

Event Detail

Method Detail

addClass( className )

컴포넌트에 class를 추가한다.

Parameter
name	type	required	description
className	String	Y	추가하고 싶은 class의 이름

Sample

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

appendXML( data , maxCount , modify )

xml data를 입력받아 기존 data에 추가합니다.

Parameter
name	type	required	description
data	XML Document	Y	chart에 반영할 xml document
maxCount	Number	N	보여줄 데이터의 최대 수. maxCount가 chart의 데이터(기존+추가)보다 크면 처음부터 maxCountt까지의 데이터만 그린다. maxCount가 chart의 데이터(기존+추가)보다 작으면 차트의 maxCount만큼의 상위데이터를 그린다.
modify	Boolean	N	modify 여부, 기본값은 false. true면 model에서 데이터를 다시 읽어와서 chart의 data layer부분을 다시 그린다. false면 chart 전체를 다시 그린다.

Sample

예: 기존에 2001년부터 2010년까지 데이터가 있다. chart1.appendXML(WebSquare.ModelUtil.findInstanceNode('currentWork'), 3, false ); 데이터는 추가하여 2001년부터 2011년까지 데이터가 생성되나, maxCount를 3으로 주었으므로 2009년부터 2011년까지의 데이터가 반영된다.

applySeriesConfig( useDoubleChart , seriesUseChk , seriesAxisChk , chartType , chartType )

chart의 series에 관한 설정을 합니다.

Parameter
name	type	required	description
useDoubleChart	Boolean	Y	이중 chart를 사용할지 여부. true면 이중 chart를 사용한다.
seriesUseChk	Array	Y	series를 사용할지 여부를 담고 있는 배열. 각 element가 true인 경우 해당 series가 drawLayer에 나타난다.
seriesAxisChk	Array	Y	series axis의 사용 여부를 'Y', 'Y1'으로 나타낸 배열. 'Y'면 해당 series를 나타내고 'Y1'이면 해당 series를 2중 chart의 2번째 chart로 나타낸다. 이 외의 문자들에 대해서는 해당 series를 나타내지 않는다.
chartType	String	Y	chart의 타입을 나타내는 string
chartType	String	Y	이중 chart에서 두번째 chart의 타입을 나타내는 string

Sample

chart1.applySeriesConfig(true, [true,true,false], ['Y','Y1','Y'] , 'COLUMN', 'POINT_LINE'); 첫번째 series는 COLUMN 타입으로 차트에 표현된다. 두번째 series는 POINT_LINE 타입으로 이중 차트에 표현된다. 세번째 series는 COLUMN 타입으로 차트에 표현되지 않는다.

bind( eventType , function )

컴포넌트의 이벤트를 동적으로 할당한다.

Parameter
name	type	required	description
eventType	String	Y	할당 할 이벤트명.
function	Function	Y	동적으로 할당 할 이벤트의 핸들러 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
name	type	required	description
oldClassName	String	Y	삭제 할 class의 이름
newClassName	String	Y	추가 할 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");

deleteData( )

chart의 데이터를 지웁니다.

Sample

chart1.deleteData();

excelDownload( options )

차트의 데이터를 엑셀로 내려 받습니다.

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

Sample

var options = {showProcess : true , fileName : "excel"}; chart1.excelDownload(options);

focus( )

컴포넌트에 focus를 준다.

getDisabled( )

현재 설정되어있는 disabled 속성값을 반환한다.

Return
type	description
Boolean	disabled 속성값

Sample

var returnValue = componentId.getDisabled(); return 예시 ) false

getGenerator( )

generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다.

Return
type	description
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
type	description
String	웹스퀘어 컴포넌트의 id

Sample

//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }

getOpacity( )

CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다.

Return
type	description
Integer	Opacity 값

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
type	description
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
name	type	required	description
positionName	String	Y	[left,top]위치 종류

Return
type	description
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
type	description
Boolean	현재 설정되어있는 readOnly 속성

Sample

var returnValue = componentId.getReadOnly(); //return 예시 ) false

getSize( sizeName )

컴포넌트의 크기 값을 반환합니다.%로 설정된 경우, 픽셀로 변환하여 반환한다.

Parameter
name	type	required	description
sizeName	String	Y	[height,innerHeight,outerHeight,outerMarginHeight,width,innerWidth,outerWidth,outerMarginWidth]크기 값의 종류. szieName별 계산 방법은 아래를 참고.

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

Sample

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

getStyle( propertyName )

컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.

Parameter
name	type	required	description
propertyName	String	Y	반환 할 style의 property 이름

Return
type	description
String	style의 속성값

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
name	type	required	description
style	String	Y	정의 된 style에서 사용자가 반환 받고자하는 속성명.

Return
type	description
String	style 속성에 정의 된 값(색을 반환하는 경우에는 색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(); //return 예시 ) "이름 입력"

getUserData( key )

setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다.

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

Return
type	description
String	key에 해당하는 데이터

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
name	type	required	description
className	String	Y	검색 할 className

Return
type	description
Boolean	class를 가지고 있는지의 여부

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();

redraw( )

chart를 다시 그립니다.

Sample

chart1.redraw();

removeClass( className )

컴포넌트에 className의 class를 삭제한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>

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

Sample

setAccessibility( flag )

WebSquare Chart에 접근성을 지원합니다.

Parameter
name	type	required	description
flag	String	Y	접근성지원을 on/off 하기위한값

setChartType( chartType )

차트의 타입을 변경합니다.

Parameter
name	type	required	description
chartType	String	Y	변환하려는 차트의 타입

Sample

chart1.setChartType('POINT_LINE');

setDataCollection( dataList , labelId , append , modify )

주어진 dataCollection형태의 data를 chart에 반영합니다.

Parameter
name	type	required	description
dataList	Object	Y	차트의 데이터를 표현한 dataList. 범례 레이블 (기존 xml의 series노드 데이터)은 label을 제외한 column에 name속성으로 등록한다. 아래 예제 참고.
labelId	String	N	dataList의 column중 label 데이터를 가지고 있는 컬럼의 아이디. 해당 컬럼의 데이터가 label로 인식되며 나머지 컬럼은 데이터로 인식된다. 값이 지정되지 않은 경우 0번 컬럼을 label로 인식한다.
append	Boolean	N	이어쓰기 여부, 기본값은 false. false면 기존 데이터 삭제.
modify	Boolean	N	modify 여부, 기본값은 false. true면 data layer 부분만 다시 그린다. false면 chart 전체를 다시 그린다.

Sample

chart1.setDataCollection($w.data.dataList1, "label"); 두 번째 인자로 어떤 column이 label로 사용되는지를 column id로 알려준다. 두 번째 인자를 생략하면 0번째 컬럼(위의 샘플에서는 "label"컬럼)을 label컬럼으로 인식한다. 세 번째 인자는 기존 데이터를 삭제할 것인지 유지한 후 새 데이터를 뒤에 이어붙일지에 대한 옵션이다. 생략하면 기존 데이터는 삭제된다. 네 번째 인자 modify가 true인 경우, redraw 함수로 차트를 다시 그려야 변경된 데이터가 제대로 반영된다.

setDisabled( disabled )

컴포넌트의 disabled 속성을 설정한다. disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력한다.

Parameter
name	type	required	description
disabled	Boolean	Y	disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

//컴포넌트의 disabled 적용 componentId.setDisabled(true);

setEventPause( evList , flag )

컴포넌트의 이벤트를 disable 또는 enable시킨다.

Parameter
name	type	required	description
evList	String	N	대상 이벤트 목록. 해당 인자가 주어지지 않을 경우 해당 컴포넌트의 모든 사용자 이벤트가 대상이 된다. (null을 지정하면 된다.)
flag	Boolean	Y	true인 경우 pause시키며, false인 경우 pause를 해제한다.

Sample

input1.setEventPause("onclick", true); //onclick이벤트를 동적으로 pause 한다. input1.setEventPause("onfocus,onblur", false); //onfocus이벤트와 onblur이벤트의 pause를 해제한다. input1.setEventPause(null, true); //input에 등록된 모든 사용자 이벤트를 pause 한다.

setMaxYAxis( maxYaxis )

max YAxis 값을 설정하고, 출력 합니다.

Parameter
name	type	required	description
maxYaxis	Number	Y	설정할 Max YAxis 값

setMinYAxis( minYaxis )

min YAxis 값을 설정하고, 출력 합니다.

Parameter
name	type	required	description
minYaxis	Number	Y	설정할 Min YAxis 값

setOpacity( value )

컴포넌트의 CSS Opacity(불투명도)값를 설정한다.

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

Sample

componentId.setOpacity(0.45);

setPosition( left , top , mode )

컴포넌트의 위치(left,top)를 설정한다.

Parameter
name	type	required	description
left	Number	Y	left의 값 또는 null.
top	Number	Y	top의 값 또는 null.
mode	String	N	[defulat:absolute, delta]absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정.

Sample

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

setReadOnly( readOnly )

readOnly 속성값을 설정한다. readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.

Parameter
name	type	required	description
readOnly	Boolean	Y	readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

//컴포넌트의 readonly 적용. componentId.setReadOnly(true);

setSeriesAxis( seriesAxisChk )

chart의 draw layer에 보여질 series를 설정합니다.

Parameter
name	type	required	description
seriesAxisChk	String	Y	series axis의 체크 여부를 나타낸 string. space를 delimiter로 쓴다.'Y'면 해당 series를 나타내고 'Y1'이면 해당 series를 2중 chart의 2번째 chart로 나타낸다. 이 외의 문자들에 대해서는 해당 series를 나타내지 않는다.

Sample

chart1.setSeriesAxis("Y N Y Y1"); redraw 함수로 차트를 다시 그려야 반영된다. 첫번째와 세번째 series에 대하여 차트에 나타낸다. 만약 이중 차트를 사용한다면 네번째 series는 두번째 차트에 나타낸다. 이중 차트를 사용하지 않는 경우, 첫번째와 세번째 series만 표현된다.

setSize( width , height )

chart의 크기를 설정합니다.

Parameter
name	type	required	description
width	Integer	Y	chart의 너비
height	Integer	Y	chart의 높이

Sample

chart1.setSize(500,300);

setTitle( title )

chart의 title을 설정합니다.

Parameter
name	type	required	description
title	String	Y	title로 사용할 문자열

Sample

chart1.setTitle("작품현황");

setUserData( key , value )

컴포넌트에 사용자 데이터를 설정한다. 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하며 log에 관련 내용이 출력 된다.

Parameter
name	type	required	description
key	String	Y	임의 데이터의 키
value	String	Y	임의 데이터의 값

Sample

//컴포넌트에 'data'라는 key로 'WebSquare'라는 값을 설정 할 경우 componentId.setUserData("data", "WebSquare"); //아래와 같이 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare"); //log 표현 예시 ) !!!WARNING - [title] can't define as UserData

setValue( value , seriesIndex , dataIndex )

seriesIndex와 dataIndex를 받아 해당 값을 value로 설정합니다.

Parameter
name	type	required	description
value	Number	Y	chart의 값으로 입력할 value
seriesIndex	Integer	Y	series의 index
dataIndex	Integer	Y	data의 index

setXML( data , append , modify )

주어진 XML data를 chart에 반영합니다.

Parameter
name	type	required	description
data	XML Document	Y	chart에 반영할 xml document
append	Boolean	N	이어쓰기 여부, 기본값은 false. false면 기존 데이터 삭제.
modify	Boolean	N	modify 여부, 기본값은 false. true면 data layer 부분만 다시 그린다. false면 chart 전체를 다시 그린다.

Sample

예: 2006년 방송0건, 영화0건, 도서100건을 나타내는 차트. chart1.setXML(WebSquare.ModelUtil.findInstanceNode("works"), true, false); append가 true인 경우, chart1.appendXML(WebSquare.ModelUtil.findInstanceNode("works")); 한 것과 동일하다. modify가 true인 경우, redraw 함수로 차트를 다시 그려야 변경된 데이터가 제대로 반영된다.

show( displayType )

컴포넌트를 화면에 보이도록 설정한다.
엔진 내부적으로는 CSS를 display속성과 visibility:show;으로 처리한다.

Parameter
name	type	required	description
displayType	String	N	[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
name	type	required	description
className	String	Y	설정 할 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
name	type	required	description
type	String	Y	발생시킬 이벤트 이름
array	Array	N	이벤트 핸들러에 전달할 파라미터 배열

Sample

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

unbind( type , function )

컴포넌트에 등록 된 이벤트를 제거한다.

Parameter
name	type	required	description
type	String	N	제거할 이벤트 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
function	Function	N	제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 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
name	type	required	description
flag	Boolean	Y	visibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)