Thank for the review Adam, I will make all the changes suggested by you.
Regarding verticalMajorCount, verticalMinorCount and horizontalMinorCount,
these control the gridLines along the y and x axis. So do YMajorGridLines,
YMinorGridLines and XMajorGridLines make more sense?
Venkata
On 9/19/06, Adam Winer <[EMAIL PROTECTED]> wrote:
On 9/19/06, venkata guddanti <[EMAIL PROTECTED]> wrote:
> Hi All,
>
> Here is the API review for the Chart Component.
> **
> *UIXChart Attributes:*
>
> 1. *value* - the data model being used by this component.The specific
> model class must be derived from <code>
> org.apache.myfaces.trinidad.model.ChartModel</code>. The derived
class
> must override the abstract methods to provide the required values for
chart
> display.
> 2. *drillDownListener* - a method reference to a drill down listener
> that will be called when the user drills down into the chart data.
The
> method must take a parameter of type
> org.apache.myfaces.trinidad.event.ChartDrillDownEvent .
If the listener is of type ChartDrillDownListener, I think this
attr needs to be called chartDrillDownListener.
> *CoreChart Attributes:*
>
> 1. *type* - The type of chart. Possible Values are:verticalBar
> horizontalBar stackedVerticalBar stackedHorizontalBar pie area
stackedArea
> line barLine XYLine scatterPlot radar radarArea funnel circularGauge
> semiCircularGauge ..
Cool! :)
> 2. *
>
> templateDocumentUrl *- Specifies url for *the* template document from
> which the chart elements are cloned.* *If this attribute is null ,
the
> chart component uses a default template. The default template is
chosen
> *based on* whether the useGradient attribute is true or false.* *The
*
> template* document is useful for changing the Look And Feel (L&F) of
> the chart.* *Some examples include*:*
> - A developer may want to skin the chart to match its corporate L&F.
> - A developer may want to put water marks/background images
> inside the chart.
> - A developer may want to change the template for the gauges
> used in the gauge charts.
> - A developer may want to turn off gradients and instead use
> filters to set some interesting effects on the chart elements.
Maybe call this templateSource? Is it an URL, e.g., does it use
the same rules ("/foo.xyz" means web-app relative)?
> 3.
>
> *perspective - *Specifies if the chart is drawn with a perspective (
> 2.5D). By default the chart is draw with a perspective.
> 4.
>
> *legendLocation - * Specified the location of the legend. The legend
> can be turned off by setting this attribute to none. Otherwise it can
be
> drawn at top, start, end or bottom.
legendPosition might be better (I think there's some things in
Trinidad called position already).
> 5.
>
> *animationDuration - *The duration of the animation for the chart
> components in milliseconds. Animation can be turned off if the
> animationDuration is set to 0. The default value is 1000ms.
> 6.
>
> *verticalMajorCount -* this attribute controls the number of vertical
> major sections displayed in the chart.For horizontal
> charts(horizontalBar, stackedHorizontalBar) this attribute controls
the
> horizontal major sections. The default is 4.
I don't get what "major sections" and "minor sections" are...
> 7.
>
> *verticalMinorCount - *This attribute controls the number of minor
> sections displayed within a major section. The default value is -1,
which
> means it varies per chart type. Currently it is used only for gauge
> charts with a default of 4.
> 8.
>
> *horizontalMajorCount *- This attribute controls the number of
> horizontal major sections displayed in the chart. The default value
is -1,
> which implies that the horizontal major sections are controlled by
the
> groupLabels in the chart model. This parameter along with the
groupLables
> provide flexibility in labeling the groups. For e.g. one can display
a
> vertical bar chart with 2 years data. Only quarters may be labeled
and
> horizontalMajorCount can be 2 for splitting the data into two
sections.
> 9.
>
> *maxPrecision* - The maximum precision of the numbers displayed on
the
> yAxis(xAxis for horizontal charts). The default is 0.
> 10.
>
> *useGradients -* Specifies if gradients are used to display chart
> elements. By default the chart elements use gradients.
isUseGradients() is akward - "gradientsUsed"?
> 11.
>
> *displayTooltips - *Specifies if tooltips are displayed or not.
isDisplayTooltips() is awkward... how about "tooltipsVisible"?
On the actual model API (not listed here), I think it'd be better
to use double than float, and to use java.awt.Color over
java.lang.String (for example, inputColor uses java.awt.Color
objects, not strings, so those will flow together nicely).
-- Adam
