WebSquare.uiplugin.fwPyramidChart

fwPyramidChart is a FusionWidget Wrapper component. FusionWidgets data combines actual chart data with the 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 (http://docs.fusioncharts.com/charts/)

Type

uiplugin

Property Summary

accessibility: Supports the web accessibility requirements.
id: Component ID
labelNode: Column ID of the DataList to be used as the label data in the fwPyramidChart.
plotColor: Dataplot color of the chart
ref: Binds the fwPyramidChart with the DataCollection, and sets the DataCollection.
seriesColumns: DataList columns to be used as the series data of the chart when the seriesType is advanced.
seriesType: Series type to bind the fwPyramidChart with the DataCollection.
valueNode: Column ID of the DataCollection to use as the value data when the seriesType is simple.
version: FusionChart version.

Event Summary

Method Summary

addClass( className ): Adds a class to the component.
bind( eventType , function ): Dynamically allocates events to the component.
changeClass( oldClassName , newClassName ): Renames the class from oldClassName to newClassName.
draw( ): Renders the chart.
exportJSChart( ): Exports charts rendered in JavaScript in JPG, PNG, and PDF formats.
fc( ): Returns a fusionWidget object of the fwFunnelChart type.
focus( ): Moves the focus to the component.
getChartAttribute( name ): Returns the chart attributes.
getDisabled( ): Gets the current value of the disabled property.
getGenerator( ): Called by a component under the Generator component. When called, gets the parent Generator object.
getID( ): Gets the ID of the component.
getJSONData( ): Returns the chart data as a JSON object.
getOpacity( ): Gets the opacity of the component defined in CSS.
getPluginName( ): Gets the pluginName (or the name) of the component.
getPosition( positionName ): Gets the left or top position of the component.
getReadOnly( ): Gets the current setting of the readOnly property.
getSize( sizeName ): Gets the size of the component.
getStyle( propertyName ): Gets the current value of the propertyName of the component defined in CSS.
getStyleValue( style ): [deprecated] Use getStyle instead.
getSVGString( ): Returns the chart SVG in the string format.
getTitle( ): Gets the title value.
getUserData( key ): Returns the user-defined property value set by setUserData as the user data or source (page XML).
hasClass( className ): Checks whether the component has className received as a parameter or not.
hide( ): Hides the component.
removeClass( className ): Removes className from the component.
setAccessibility( flag ): A function to support web accessibility requirements.
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 the binding of the DataList with the chart when the seriesType is simple.
setDisabled( disabled ): Sets the disabled property.
setEventPause( evList , flag ): Disables or enables the component event.
setJSONData( json ): Sets the chart data with the given JSON object.
setOpacity( value ): Sets the opacity of the component.
setPlotColor( ): Sets the dataplot color of the chart.
setPosition( left , top , mode ): Sets the position (left, top) of the component.
setReadOnly( readOnly ): Controls the "readOnly" property.
setSize( width , heigth ): Sets the size (width, height) of the component.
setStyle( propertyName , value ): Sets the style of the specified property.
setUserData( key , value ): Sets the user data in the component.
show( displayType ): Displays the component.
toggleClass( className ): Removes a class named className, or if there is no such a class, adds a class named className.
trigger( type , array ): Triggers a certain event registered for the component.
unbind( type , function ): Removes an event registered for the component.
visible( flag ): [deprecated] Shows/Hides the component, or sets the visible property using setStyle.

Property Detail

accessibility: Supports the web accessibility requirements.
id: Component ID
labelNode: Column ID of the DataList to be used as the label data in the fwPyramidChart. The default is the first column of the DataCollection.
plotColor: Dataplot color of the chart
ref: Binds the fwPyramidChart with the DataCollection, and sets 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.
seriesColumns: DataList columns to be used as the series data of the chart when the seriesType is advanced. The default is the columns of which dataType is number except the first column.
seriesType: Series type to bind the fwPyramidChart with the DataCollection. When seriesType is simple, only Single Series and Multi Series charts are supported.
valueNode: Column ID of the DataCollection to use as the value data when the 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 class to the component.

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

Sample

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

bind( eventType , function )

Dynamically allocates events to the component.

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

Sample

// Define the event handler function for the onclick event in the input component, and bind the function. input1.bind("onclick", function(e){ alert(input1.getValue();})); // Bind commObj.ev_click function for the onclick event with component input1. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

Renames the class from oldClassName to newClassName.
In the default setting, only the classes added by addClass will be applied. In order to directly remove the class defined in the "class" property of the component, add the following setting in config.xml file.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
oldClassName	String	Y	Name of the class to remove
newClassName	String	Y	Name of the class to add

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Change tmpInputClass class to tmpInputWarninClass. input1.changeClass("tmpInputClass","tmpInputWarninClass");

draw( )

Renders the chart.

Sample

fwPyramidChart1.draw();

exportJSChart( )

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

fc( )

Returns a fusionWidget object of the fwFunnelChart type. With the returned fusionWidget object, the developer can call native APIs that support the fusionWidget.

Return
type	description
Object	FusionWidget object

Sample

chart1.fc().getJSONData();

focus( )

Moves the focus to the component.

getChartAttribute( name )

Returns the chart attributes.

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

Gets the current value of the disabled property.

Return
type	description
Boolean	The value of the disabled property.

Sample

var returnValue = componentId.getDisabled(); (Return example) false

getGenerator( )

Called by a component under the Generator component. When called, gets the parent Generator object.

Return
type	description
Object	Parent Generator object

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());} // Click trigger1 to display the generator1 object on the console. // See https://inswave.com/jira/browse/WPF-1425.

