WebSquare.uiplugin.fwGanttChart

fwGanttChart 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

autoCategory: Generates category in the fwGanttChart.
categoryDepth: Sets the category depth when the category is automatically created.
dataColumns: [default:""] Column ID to be used in the datatable. (Multiple IDs can be used with use of “,” separator.)
dateformat: Date format of the chart
endDateNode: Column ID to use as the endDateNode when binding the chart with a DataList
id: Component ID
monthNames: Month names for the fwGanttChart categories.
multiTasks: Uses the multiTasks in the chart.
plotColor: Dataplot color of the chart
processNode: Column ID to use as the processNode when binding the chart with a DataList
quarterNames: Sets the quarterNames required to create category for the chart.
ref: Binds the fwGanttChart with a DataList.
resizeLastMonth: [default:false, true] Adjusts the width according to the number of 2-depth columns belonging to the last column with timeBase="date" and categoryDepth="2".
startDateNode: Column ID to use as the startDateNode when binding the chart with a DataList
taskIdNode: Column ID to use as the taskIdNode when binding the chart with a DataList
taskNode: Column ID to use as the taskNode when binding the chart with a DataList
timeBase: Timebase of the chart
timeGap: Sets the time gap when the category is auto.
version: FusionChart version.

Event Summary

Method Summary

addCategories( fwGanttChart ): Adds catagories.
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( type ): Exports charts rendered in JavaScript in JPG, PNG, and PDF formats.
fc( ): Returns a fusionWidget object of the fwGanttChart 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.
setCategories( fwGanttChart ): Sets the categories of the chart.
setChartAttribute( options ): Changes the attribute values of the chart.
setConnector( info ): Sets connectors among the tasks.
setDatatableAttribute( datatable ): Sets the properties used by the datatable of the fwGanttChart.
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.
setMilestone( Milestone ): Sets the task milestones.
setOpacity( value ): Sets the opacity of the component.
setPosition( left , top , mode ): Sets the position (left, top) of the component.
setProcessesAttribute( processAttributes ): Sets the process attributes.
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.
setTaskAttribute( taskAtribute ): Sets the task in the fwGanttChart.
setTasksColor( taskID , color ): Sets the task color.
setTrendLine( trendLine ): Adds a vertical line.
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

autoCategory: Generates category in the fwGanttChart.
categoryDepth: Sets the category depth when the category is automatically created.
dataColumns: [default:""] Column ID to be used in the datatable. (Multiple IDs can be used with use of “,” separator.)
(Similar to the processes. The difference is that it allows insertion of multiple columns to the left in the graph.)
Related API: setDatatableAttribute (Sets the column attributes in the datatable.)
dateformat: Date format of the chart
endDateNode: Column ID to use as the endDateNode when binding the chart with a DataList
id: Component ID
monthNames: Month names for the fwGanttChart categories.
multiTasks: Uses the multiTasks in the chart.
plotColor: Dataplot color of the chart
processNode: Column ID to use as the processNode when binding the chart with a DataList
quarterNames: Sets the quarterNames required to create category for the chart.
ref: Binds the fwGanttChart with a DataList.
resizeLastMonth: [default:false, true] Adjusts the width according to the number of 2-depth columns belonging to the last column with timeBase="date" and categoryDepth="2".
For example, if the last day of the chart is July 12 falling in the third quarter, the third quarter will include only July and the width is accordingly smaller.
true: Adjusts the width. false (Default): Does not adjust the width. Regardless of the number of the 2-depth columns in the last category, all category will have the same width.
startDateNode: Column ID to use as the startDateNode when binding the chart with a DataList
taskIdNode: Column ID to use as the taskIdNode when binding the chart with a DataList
taskNode: Column ID to use as the taskNode when binding the chart with a DataList
timeBase: Sets the timebase in the fwGanttChart.
timeGap: Sets the time gap when the category is auto.
version: FusionChart version.

Event Detail

Method Detail

addCategories( fwGanttChart )

Adds categories.

Parameter
name	type	required	description
fwGanttChart	Object	Y	Category data

Sample

var data = {"category":[ {"start":"02/01/2015","end":"03/31/2015","label":"Q1"}, {"start":"04/01/2015","end":"06/30/2015","label":"Q2"} ] }; fwGanttChart1.addCategories(data);

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

fwGaugeChart1.draw();

exportJSChart( type )

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

Parameter
name	type	required	description
type	String	Y	File type. Default : jpg

Sample

fwGanttChart.exportJSChart("pdf");

fc( )

Returns a fusionWidget object of the fwGanttChart type. Using the fusionWidget object, it is possible to call the 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");

setCategories( fwGanttChart )

Sets the categories of the chart.

Parameter
name	type	required	description
fwGanttChart	Object	Y	Category data

Sample

var data = {"category":[ {"start":"02/01/2015","end":"03/31/2015","label":"Q1"}, {"start":"04/01/2015","end":"06/30/2015","label":"Q2"} ] }; fwGanttChart1.setCategories(data);

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" } fwGanttChart1.setChartAttribute(options);

setConnector( info )

Sets connectors among the tasks.

Parameter
name	type	required	description
info	Object	Y	Connection

Sample

var info = { "fromtaskid": "2", "totaskid": "1", "thickness": "2" }; fwGanttChart1.setConnector(info);

setDatatableAttribute( datatable )

Sets the properties used by the datatable of the fwGanttChart.
Related property: dataColumns (To set the column ID to be used by the datatable.)

Parameter
name	type	required	description
datatable	Object	Y	Attribute

Sample

// The datatable uses multiple columns. |var obj = { "headerbgcolor": "#999999", "headerfontcolor": "#ffffff", "datacolumn" : [ { "bgcolor": "#eeeeee", "headertext": "ActualStartDate" }, { "bgcolor": "#eeeeee", "headertext": "ActualEndDate" }] }; fwGanttChart1.setProcessesAttribute(info);

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

setMilestone( Milestone )

Sets the task milestones.

Parameter
name	type	required	description
Milestone	Object	Y

Sample

var info = { "date": "05/01/2015", "taskid": "3", "color": "#f8bd19", "shape": "star", "tooltext": "MileStones" }; fwGanttChart1.setMilestones(info);

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

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

setProcessesAttribute( processAttributes )

Sets the process attributes.

Parameter
name	type	required	description
processAttributes	Object	Y

Sample

var info = { "align":"right", "hoverBandColor":"990000", "isBold":"1", "fontSize":"15" }; fwGanttChart1.setProcessesAttribute(info);

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

setTaskAttribute( taskAtribute )

Sets the task in the fwGanttChart.

Parameter
name	type	required	description
taskAtribute	Object	Y

Sample

var info = { "fontcolor":"ff0000", "showenddate":"1", "fontSize":"20" }; fwGanttChart1.setTaskAttribute(info);

setTasksColor( taskID , color )

Sets the task color.

Parameter
name	type	required	description
taskID	String	Y	Task ID
color	String	Y	Color to use

Sample

fwGanttChart1.setTasksColor("7","#ffff00");

setTrendLine( trendLine )

Adds a vertical line which can be used as a starting or ending point.

Parameter
name	type	required	description
trendLine	Object	Y

Sample

var info = { "line":[{"start":"07/09/2015","displayValue":"Start Point","color":"ff0000","thickness":"2","dashed":"1"}] }; fwGanttChart1.setTrendLine(info);

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