WebSquare.uiplugin.mapchart

MapChart. Renders a map from the given data. Visualizes the data into a map. Renders a map of Korea from d3 data in various visual formats.

Type

uiplugin

Property Summary

dataLists: DataList(s) to bind with the map. Use the comma to separate DataLists.
dataMapPath: Path of the JSON data containing geographical information.
dataMapRatio_level0: [default:simp1] Simplification ratio of the map (at the country level).
dataMapRatio_level1: [default:simp1] Simplification ratio of the map (at the provincial level).
dataMapRatio_level2: [default:simp1] Simplification ratio of the map (at the local level).
event_deselect: [default:onmouseout] Name of the event to display the unselected effects on the event-triggered point.
event_drag: [default:ondrag] Uses the dragging feature on the map. none is not to use the feature.
event_drilldown: [default:onclick] Name of the event to view the details of the event-triggered point.
event_drillup: [default:oncontextmenu] Name of the event that is to move the upper-level map of the current map level.
event_select: [default:onmouseover] Name of the event to display the selected effects on the event-triggered point.
event_tooltipoff: [default:onmouseout] Name of the event to hide the tooltip.
event_tooltipon: [default:onmouseover] Name of the event to show the information of the event-triggered point on a tooltip.
event_zoom: [default:onzoom] Uses the zoom-in/out features on the map.
id: Component ID
setTooltipStrFunc: Name of the function to get the user-defined string to display the tooltip.
showMunicipalityLabel: [default:true, false] Displays the name of region (or the label of the municipality) on the map.
startMap: [default:0] Initial map code to render the map.
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property
zoomMax: [default:5] Sets the maximum zoom-in ratio.
zoomMin: [default:0

Event Summary

onaftermapchange: Triggered right after a change is made on the map.
onbeforemapchange: Triggered right before a change is made on the map.
onmapclick: Triggered upon clicking the map.
onmapdatachange: Triggered upon a change in the DataList bound with the map (including initialization, default setting, insertion, and deletion).
onmapdblclick: Triggered upon double-clicking the map
onmapmousemove: Triggered upon the end user's moving the mouse to a certain area of the map
onmapmouseout: Triggered upon the end user's moving out the mouse from a certain area of the map
onmapmouseover: Triggered upon the end user's hovering the mouse over a certain area of the map

Method Summary

addClass( className ): Adds a CSS class to the component.
addMapEvent( evName , func ): Adds events to the map.
addPattern( patternData ): A function to add a pattern to SVG.
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.)
changeMap( code ): Changes the map based on the reeived code.
changeMapPath( mapPath ): Changes the path of the map data.
createPattern( userPatternData , useDefaultPattern ): Generates the pattern to apply to svg.
drillup( ): Changes to draw the parent map of the current map.
focus( ): Focuses the WebSquare component.
getCurrentMap( ): Gets the code of the currently rendered map.
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.
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.)
getParentMap( ): Gets the code of the parent map.
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]
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.)
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
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.
setOpacity( value ): Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
setPosition( left , top , mode ): Sets the position (left, top) of the WebSquare component.
setReadOnly( readOnly ): Sets the readOnly proprety of the WebSquare component.
setScale( scale ): Sets the map scale.
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

dataLists: DataList(s) to bind with the map. Use the comma to separate DataLists.
dataMapPath: Path of the JSON data containing geographical information. The default is externalJS/mapchart.
dataMapRatio_level0: (simp1 (default): Visvalingam, weighted area 1%. simp01: Visvalingam, weighted area 0.1%. simp16: Douglas-Peucker 16%.)
dataMapRatio_level1: (simp1 (Default): Visvalingam, weighted area 1%. simp008: Visvalingam-effective Area 0.08%. simp16: Douglas-Peucker 16%.)
dataMapRatio_level2: (simp1 (Default): Visvalingam, weighted area 1%. simp008: Visvalingam-effective Area 0.08%. simp16: Douglas-Peucker 16%.)
event_deselect: [default: onmouseout] Name of the event to display the unselected effects on the event-triggered point. Not to specify such an event, input none.
event_drag: [default: ondrag] Uses the dragging feature on the map. none is not to use the feature.
event_drilldown: [default:onclick] Name of the event to view the details of the event-triggered point. Not to specify such an event, input none.
event_drillup: [default:oncontextmenu] Name of the event that is to move the upper-level map of the current map level. Not to specify such an event, input none.
event_select: [default:onmouseover] Name of the event to display the selected effects on the event-triggered point. Not to specify such an event, input none.
event_tooltipoff: [default:onmouseout] Name of the event to hide the tooltip. Not to specify such an event, input none.
event_tooltipon: [default:onmouseover] Name of the event to show the information of the event-triggered point on a tooltip. Not to specify such an event, input none.
event_zoom: [default:onzoom] Uses the zoom-in/out features on the map. none is not to use the zoom features.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
setTooltipStrFunc: Name of the function to get the user-defined string to display the tooltip.
showMunicipalityLabel: [default:true, false] Displays the name of region (or the label of the municipality) on the map.
startMap: [default:0] Initial map code to render the map. The default is 0 for the entire country. (Example: 11 is for Seoul.)
userData1: User-defined property. Use getUserData("userData3") to get the data.
userData2: User-defined property. Use getUserData("userData2") to get the data.
userData3: User-defined property. Use getUserData("userData3") to get the data.
zoomMax: [default:5] Sets the maximum zoom-in ratio.
zoomMin: [default:0.2] Sets the minimum zoom-in ratio.