getID( )

Gets the ID of the component.

Return
type	description
String	ID of the WebSquare5 component

Sample

// The WebSquare5 component dynamically received as a parameter can be used as shown in the following. function fn_validCheck(tmpObj){ // tmpObj has an ID of "input1". var compID = tmpObj.getID(); // (Return Example) "input1" }

getJSONData( )

Returns the chart data as a JSON object.

Return
type	description
Object	Chart data

Sample

chart1.getJSONData();

getOpacity( )

Gets the opacity of the component defined in CSS.

Return
type	description
Integer	Opacity

Sample

// Apply opacity CSS to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> var returnValue = input1.getOpacity(); // "returnValue" is a real number between 0 and 1. // (Return Value) "0.2"

getPluginName( )

Gets the pluginName (or the name) of the component.

Return
type	description
String	pluginName of the WebSquare5 component

Sample

// For a WebSquare5 object dynamically received by a common function, conditional statements can be used as shown below. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); // Component ID var tmpCompType = tmpObj.getPluginName(); // Component Type if(tmpCompType == "input"){ //..Logic.. }else if(tmpCompType == "gridView"){ //..Logic .. }else{ //..Logic.. } };

getPosition( positionName )

Gets the left or top position of the component. If set by %, the corresponding pixel value will be returned.

Parameter
name	type	required	description
positionName	String	Y	[left,top] Type of the position

Return
type	description
Number	Position of the component

Sample

// Apply margin CSS to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> var returnValue = input1.getPosition("top"); // The returnValue will be a position in pixels. // (Return Example) 10

getReadOnly( )

Gets the current setting of the readOnly property.

Return
type	description
Boolean	The current setting of the readOnly property

Sample

var returnValue = componentId.getReadOnly(); // (Return Example) false

getSize( sizeName )

Gets the size of the component. If set by "%", the corresponding pixel value will be returned.

Parameter
name	type	required	description
sizeName	String	Y	[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth] Type of the size. For the calculation of each size type, see below.

Return
type	description
Number	Size of the component

Sample

var returnValue = componentId.getSize("width"); // "returnValue" will be a size in pixels. If set by "%", the corresponding pixel value will be returned. // (Return Example) 100

getStyle( propertyName )

Gets the current value of the propertyName of the component defined in CSS.

Parameter
name	type	required	description
propertyName	String	Y	Name of the property in the style

Return
type	description
String	Style value

Sample

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

getStyleValue( style )

[deprecated] Use getStyle instead.
Gets the current value of the propertyName of the component defined in CSS.

Parameter
name	type	required	description
style	String	Y	Name of the property defined in the style

Return
type	description
String	Value defined in the style property. (In case of a color, the hexcode of the color will be returned.)

getSVGString( )

Returns the chart SVG in the string format.

Return
type	description
String	Pre-processed SVG string

getTitle( )

Gets the title value.

Return
type	description
String	Title value

Sample

// Define the "title" for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); // (Return Example ) "Input Name"

getUserData( key )

Returns the user-defined property value set by setUserData as the user data or source (page XML).

Parameter
name	type	required	description
key	String	Y	Random data key

Return
type	description
String	Data of the corresponding key

Sample

// Apply the customized property (eduTest) to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" eduTest="Hello"></xf:input> input1.getUserData("eduTest"); // (Return Example) "Hello" // Use setUserData. input1.setUserData("eduTest","WebSquare"); input1.getUserData("WebSquare"); // (Return Example) "Hello"

hasClass( className )

Checks whether the component has className received as a parameter or not.

Parameter
name	type	required	description
className	String	Y	className to check

