Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqQuery.ChartOptions

All Superinterfaces:
CqQuery.CommonOptions
All Known Implementing Classes:
CqQuery.ChartOptionsClass
Enclosing interface:
CqQuery

public static interface CqQuery.ChartOptions
extends CqQuery.CommonOptions

An extension of the CommonOptions interface specifying an additional set of parameters applying only to the generation of charts.


Nested Class Summary
static class CqQuery.ChartOptions.ImageFormat
          The possible chart image formats
 
Method Summary
 Long getHeight()
          Returns the requested height of the chart image in pixels.
 CqQuery.ChartOptions.ImageFormat getImageFormat()
          Returns the compression format requested for the chart image.
 Boolean getIsCompressionOptimized()
          Returns whether or not the compression of the image should be optimized.
 Boolean getIsGreyScale()
          Returns whether the chart image is to be rendered in grey scale or color.
 Boolean getIsInterlaced()
          Returns whether or not a PNG image should be interlaced.
 Boolean getIsProgressive()
          Returns whether or not a JPEG image is to use progressive compression.
 Integer getQuality()
          Returns the requested quality of JPEG compression, expressed as an integer between 1 (maximum compression) and 100 (maximum fidelity).
 Long getWidth()
          Returns the requested width of the chart image.
 
Methods inherited from interface CqQuery.CommonOptions
getQueryPropertyRequest, getRowNumberLimit
 

Method Detail

getHeight

Long getHeight()
Returns the requested height of the chart image in pixels.

Returns:
The height of the image in pixels.

getImageFormat

CqQuery.ChartOptions.ImageFormat getImageFormat()
Returns the compression format requested for the chart image.

Returns:
An ImageFormat enumerator specifying whether the generated chart image should use JPEG or PNG compression format.

getIsCompressionOptimized

Boolean getIsCompressionOptimized()
Returns whether or not the compression of the image should be optimized.

Returns:
true if the compression is to be optimized.

getIsGreyScale

Boolean getIsGreyScale()
Returns whether the chart image is to be rendered in grey scale or color.

Returns:
If true, the chart image will be in grey scale, not color.

getIsInterlaced

Boolean getIsInterlaced()
Returns whether or not a PNG image should be interlaced.

Returns:
If true, a PNG image will be interlaced.

getIsProgressive

Boolean getIsProgressive()
Returns whether or not a JPEG image is to use progressive compression.

Returns:
If true, progressive compression will be used in the JPEG format.

getQuality

Integer getQuality()
Returns the requested quality of JPEG compression, expressed as an integer between 1 (maximum compression) and 100 (maximum fidelity).

Returns:
An Integer between 1 and 100.

getWidth

Long getWidth()
Returns the requested width of the chart image.

Returns:
An Long specifying the requested width of the chart image in pixels.

Generated Thu 24-Sep-2009 06:56 AM

Copyright © IBM 2009. All rights reserved.