Event Detail

onaftermapchange

Triggered right after a change is made on the map. Also triggered upon initial execution.

Sample

onbeforemapchange

Triggered right before a change is made on the map. Event handler function's returning false will cancel the change.

Parameter
name	type	description
info	JSON	Returns JSON data containing oldMapCode, and newMapCode.

Sample

onmapclick

Triggered upon clicking the map.

Parameter
name	type	description
properties	JSON	eturns JSON data containing code, name, name_eng, and base_year.

Sample

onmapdatachange

Triggered upon a change in the DataList bound with the map (including initialization, default setting, insertion, and deletion).

Sample

onmapdblclick

Triggered upon double-clicking the map

Parameter
name	type	description
properties	JSON	eturns JSON data containing code, name, name_eng, and base_year.

Sample

onmapmousemove

Triggered upon the end user's moving the mouse to a certain area of the map

Parameter
name	type	description
properties	JSON	eturns JSON data containing code, name, name_eng, and base_year.

Sample

onmapmouseout

Triggered upon the end user's moving out the mouse from a certain area of the map

Parameter
name	type	description
properties	JSON	eturns JSON data containing code, name, name_eng, and base_year.

Sample

onmapmouseover

Triggered upon the end user's hovering the mouse over a certain area of the map

Parameter
name	type	description
properties	JSON	eturns JSON data containing code, name, name_eng, and base_year.

Sample

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

addMapEvent( evName , func )

Adds events to the map. The event must be supported by D3.

Parameter
name	type	required	description
evName	String	Y	Name of the event
func	func	Y	Event handler function

Sample

mapchart1.addMapEvent("onkeydown", scwin.mapchart1_onkeydown);

addPattern( patternData )

A function to add a pattern to SVG.

Parameter
name	type	required	description
patternData	object	Y	JSON object containing pattern information

Sample

var pattern = {"type":"line", "size":4, "stroke":"#BDBDBD", "strokeWidth":1}; mapchart1.addPattern(pattern);

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

changeMap( code )

Changes the map based on the reeived code.

Parameter
name	type	required	description
code	String	Y	New map code

Sample

mapchart1.changeMap("11"); // Change the map into the map of code 11.

changeMapPath( mapPath )

Changes the path of the map data.

Parameter
name	type	required	description
mapPath	String	Y	New path

Sample

mapchart1.changeMapPath("mapdata/2016"); // Change the path to mapdata/2016 directory. The map data under this path will be rendered as a map.

createPattern( userPatternData , useDefaultPattern )

Generates the pattern to apply to the svg.

Parameter
name	type	required	description
userPatternData	object	Y	Array of JSON objects containing pattern data
useDefaultPattern	boolean	N	Use of the patterns in the component

Sample

var patternArray = [{"type":"line", "size":4, "stroke":"#BDBDBD", "strokeWidth":1}]; mapchart1.createPattern(patternArray);

drillup( )

Changes to draw the parent map of the current map. Does not function when the current map is of the highest level (a country map).

Sample

mapchart1.drillup();

focus( )

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

getCurrentMap( )

Gets the code of the currently rendered map.

Return
type	description
String	Code of the currently rendered map

Sample

var currentMap = mapchart1.getCurrentMap(); if(currentMap.length === 5) { mapchart1.changeMap(currentMap.slice(0,2)); } // Draw the higher-level map of the current map.

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.)

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.

getParentMap( )

Gets the code of the parent map.

Return
type	description
String	Code of the parent map

Sample

The following two have the same effect.

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.)

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

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

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

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

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

setScale( scale )

Sets the map scale.

Parameter
name	type	required	description
scale	Float	Y	Sets the map scale.

Sample

mapchart1.setScale(0.8) // Set the map scale to 0.8.

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