Return
type	description
Boolean	Whether the component has the class or not

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> var returnValue = input1.hasClass("tmpInputClass"); // (Return Example) true

hide( )

Hides the component.
he CSS setting will be "display:none;" and "visibility:hidden;".

Sample

componentId.hide();

removeClass( className )

Removes className from the component.
In the default setting, only the classes added by addClass will be applied. In order to directly remove the class defined in the "class" property of the component, add the following setting in config.xml file.
<style><removeDefaultClass value="true" /></style>

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

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.removeClass("tmpInputClass");

setAccessibility( flag )

A function to support web accessibility requirements.

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

Sample

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

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" } 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 the binding of the DataList with the chart 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. True to disable, or false not to disable.

Parameter
name	type	required	description
disabled	Boolean	Y	True to disable, or false not to disable.

Sample

// Disable the component. componentId.setDisabled(true);

setEventPause( evList , flag )

Disables or enables the component event.

Parameter
name	type	required	description
evList	String	N	List of the events. If not specified, all user events of the component will be listed. (Enter null data.)
flag	Boolean	Y	true is to pause, or false is to cancel pausing.

Sample

input1.setEventPause("onclick", true); // Dynamically pauses the onclick event. input1.setEventPause("onfocus,onblur", false); // Restarts the onfocus and the onblur events. input1.setEventPause(null, true); // Pauses all user events registered for the Input component.

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 of the component.

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

Sample

componentId.setOpacity(0.45);

setPlotColor( )

Sets the dataplot color of the chart.

Sample

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

setPosition( left , top , mode )

Sets the position (left, top) of the component.

Parameter
name	type	required	description
left	Number	Y	Left position or null.
top	Number	Y	Top position or null.
mode	String	N	[defulat:absolute, delta] absolute sets the current positions as x and y, and delta adds x and y to the current positions.

Sample

// Set the top position of the component as 100 pixels. componentId.setPosition(null, 100);

setReadOnly( readOnly )

Controls the "readOnly" property. True to enable, or false to disable.

Parameter
name	type	required	description
readOnly	Boolean	Y	True to enable, or false to disable.

Sample

// Enable the read-only. componentId.setReadOnly(true);

setSize( width , heigth )

Sets the size (width, height) of the component.

Parameter
name	type	required	description
width	Number	Y	Component width or null
heigth	Number	Y	Component height or null

Sample

// Set the component height as 100 pixels. componentId.setSize(null,100);

setStyle( propertyName , value )

Sets the style of the specified property.

Parameter
name	type	required	description
propertyName	String	Y	Name of the style
value	String	Y	Value of the style

Sample

// Set the component width as 200px. componentId.setStyle("width", "200px"); // Change the background color to olive. componentId.setStyle("background-color","olive");

setUserData( key , value )

Sets the user data in the component. If the key cannot be set for the component, corresponding logs will be displayed.

Parameter
name	type	required	description
key	String	Y	Random data key
value	String	Y	Random data key

Sample

// Setting a (key, value) pair of ("data", "WebSquare5") in the component. componentId.setUserData("data", "WebSquare"); // Some keys cannot be set for the component. componentId.setUserData("title", "WebSquare"); // (Log Example) !!!WARNING - [title] can't define as UserData

show( displayType )

Displays the component.
The related CSS properties are display and visibility:show;.

Parameter
name	type	required	description
displayType	String	N	[default:block ,inline ,none ,""] Value of the Display property.

Sample

// Block the "display" property. componentId.show(); // Enable the "display" property in the class. componentId.show("");

toggleClass( className )

Removes a class named className, or if there is no such a class, adds a class named className.
In the default setting, only the classes added by addClass can be removed. To remove other classes, add the following setting in config.xml.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	className to set

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.toggleClass("tmpInputClass"); // Add tmpInputClass class again. input1.toggleClass("tmpInputClass");

trigger( type , array )

Triggers a certain event registered for the component.

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

Sample

// Trigger the onclick event in the input1 component. input1.trigger("onclick"); // Trigger the onviewchange event in the input component and call the event handler function by sending arguments of (1, 2). input1.trigger("onviewchange", [1,2]);

unbind( type , function )

Removes an event registered for the component.

Parameter
name	type	required	description
type	String	N	Name of the event to remove. If not specified, all events of the components 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

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

visible( flag )

[deprecated] Shows/Hides the component, or sets the visible property using setStyle.
Sets the visibility of the component style. In case of true, set visible. In case of false, set hidden.

Parameter
name	type	required	description
flag	Boolean	Y	Visibility (In case of true, set visible. In case of false, set hidden.)