JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.chart3d
Interface JCChart3dLegendLabelGenerator


public interface JCChart3dLegendLabelGenerator

To be implemented by a user-specific legend label generator.


Method Summary
 Object generateLegendLabel(com.klg.jclass.chart3d.JCChart3d chart3d, int level, double zmin, double zmax, Object label)
          Generates a label for the given legend level.
 

Method Detail

generateLegendLabel

public Object generateLegendLabel(com.klg.jclass.chart3d.JCChart3d chart3d,
                                  int level,
                                  double zmin,
                                  double zmax,
                                  Object label)
Generates a label for the given legend level. This call is used for both value and ranged legend labels. Value labels are generated for an explicit level value. Ranged labels are generated from the previous level value to the current level value.

Parameters:
chart3d - an instance of the current JCChart3D object.
level - the zero-indexed level this label is being generated for. If the level is -1, the label is being generated for the minimum data value before the first level. If the level is equal to the number of levels, the label is being generated for the maximum data value after the last level.
zmin - the minimum value of this level range. In a non-ranged label case, this will be equal to zmax.
zmax - the maximum value of this level.
label - the default label generated by the legend. This may be an instance of String or JCMultiFieldString.
Returns:
the label to use for this contour level. This may be an instance of String or JCMultiFieldString. If the return value is null, no legend item will be created for this level.

Copyright © 2004 Quest Software Inc..
All rights reserved.