Class WCWConfig

Object
   |
   +--WCWConfig

class WCWConfig

Configuration class for the WCW.
Use this class to

• Control the behavoir of WCW window
• Specify the chart data source, from HTML table, data string or server
• Set user permissions to perform certain function

    var config = new WCWConfig();
    config.setChartType('p'); // for pie chart
    config.setChartSize(200, 100);
    config.setDataTableId('myDataTableId');
    
    WCWizard.show(null, config);
 

Field Detail

additionalParameterString

String additionalParameterString

Any addition parameters for Google Chart. For example. "chs=200x150&chtt=Title".

callbackUrl

String callbackUrl

The callback URL when user performa certain actions in WCW.

dataLoadURL

String dataLoadURL

The URL to load the data.
For security reason, the data URL is limited by the same origin policy. Basically, if you have relative URL, it is fine. For absolute URL, if they from same domain, it is fine. Otherwise, the data can not be loaded. See detail.

dataParseDataSeparators

String dataParseDataSeparators

The data separators, tab, space, comma, semicolon or combination of all of them. For example "\t;" for data separated by tab or semicolon

dataTable

HTML element dataTable

The table element for chart data. If you have table id, you can specify the table id dataTableId

dataTableId

String dataTableId

The table element id for chart data. For example: "dataTable" is id for <table id="dataTable" >.

dataToBeParsed

String dataToBeParsed

The data string needs WCW to parse. Each data set is separated by line. Each data element is separated by the tab, or the separators specified by dataParseDataSeparators.

debugLevel

int debugLevel

The debug level from 0 ... 5; 0 for production, and 5 will dump out all the debug information.

isAlwaysOpenNewWindow

boolean isAlwaysOpenNewWindow

To open a new window each time when user clicks, if true.

isEditBackground

boolean isEditBackground

If true, the background image will be edited.

isRedrawAfterOpen

boolean isRedrawAfterOpen

If you want to see the chart right away after the WCW window open, you set it true. Otherwise, the chart will be redraw only after user action

openTab

String openTab

The first tab to be opened. The value is the name of the tab.

outputChartId

String outputChartId

The output chart img element id, for example: "outputChart" is id for <img id="outputChart" src.... />. If no specified, the new img element will be created at the end of the page.

winHeight

int winHeight

The height of the WCW Window.

winLeft

int winLeft

The left position of the WCW Window.

winTop

int winTop

The top position of the WCW Window.

winWidth

int winWidth

The width of the WCW Window.

WCWConfig

WCWConfig()

getDataLoadURL

String getDataLoadURL()

Get data load URL

Returns:
A URL string

getDataTable

HTML element getDataTable()

Get table HTML element

Returns:
Table HTML element

isDebugMode

Object isDebugMode()

isPropertyEditable

boolean isPropertyEditable(propertyName)

Is a property editable.

Returns:
true/false

setChartData

void setChartData(dataString)

Sets the chart size.

Parameters:
dataStr - data string.
According Google Chart API, each data set is separated by "|", and each data element separated by "," for plain text data. See Google API specification for detail

setChartLabel

void setChartLabel(<String> labels)

Set chart data label

Parameters:
labels - labels for chart.
Multiple data set are separated by "|". for example

   2006|Early 2007|2008  

setChartLegend

void setChartLegend(<String> legends)

Set chart legend

Parameters:
legends - legend for chart.
Multiple data set are separated by "|". for example

   Bear|Gold Lion|Tiger  

setChartSize

void setChartSize(<int> width, <int> height)

Sets the chart size.

Parameters:
width - Width in pixels.
height - Height in pixels.

setChartTitle

void setChartTitle(<String> title)

Set chart title

Parameters:
title - Title for chart.

setChartType

void setChartType(<String> type)

Sets the chart type.

Parameters:
type - The Google Chart API type. These are valid chart types for Google Chart API

   bvg	Bar, Vertical
   bhg	Bar, Horizontal
   bvs	Bar, Stacked
   bhs	Bar, Stacked Horizontal
   lc	Line
   lxy	Line, Paired Data Set
   ls	Sparklines
   p	Pie
   p	tPie 3D
   v	Venn Diagrams
   s	Scatter Plots
   r	Radar Charts
   rs	Radar Charts, Connected
   t	Maps
   mm	Map Icon Marker
   gom	Google-o-Meter
   qr	QR codes
	  

setDataColor

void setDataColor(<String> colors)

Set chart data colors

Parameters:
colors - colors for chart.
Multiple data set are separated by ",". for example

   A52A2A,6633FF,FF9933,FF00FF  

setDataLoadURL

void setDataLoadURL(<String> dataLoadURL)

Set the URL for WCW to load the chart data.

Parameters:
dataLoadURL - URL to load the data. It could be a static page or any CGI programming output. The return will be a Google Chart parameter string. An example return:

     "chtt=This is my titel&chd=t:20,33|22,45"  

setDataTable

void setDataTable(<HTML> dataTable)

set table HTML element for chart data. If you have table id, you can specify the table id setDataTableId()

Parameters:
dataTable - HTML table element id.

setDataTableId

void setDataTableId(<String> dataTableId)

set table HTML element id for chart data. If you have HTML table element, you can specify the table setDataTable()

Parameters:
dataTableId - HTML table element id. for example, the id is "dataTable".

     <table id="dataTable" >  

setOutputChartId

void setOutputChartId(<String> outputChartId)

Set output chart img element id

Parameters:
outputChartId - Output chart img element id. For example: "outputChart" is id for

  <img id="outputChart" src.... />.    

If no specified, the new img element will be created at the end of the page.

setParameter

void setParameter(configParameters)

setPropertyEditable

void setPropertyEditable(<String> propertyNameIn, <boolean> isEditable)

Detail control of which parameter user can changes.

Parameters:
propertyNameIn - Google Chart API parameter name
isEditable - Indicates editable or not. Default for WCW is all the parameters are editable. Here is list the parameters

   cht		type
   chs		size
   chd		data
   chds		data scaling
   chl		data label
   chco		color
   chf		fill
   chtt		title
   chts		title style
   chbh		bar width
   chdl		legend
   chdlp		legend position
   chxt		axis
   chxl		axis label
   chxs		axis stype
   chg		grid
   chk		marker
   chls		line style
   choe		output encoding
  

appendParameterStr

<static> void appendParameterStr(config, addStrIn)