Console Webservice API

PieChart extends Chart

Other API in Package

Console

Console System

Internal Console

Method Summary
  explodeSection(String category, double percent)

Adds "explode" effect to category section. Percent specifies how far from center section will be exploded. This setting has no effect for 3D view.

String getName()

Returns the name of this chart.

String getType()

Returns the type of this chart.

  set3D(boolean enable)

Enables 3D look of pie chart if set to true

  setBackgroundColor(String color)

Sets background color for chart (e.q. 'blue' or '#FAE5B0')

  setData(Data data)

Sets input for the chart from data.

  setDataList(DataList datalist, String categoryColumn, String valueColumn)

Sets input for the chart from datalist. Category column contains values for category labels. Value column should contain numeric data.

  setDataList(DataList datalist, String categoryColumn, String valueColumn, String colorColumn)

Sets input for the chart from datalist. Category column contains values for category labels. Value column should contain numeric data. Color column can contain color for chart section.

  setShowLabels(boolean show)

Renders labels for item values if set to true

  setShowLegend(boolean show)

Displays legend for the chart if set to true

  setTitle(String title)

Sets title of this chart

ImageFile toImage(String filename, int height, int width)

Renders the chart to an image. Filename should have an extension of png, jpg, or gif

String toString()

Returns a description of this object.

Method Detail


explodeSection(String category, double percent)

Adds "explode" effect to category section. Percent specifies how far from center section will be exploded. This setting has no effect for 3D view.

Parameters:

  • String   category
  • double   percent

Since: 11-13-2009

top

String getName()

Returns the name of this chart.

Returns:  String

Since: 09-08-2008

top

String getType()

Returns the type of this chart.

Returns:  String

Since: 09-08-2008

top

set3D(boolean enable)

Enables 3D look of pie chart if set to true

Parameters:

  • boolean   enable

Since: 11-11-2009

top

setBackgroundColor(String color)

Sets background color for chart (e.q. 'blue' or '#FAE5B0')

Parameters:

  • String   color

Since: 11-11-2009

top

setData(Data data)

Sets input for the chart from data.

Parameters:

Since: 11-11-2009

top

setDataList(DataList datalist, String categoryColumn, String valueColumn)

Sets input for the chart from datalist. Category column contains values for category labels. Value column should contain numeric data.

Parameters:

  • DataList   datalist
  • String   categoryColumn
  • String   valueColumn

Since: 11-11-2009

top

setDataList(DataList datalist, String categoryColumn, String valueColumn, String colorColumn)

Sets input for the chart from datalist. Category column contains values for category labels. Value column should contain numeric data. Color column can contain color for chart section.

Parameters:

  • DataList   datalist  - Datalist with chart data. Required parameter.
  • String   categoryColumn  - Category column. Required parameter.
  • String   valueColumn  - Value column. Required parameter.
  • String   colorColumn  - Column with section colors.

Since: 02-24-2011

top

setShowLabels(boolean show)

Renders labels for item values if set to true

Parameters:

  • boolean   show

Since: 11-16-2009

top

setShowLegend(boolean show)

Displays legend for the chart if set to true

Parameters:

  • boolean   show

Since: 11-11-2009

top

setTitle(String title)

Sets title of this chart

Parameters:

  • String   title

Since: 11-11-2009

top

ImageFile toImage(String filename, int height, int width)

Renders the chart to an image. Filename should have an extension of png, jpg, or gif

Parameters:

  • String   filename Required parameter.
  • int   height Maximum allowed size of parameter: 2000
  • int   width Maximum allowed size of parameter: 2000

Returns:  ImageFile

Since: 03-01-2018

top

String toString()

Returns a description of this object.

Returns:  String

Since: 09-08-2008

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 18, 2024 01:04 PM