WebSquare.uiplugin.fusionchart

FusionChart. FusionChart Wrapper. FunsionCharts data is a combination of actual chart data and style options. WebSquare5 provides APIs for the developers to separate them and to easily customize the chart. For more information about properties and APIs, visit the official page of FusionCharts (fusioncharts.com/charts/)

Type

uiplugin

Property Summary

accessibility: [default:false, true] When generating ul tags with accessibility="true" setting, the names of X and Y axes are used as the label and the value respectively.
actionURI: URI to call upon execution of exportJSChart.
chartType: Chart type (OverlappedColumn2D, OverlappedBar2D is 3
dataList: Adds another DataList. Valid when the seriesType is simple.
dataTypeFormatter: Name of the function to be executed right before rendering of the chart.
drawType: Rendering type of the FusionCharts (javascript, flash, and mixed)
id: Component ID
labelNode: Column ID of the DataCollection to use as the label. The default is the first column of the DataCollection.
plotColor: Dataplot color of the FusionChart
ref: To be used for the binding with the DataCollection.
runflashAt: Specifies the IE version to run Flash for rendering when the drawType is mixed.
seriesColumns: Information about the DataList columns to be used as the series data of the FusionChart when the seriesType is advanced.
seriesNode: The column ID of the DataCollection to be used for the FusionChart when seriesType is simple.
seriesType: Series type for the data binding with the DataCollection.
tabIndex: The focusing order by the Tab key.
valueNode: The column ID of the DataCollection to be used as the value in the FusionChart when seriesType is simple.
version: FusionChart version.

Event Summary

Method Summary

addClass( className ): Adds a CSS class to the component.
addTrendLine( options ): Adds a trend line.
addVTrendLine( options ): Adds a VTrendLine.
applyStyle( styleType , styleName , options , objectNameArr ): Applies the style of the FusionCharts.
bind( eventType , function ): Dynamically allocate an event and the handler function to the component.
changeClass( oldClassName , newClassName ): Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
configure( options ): Changes message displayed on the FusionCharts.
draw( ): Renders the FusionChart.
exportJSChart( fileType , options ): Exports charts rendered in JavaScript in JPG, PNG, and PDF formats.
fc( ): Returns FusionCharts objects.
focus( ): Focuses the WebSquare component.
getActionURI( ): Returns the URI to be called upon execution of exportJSChart.
getChartAttribute( name ): Returns attributes of FusionCharts.
getDisabled( ): Returns the current value of the disabled property.
getGenerator( ): In case generated by the Generator component, returns the parent Generator object that created the component itself.
getID( ): Returns the ID of the WebSquare component.
getInitStyle( CSS ): Returns the initial style of the WebSquare component.
getJSONData( ): Returns FusionCharts data in JSON string format.
getOpacity( ): Returns the opacity of the WebSquare component. (Supported in all WebSquare components.)
getOriginalID( ): Returns the originalID of the WebSquare component. (Supported in all WebSquare components.)
getPluginName( ): Returns the name of the WebSquare component.
getPosition( positionName ): Returns the position (left and top) of the WebSquare component. (Supported in all WebSquare components.)
getReadOnly( ): Returns the current value of the readOnly property.
getScope( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getScopeWindow( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getSize( sizeName ): Sets the size (width and height) of the WebSquare component. (Supported in all WebSquare components.)
getStyle( propertyName ): Returns the CSS setting of the WebSquare component.
getStyleValue( style ): [deprecated]
getSVGString( ): Returns the chart SVG in the string format.
getSVGString1( ): When the file type is JPG or PNG, use htis funciton.
getTitle( ): Returns the title of the WebSquare component.
getUdcHome( ): Returns the path of the UDC file including the file name in which the UDC object is defined. (Supported in all WebSquare components.)
getUdcRoot( ): Returns the path of the UDC file in which the UDC object is defined. (Supported in all WebSquare components.)
getUserData( key ): Returns the value set by setUserData or directly defined by the user in the XML file.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the WebSquare component. (Supported in all WebSquare components.)
modifySeriesName( options ): Changes the series name in the chart.
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
setAccessibility( flag ): Supports web accessibility requirements for the FusionChart.
setActionURI( uri ): Sets the URI to call upon execution of exportJSChart.
setChartAttribute( options ): Changes the attribute values of the chart.
setChartColumnRef( ref , labelNode , seriesColumns ): Sets the properties related to data binding with a DataCollection.
setChartColumnSimpleRef( ref , labelNode , seriesNode , valueNode ): Sets the properties related to data binding with a DataCollection when the seriesType is simple.
setDisabled( disabled ): Sets the disabled property of the WebSquare component.
setEventPause( evList , flag ): Pauses the event.
setInitStyle( property ): Restores the initial style of the WebSquare component.
setJSONData( json ): Sets the chart data with the given JSON object.
setOpacity( value ): Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
setPlotColor( colorArr , colorOption ): Sets the dataplot color of the chart.
setPosition( left , top , mode ): Sets the position (left, top) of the WebSquare component.
setReadOnly( readOnly ): Sets the readOnly proprety of the WebSquare component.
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setUserData( key , value ): Sets random data in the WebSquare component. (Supported in all WebSquare components.)
show( displayType ): Shows the WebSquare component on the page. (Supported in all WebSquare components.)
toggleClass( className ): Adds or removes a CSS class to or from a WebSquare component. (Supported in all WebSquare components.)
trigger( type , array ): Triggers the specified event in the WebSquare component.
unbind( type , function ): Removes the specified event from the WebSquare component.
visible( flag ): [deprecated]

Property Detail

accessibility: [default:false, true] When generating ul tags with accessibility="true" setting, the names of X and Y axes are used as the label and the value respectively.
* true: Uses the value of the axaxisname property as the label and of the ayaxisname as the value of the ul tag. axaxisname and ayaxisname are set as the parameters of setChartAttribute API.
* In case there are two Y axes, add the sayaxisname property for the second Y axis in the dataset that is set for setJSONData API.
* false (Default): Not used.
* Related property: accessibility="true"
actionURI: URI to call upon execution of exportJSChart. [default: engine/servlet/exportFusionChart.jsp]
chartType: Chart type (OverlappedColumn2D and OverlappedBar2D are supported in 3.13 or higher versions.)
dataList: Adds another DataList that must have the same structure with the DataList already bound. Valid when the seriesType is simple.
dataTypeFormatter: Name of the function to be executed right before rendering of the chart. Sends the chart chart information (such as chart type, ID, and data) as parameters.
drawType: Rendering type of the FusionCharts (javascript, flash, and mixed)
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
labelNode: Column ID of the DataCollection to use as the label. The default is the first column of the DataCollection.
plotColor: Dataplot color of the FusionChart
ref: To be used for the binding with the DataCollection. Sets the DataCollection. When seriesType is advanced, labelNode and seriesColumns are supported, and when seriesType is simple, labelNode, seriesNode, and valueNode are supported.
runflashAt: Specifies the IE version to run Flash for rendering when the drawType is mixed.
seriesColumns: Information about the DataList columns to be used as the series data of the FusionChart when the seriesType is advanced. The default is the columns of which dataType is number except the first column.
seriesNode: The column ID of the DataCollection to be used for the FusionChart when seriesType is simple. The default is the second column of the DataCollection.
seriesType: Series type for the data binding with the DataCollection. When seriesType is simple, only Single Series and Multi Series charts are supported.
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
valueNode: The column ID of the DataCollection to be used as the value in the FusionChart when seriesType is simple. The default is the column of which dataType is number in the DataCollection.
version: FusionChart version.

Event Detail

Method Detail

addClass( className )

Adds a CSS class to the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
className	String	Y	Name of the class to add

Sample

// (Example) // Add oddClass to input1 component. input1.addClass("oddClass");

addTrendLine( options )

Adds a trend line.

Parameter
name	type	required	description
options	Object	Y	Option object to add

Sample

var options = { startValue: "10", color: "FF0000", displayValue: "Check" }; chart1.addTrendLine(options);

addVTrendLine( options )

Adds a VTrendLine. (Supported only for scatter and bubble.)

Parameter
name	type	required	description
options	Object	Y	Option object to add

Sample

var options = { startValue: "65", endValue : "90", alpha: "15", color: "FFFF00" }; chart1.addVTrendLine(options);

applyStyle( styleType , styleName , options , objectNameArr )

Applies the style of the FusionCharts.

Parameter
name	type	required	description
styleType	String	Y	Style type (font, bevel, glow, animation, shadow)
styleName	String	Y	Style name
options	Object	Y	Option object to add
objectNameArr	Array	Y	Chart object to apply the style to

Sample

var options = { color:"FF0000", font:"15", bold:"1" }; chart1.applyStyle("font", "captionFont", options, ["Caption","XAXISNAME"]);

bind( eventType , function )

Dynamically allocate an event and the handler function to the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
eventType	String	Y	Event to allocate
function	Function	Y	Handler function of the event

Sample

// (Example 1) // Define a function for the onclick event of input1. input1.bind("onclick", function(e){ alert(input1.getValue();})); // (Example 2) // Define commObj.ev_click function in advance. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; // Dynamically allocate onclick event and the handler function to input1 component. input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
Only the classes added by addClass can be changed.
In order to remove classes directly defined in the class propert of the WebSquare component, add the following in config.xml. // Add the following in config.xml.

Parameter
name	type	required	description
oldClassName	String	Y	Class to change
newClassName	String	Y	Class to newly use

Sample

// The class is directly defined in the inputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following in config.xml. <style> <removeDefaultClass value="true" /> </style> // Change the class. // Change tmpInputClass class to tmpInputWarninClass. input1.changeClass("tmpInputClass","tmpInputWarninClass");

configure( options )

Changes message displayed on the FusionCharts.

Parameter
name	type	required	description
options	Object	Y	Option object to configure

Sample

chart1.configure({"ChartNoDataText" :"No data."});

draw( )

Displays the fusion chart.

Sample

chart1.draw();

exportJSChart( fileType , options )

Exports charts rendered in JavaScript in JPG, PNG, and PDF formats.

Parameter
name	type	required	description
fileType	String	Y	Exported file type (jpg, png, pdf)
options	Object	Y	Name of the exported file

Sample

var options = {}; options.fileName = "test"; fusionchart1.exportJSChart("jpg", options);

fc( )

Returns FusionCharts objects. With the received FusionCharts object, the developer can call native APIs provided by FusionCharts.

Return
type	description
Object	FusionChart object

Sample

chart1.fc().setXMLUrl("mychartdata.xml"); chart1.fc().print(); chart1.fc().signature();

focus( )

Focuses the WebSquare component. (Supported in all WebSquare components.)

getActionURI( )

Returns the URI to be called upon execution of exportJSChart.

getChartAttribute( name )

Returns attributes of FusionCharts.

Parameter
name	type	required	description
name	String	Y	Name of the attribute

Return
type	description
String	Value of the attribute

Sample

chart1.getChartAttribute("caption");

getDisabled( )

Returns the current value of the disabled property. (Supported in all WebSquare components.)

Return
type	description
Boolean	Value of the disabled property

Sample

// (Example) Check the current value of the disabled property. var returnValue = componentId.getDisabled(); // (Return Example) false

getGenerator( )

In case generated by the Generator component, returns the parent Generator object that created the component itself. (Supported in all WebSquare components.)

Return
type	description
Object	Parent Generator object

Sample

// (Example) The Generator (parent) create a Trigger (child). <w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> // In the example below, upon the end user’s clicking the Trigger 1, the generator1 object will be displayed on the console. scwin.trigger1.onclick = function(){ console.log(this.getGenerator());}

getID( )

Returns the ID of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	WebSquare component ID

Sample

// Upon dynamically receiving a WebSquare component, the ID can be checked as shown below. function fn_validCheck(tmpObj){ var compID = tmpObj.getID(); } // If the tmpObj in the above example has "input1" ID. // (Return) "input1"

getInitStyle( CSS )

Returns the initial style of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
CSS	String	N	Property (If not specified, all properties will be displayed.)

getJSONData( )

Returns FusionCharts data in JSON string format.

Return
type	description
Object:Y	Chart data

Sample

chart1.getJSONData();

getOpacity( )

Returns the opacity of the WebSquare component. (Supported in all WebSquare components.)
The Engine returns the opacity value of the CSS.

Return
type	description
Integer	Opacity

Sample

// Apply the opacity CSS to the InputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> // Return the opacity of the InputBox. var returnValue = input1.getOpacity(); // A real number between 0 and 1 will be returned. // (Return) "0.2"

getOriginalID( )

Returns the originalID of the WebSquare component. (Supported in all WebSquare components.)
The originalID is valid when the scope function is in use.
For scope="true" WFrame, component IDs inside the WFrame is changed with the prefix(wframeID + "_") being added before the ID given by the user (originalID).
The originalID means the ID before the prefix being added.

Return
type	description
String	originalID of the component

Sample

// An example of multi-WFrame page // Main page with a WFrame (main.xml) <w2:wframe id="wframe1" src="text.xml" scope="true"/> // Source page to be contained in the WFrame (text.xml) <w2:textbox id="textbox1"/> // (Example) Check the Id and the original ID in the script of text.xml // Run getID. textbox1.getID(); // "wframe1_textbox1" is returned. // Run getOriginalID. textbox1.getOriginalID(); // "textbox1" is returned.

getPluginName( )

Returns the name of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	Name of the WebSquare component (pluginName)

Sample

// When a common function dynamically receives a WebSQuare object as shown below, different actions can be made for each component type. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); // Component ID var tmpCompType = tmpObj.getPluginName(); // Component name if(tmpCompType == "input"){ //..Logic.. }else if(tmpCompType == "gridView"){ //..Logic .. }else{ //..Logic.. } };

getPosition( positionName )

Returns the position (left and top) of the WebSquare component. (Supported in all WebSquare components.)
When the position is set in 0%, the value will be converted into %.

Parameter
name	type	required	description
positionName	String	Y	[left, top] Position type

Return
type	description
Number	Position of the component

Sample

// CSS margin is applied to the Input component as shown below. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> // (Example) Check the top value of the InputBox. var returnValue = input1.getPosition("top"); // Position value in pixels will be returned. // (Return) 10

getReadOnly( )

Returns the current value of the readOnly property. (Supported in all WebSquare components.)

Return
type	description
Boolean	The current setting of the readOnly property

Sample

// Example to check the readOnly setting of the component. var returnValue = componentId.getReadOnly(); // (Return Example) false

getScope( )

For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
For scope="true" WFrame, null will be returned.

Return
type	description
Object	WFrame object or null

Sample

// (Example) // The main page has wframe1 which contains wframe1 which also contains wframe11. // The source page of wframe11 has textbox1. textbox1.getScope(); // (Return Example) wframe11 object

getScopeWindow( )

For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
If not a child of a scope="true" WFrame, a global window object will be returned.

Return
type	description
Object	Scope object of the WFrame or a global window object

Sample

// (Example) // The main page has wframe1 which contains wframe1 which also contains wframe11. // The source page of wframe11 has textbox1. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSize( sizeName )

Sets the size (width and height) of the WebSquare component. (Supported in all WebSquare components.)
If set in %, values will be converted into pixels.

Parameter
name	type	required	description
sizeName	String	Y	Size types. For calculation of each size type, see the below:

Return
type	description
Number	Size of the component

Sample

var returnValue = componentId.getSize("width"); // (Return Example) 100 // Values are in pixels. // If set in %, values will be converted into pixels.

getStyle( propertyName )

Returns the CSS setting of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
propertyName	String	Y	CSS property to return

Return
type	description
String	CSS value

Sample

// Define an Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;"></xf:input> // (Example) Check the width of the InputBox above. var returnValue = input1.getStyle("width"); // (Return) "144px"

getStyleValue( style )

[deprecated]
Use getStyle instead.
Returns the current CSS applied to the WebSquare component.

Parameter
name	type	required	description
style	String	Y	CSS property to return

Return
type	description
String	CSS value (Colors are returned in HexCode.)

getSVGString( )

Returns the chart SVG in the string format.

Return
type	description
String	Pre-processed SVG string

getSVGString1( )

When the file type is JPG or PNG, use htis funciton.

Return
type	description
String	Pre-processed SVG string

getTitle( )

Returns the title of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	Title

Sample

// In the following example, the Title is “Input Name”. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); // (Return Example) “Enter your name.”

getUdcHome( )

Returns the path of the UDC file including the file name in which the UDC object is defined. (Supported in all WebSquare components.)
The file name includes .xml. In order to get the file path without .xml, use getUdcRoot.
When called by a WebSquare component, not a UDC object, “undefined” will be returned.

Return
type	description
String	UDC file path (For others than the UDC, undefined will be returned.)

Sample

// Example // UDC file path is /a/b/udc.xml. // Page XML is /a/c/main.xml. // UDC ID is udc1. udc1.getUdcHome(); // (Result) /a/b/udc.xml

getUdcRoot( )

Returns the path of the UDC file in which the UDC object is defined. (Supported in all WebSquare components.)
Not contains the file name. In order to get a path including the file name, use getUdcHome.
When called by a WebSquare component, not a UDC object, “undefined” will be returned.

Return
type	description
String	UDC file path (For others than the UDC, undefined will be returned.)

Sample

// Example // UDC file path is /a/b/udc.xml. // Page XML is /a/c/main.xml. // UDC ID is udc1. udc1.getUdcHome(); // (Execution Result) /a/b/

getUserData( key )

Returns the value set by setUserData or directly defined by the user in the XML file. (Supported in all WebSquare components.)

Parameter
name	type	required	description
key	String	Y	Data key

Return
type	description
String	Value for the given key

Sample

// (Example) Setting the user property (setTest) in the InputBox <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" setTest="Hello"></xf:input> // Returns the value of the setTest property. input1.getUserData("setTest"); // (Return) "Hello" // Set 'valueTest' (key) and 'WebSquare' (data) through setUserData. input1.setUserData("valueTest","WebSquare"); // Returns the value of the setTest property. input1.getUserData("WebSquare"); // (Return) "WebSquare"

hasClass( className )

Checks whether the WebSquare component has a certain class. (Supported in all WebSQuare components.)

Parameter
name	type	required	description
className	String	Y	Name of the class to check

Return
type	description
Boolean	Whether the class exists or not

Sample

hide( )

Hides the WebSquare component. (Supported in all WebSquare components.)
display:none; or visibility:hidden; CSS is applied.

Sample

// (Example) Hide the component. componentId.hide();

modifySeriesName( options )

Changes the series name in the chart.

Parameter
name	type	required	description
options	Object	Y	Option ( seriesType,colId,newName,oldName )

Sample

When the SeriesType is advanced: var options = {}; options.seriesType = "advanced"; options.colId = "series1"; options.newName = "summer"; chart1.modifySeriesName(options); Wen the SeriesType is simple: options.seriesType = "simple"; options.oldName = "spring"; options.newName = "summer"; chart2.modifySeriesName(options);

removeClass( className )

Removes a class from the WebSquare component. (Supported in all WebSquare components.)
Only the classes added by addClass can be removed.
In order to remove classes directly defined as a property of the component, add the following in config.xml. // Add the following in config.xml. <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	Name of the class to remove

Sample

// If the class is directly defined as an InputBox property. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // In the config.xml file, add the following. <style> <removeDefaultClass value="true" /> </style> // Classes can be removed by removeClass. input1.removeClass("tmpInputClass");

setAccessibility( flag )

Supports web accessibility requirements for the FusionChart.

Parameter
name	type	required	description
flag	Boolean	Y	Accessibility on / off

Sample

chart1.setAccessibility(true); on chart1.setAccessibility(flag); off

setActionURI( uri )

Sets the URI to call upon execution of exportJSChart.

Parameter
name	type	required	description
uri	String	Y

setChartAttribute( options )

Changes the attribute values of the chart.

Parameter
name	type	required	description
options	Object	Y	Option object to add

Sample

var options = { caption : "Monthly Revenue", subCaption : "subcaption test", xAxisName : "Month", yAxisName:"Revenue" lineColor:"d99103" } chart1.setChartAttribute(options);

setChartColumnRef( ref , labelNode , seriesColumns )

Sets the properties related to data binding with a DataCollection.

Parameter
name	type	required	description
ref	String	Y	attribute DataCollection id
labelNode	String	Y	labelNode
seriesColumns	String	Y	seriesColumns

Sample

chart1.setChartColumnRef('data:dataList1','Month',"[['Year2','Year3','Year1']]");

setChartColumnSimpleRef( ref , labelNode , seriesNode , valueNode )

Sets the properties related to data binding with a DataCollection when the seriesType is simple.

Parameter
name	type	required	description
ref	String	Y	attribute DataCollection id
labelNode	String	Y	labelNode
seriesNode	String	Y	seriesNode
valueNode	String	Y	valueNode

Sample

chart1.setChartColumnSimpleRef(null,'Month', 'Year1','Year1');

setDisabled( disabled )

Sets the disabled property of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
disabled	Boolean	Y	Disabled status

Sample

// Sets the disabled property in the component. componentId.setDisabled(true);

setEventPause( evList , flag )

Pauses the event. (Supported in all WebSquare components.)

Parameter
name	type	required	description
evList	String	N	List of the events to pause. (in case of null, all events of the corresponding WebSquare component is paused or restarted.)
flag	Boolean	Y	Whether to pause the event or not.

Sample

// (Example 1) // Pause the onclick event. input1.setEventPause("onclick", true); // (Example 2) // Restart the onfocus and the onblur events. input1.setEventPause("onfocus,onblur", false); // (Example 3) // Pause all events registered in input1. input1.setEventPause(null, true);

setInitStyle( property )

Restores the initial style of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
property	String	N	CSS property (If not spcified, all properties will be restored.)

Sample

// (Example) group1.setInitStyle();

setJSONData( json )

Sets the chart data with the given JSON object.

Parameter
name	type	required	description
json	Object	Y	Chart data

setOpacity( value )

Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
The engine sets the opacity property (of CSS).

Parameter
name	type	required	description
value	Number	Y	Opacity (Real number between 0 and 1)

Sample

// (Example) Set the opacity as 0.45. componentId.setOpacity(0.45);

setPlotColor( colorArr , colorOption )

Sets the dataplot color of the chart.

Parameter
name	type	required	description
colorArr	Array	Y
colorOption	Array	Y

Sample

var colorArr = ["ff0000","00ff00","0000ff"]; chart1.setPlotColor(colorArr);

setPosition( left , top , mode )

Sets the position (left, top) of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
left	Number	Y	Left position value or null
top	Number	Y	Top position value or null
mode	String	N	Position setting method. [default: absolute, delta]

Sample

// (Example) Set the top position as 100px. componentId.setPosition(null, 100);

setReadOnly( readOnly )

Sets the readOnly proprety of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
readOnly	Boolean	Y	Setting of the readOnly property. (“true”: Used. “false”: Not used.)

Sample

// Set the readOnly property as true. componentId.setReadOnly(true);

setSize( width , height )

Sets the size (width, height) of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
width	Number	Y	Width of the component or null.
height	Number	Y	Height of the component or null.

Sample

// (Example) Set the height of the component as 100px. componentId.setSize(null,100);

setStyle( propertyName , value )

Sets the CSS of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
propertyName	String	Y	CSS property to set.
value	String	Y	Value to set as the specified CSS property

Sample

// (Example 1) Set the width as 200px. componentId.setStyle("width", "200px"); // (Example 2) Set the background as olive. componentId.setStyle("background-color","olive");

setUserData( key , value )

Sets random data in the WebSquare component. (Supported in all WebSquare components.)
Enter key values supported by the component. In case a key value not supported by the component is entered, corresponding logs will be displayed.

Parameter
name	type	required	description
key	String	Y	Data key to set
value	String	Y	Defined data value

Sample

// Set 'data' key and 'WebSquare' value in the component. componentId.setUserData("data", "WebSquare"); // The key must be supported in the component. componentId.setUserData("title", "WebSquare"); // Following logs will be displayed. // !!!WARNING - [title] can't be defined as UserData.

show( displayType )

Shows the WebSquare component on the page. (Supported in all WebSquare components.)
Sets the display property as specified and applies "visibility: show;" CSS.

Parameter
name	type	required	description
displayType	String	N	CSS display setting to apply.

Sample

// (Example) display: block; componentId.show(); // (Example) Restore the previous display setting. componentId.show("");

toggleClass( className )

Adds or removes a CSS class to or from a WebSquare component. (Supported in all WebSquare components.)
Removes the class from the WebSquare component.
If the WebSquare component does not have the specified class, adds the class.
Only the classes added by addClass can be removed.
In order to remove classes directly defined as a property of the component, add the following in config.xml. // Add the following in config.xml. <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	Class to add or remove

Sample

// The class is directly defined in the inputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following in config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.toggleClass("tmpInputClass"); // Add the (previously removed) tmpInputClass. input1.toggleClass("tmpInputClass");

trigger( type , array )

Triggers a certain event in the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
type	String	Y	Event to trigger
array	Array	N	Array of parameters to send to the event handler

Sample

// (Example 1) // Trigger the onclick event in input1 component. input1.trigger("onclick"); // (Example 2) // Trigger the onviewchange event in input1, and send (1, 2) parameter to the handler function. input1.trigger("onviewchange", [1,2]);

unbind( type , function )

Removes the event from the component. (Supported in all WebSquare component.)

Parameter
name	type	required	description
type	String	N	Event to remove. (If not specified, all events of the component will be removed.)
function	Function	N	Handler function of the event to remove. (If not specified, all handler functions of the event will be removed.)

Sample

// (Example 1) // Remove all events registered in the input1 component. input1.unbind(); // (Example 2) // Remove all handler functions for the onviewchange event of the input1 component. input1.unbind("onviewchange"); // (Example 3) // Remove func1 for the onviewchange event of the input1 component. input1.unbind("onviewchange", func1);

visible( flag )

[deprecated]
Use show/hide or setStyle instead.
The Engine sets the CSS visibility property.

Parameter
name	type	required	description
flag	Boolean	Y	CSS visibility setting