ChartDirector 6.0 (Ruby Edition)

ThreeDScatterGroup.setLegendIcon


Usage

void setLegendIcon(width [, height [, color ]])

Description

Sets the size and color of the legend icon.

By default, the legend icon is the same as the symbol added to the chart in its shape, size and color. In some cases, it may be desirable for the legend icon to have a different size from the plotted symbol. For example, the size of the legend icon may be sized to match the font size of the legend box, rather than the plotted size of the symbol.

ThreeDScatterChart allows the color of the symbols to vary based on the z value of the symbol. So the symbols may or may not have a fix color. By default, the mid-point of the ColorAxis (accessible via ThreeDChart.colorAxis) will be used as the legend icon color. The setLegendIcon method can be used to modify the color of the legend icon.

Setting the width or height to 0 disables the legend entry.

Arguments

ArgumentDefaultDescription
width(Mandatory)The width of the legend icon in pixels.
height-1The height of the legend icon in pixels. -1 means the height is the same as the width.
color-1The color of the legend icon. -1 means the color is the same as the symbol color at the mid-point of the ColorAxis.

Return Value

None