IlvScale (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvChartOwnedDrawable
- - ilog.views.chart.IlvScale

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, IlvChartDrawable, Serializable
```
public class IlvScale
extends IlvChartOwnedDrawable
implements IlvChartAreaAccessible, Serializable
```
Represents a scale that can be connected to a chart axis.
Scales might be defined as a graphical representation of a chart axis. As such, a scale is always associated with an IlvAxis instance. The axis to bind to a scale is determined when a scale is added to a chart, using the IlvChart.setXScale(ilog.views.chart.IlvScale) and IlvChart.setYScale(int, ilog.views.chart.IlvScale) methods.
A scale is composed of:
- An axis representation, which depends on the chart projection (could be a line or an arc).
- Major ticks, the marks drawn on the axis at each step of the scale.
- Steps labels, drawn next to the major ticks. These labels indicate the values of the coordinate represented by the scale.
- Minor ticks, the marks drawn on the axis at each substep of the scale.
- A title, which can be placed anywhere along the axis representation.
Here is a figure showing the different parts of a scale:
Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADAPTIVE_SKIP` Skip label type: indicates that the scale considers every label from the first to the last, and determines which one should be skipped to avoid overlapping.
`static int`	`CONSTANT_SKIP` Skip label type: indicates that the scale computes a constant number of labels to skip to avoid overlapping.
`static int`	`INSIDE` Circular scale side (x scale in polar or radar chart): Labels, title, and "outside" ticks are drawn inside the circle.
`static int`	`LEFT_SIDE` Radial scale side (y scale in polar or radar chart): Labels, title, and "outside" ticks are drawn to the left of the radial scale.
`static int`	`LOWER_SIDE` Side: Labels, title, and "outside" ticks are drawn towards decreasing values of the dual axis.
`static int`	`OUTSIDE` Circular scale side (x scale in polar or radar chart): Labels, title, and "outside" ticks are drawn outside the circle.
`static int`	`RIGHT_SIDE` Radial scale side (y scale in polar or radar chart): Labels, title, and "outside" ticks are drawn to the right of the radial scale.
`static int`	`TICK_CROSS` Tick layout type: ticks are drawn both inside and outside the plot area.
`static int`	`TICK_INSIDE` Tick layout type: ticks are drawn inside the plot area.
`static int`	`TICK_OUTSIDE` Tick layout type: ticks are drawn outside the plot area.
`static int`	`UPPER_SIDE` Side: Labels, title, and "outside" ticks are drawn towards increasing values of the dual axis.

Constructor Summary

Constructors
Constructor and Description
`IlvScale()` Creates a numeric scale with the step and substep units automatically computed.
`IlvScale(double stepUnit, double subStepUnit)` Creates a new numeric scale with the specified step and substep units.
`IlvScale(IlvTimeUnit timeUnit)` Creates a new time scale with the specified time unit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(IlvScaleAnnotation annotation)` Adds an annotation to this scale.
`protected void`	`baseTextDirectionChanged()` This method is invoked when the effective base text direction has changed.
`protected void`	`chartConnected(IlvChart oldChart, IlvChart newChart)` This method is called with a non-`null` argument when this drawable object is being attached to a chart.
`protected void`	`componentOrientationChanged(ComponentOrientation oldOrientation, ComponentOrientation newOrientation)` This method is invoked when the component orientation of the chart that displays this scale has changed.
`protected Rectangle2D`	`computeBounds(Rectangle2D bounds)` Computes the entire bounds.
`String`	`computeLabel(double value)` Returns the label associated with the specified value.
`protected IlvDoublePoint`	`computeLabelLocation(IlvDoublePoint loc, double tickAngle, int offset, double width, double height)` Computes the location of a step label.
`void`	`draw(Graphics dst)` Draws the scale into the specified `Graphics` context.
`void`	`drawHighlight(Graphics g)` Draws this scale as highlighted.
`void`	`drawIntoHitmap(IlvChartHitmapDefinition definition, IlvChartHitmapAccumulator accumulator)` Draws the rendering into a hitmap.
`void`	`drawSelectionHandles(Graphics g, IlvHandlesSelectionStyle style)` Draws this scale with selection handles.
`IlvScaleAnnotation[]`	`getAnnotations()` Returns the annotations attached to this scale.
`IlvAxis`	`getAxis()` Returns the axis to which this scale is connected.
`static int`	`getAxisIndex(IlvScale scale)` Returns the axis index of the specified scale.
`Stroke`	`getAxisStroke()` Returns the stroke used to draw the axis and ticks.
`Rectangle2D`	`getBounds(Rectangle2D bounds)` Returns the bounds of this scale.
`Rectangle2D`	`getBoundsUsingCache(Rectangle2D bounds)` Returns the bounds of this scale, without unnecessary recomputations.
`IlvChart`	`getChart()` Returns the chart displaying this scale.
`int`	`getCircleSide()` Returns the side of the labels, title, and "outside" ticks along the circular scale of a polar or radial chart.
`ComponentOrientation`	`getComponentOrientation()` Returns the component orientation of the chart that displays this scale.
`IlvCoordinateSystem`	`getCoordinateSystem()` Returns the coordinate system formed by this scale axis and its dual axis.
`IlvAxis.Crossing`	`getCrossing()` Returns where this scale crosses its dual axis.
`double`	`getCrossingValue()` Returns the value at which this scale crosses its dual axis.
`int`	`getDefaultSide()` Returns the default side of the labels, title and "outside" ticks.
`int`	`getDrawOrder()` Returns the drawing order of this scale.
`IlvAxis`	`getDualAxis()` Returns the dual axis of this scale.
`Color`	`getForeground()` Returns the color used to draw the axis and step labels.
`int`	`getLabelAlignment()` Returns the alignment of step labels.
`Rectangle2D`	`getLabelBounds(int stepIdx, Rectangle2D bounds)` Returns the bounds of the step label at the specified index.
`Color`	`getLabelColor()` Returns the color used to display the step labels.
`int`	`getLabelCount()` Returns the number of step labels.
`Font`	`getLabelFont()` Returns the font used to draw the step labels.
`IlvValueFormat`	`getLabelFormat()` Returns the format of step labels.
`int`	`getLabelOffset()` Returns the offset between tick marks and labels.
`double`	`getLabelRotation()` Returns the rotation applied to the step labels.
`double`	`getLabelValue(int stepIdx)` Returns the value associated with the specified step label.
`int`	`getMajorTickSize()` Returns the size of major tick marks.
`int`	`getMinorTickSize()` Returns the size of minor tick marks.
`int`	`getRadialSide()` Returns the side of the labels, title, and "outside" ticks along the radial scale of a polar or radial chart.
`int`	`getResolvedBaseTextDirection()` Returns the resolved base text direction.
`int`	`getSide()` Returns the side of the labels, title, and "outside" ticks.
`int`	`getSkipLabelMode()` Indicates how the scale determines the labels to skip.
`IlvStepsDefinition`	`getStepsDefinition()` Returns the object used to compute the steps of this scale.
`IlvDoubleArray`	`getStepValues()` Returns the step values.
`IlvDoubleArray`	`getSubStepValues()` Returns the substep values.
`int`	`getTickLayout()` Returns the layout of tick marks.
`String`	`getTitle()` Returns the title associated to this scale.
`Shape`	`getTitleBackgroundShape()` Returns the background shape of the title.
`Font`	`getTitleFont()` Returns the title font.
`int`	`getTitleOffset()` Returns the offset between the scale title and the step labels.
`int`	`getTitlePlacement()` Returns the title placement.
`IlvLabelRenderer`	`getTitleRenderer()` Returns the `IlvLabelRenderer` used to draw the title.
`double`	`getTitleRotation()` Returns the title rotation.
`boolean`	`has3DSupport()` Indicates whether the scale supports three-dimensional drawing.
`boolean`	`hit(Point2D pt)` Returns the result of a hit testing on the specified point.
`boolean`	`isAutoCrossing()` Indicates whether the scale uses a default crossing location.
`boolean`	`isAutoSide()` Indicates whether the side of the labels, title and "outside" ticks is chosen automatically.
`boolean`	`isAutoWrapping()` Indicates whether step labels are wrapped.
`boolean`	`isAxisVisible()` Indicates whether the axis is visible.
`boolean`	`isCategory()` Indicates whether this scale displays categories.
`boolean`	`isLabelVisible()` Indicates whether step labels are visible.
`boolean`	`isMajorTickVisible()` Indicates whether major ticks are visible.
`boolean`	`isMinorTickVisible()` Indicates whether minor ticks are visible.
`boolean`	`isSkippingLabel()` Indicates whether the scale skips step labels when they overlap.
`boolean`	`isViewable()` Indicates whether this scale can be displayed.
`boolean`	`isVisible()` Indicates whether this scale is visible.
`void`	`recalc()` Recalculates the steps values and labels.
`void`	`removeAnnotation(IlvScaleAnnotation annotation)` Removes the specified annotation from this scale.
`void`	`setAnnotations(IlvScaleAnnotation[] annotations)` Sets the annotations attached to this scale.
`void`	`setAutoCrossing(boolean auto)` Specifies whether the scale uses a default crossing location.
`void`	`setAutoSide(boolean auto)` Specifies whether the side of the labels, title and "outside" ticks should be chosen automatically.
`void`	`setAutoWrapping(boolean autoWrapping)` Toggles the automatic wrapping of step labels.
`void`	`setAxisStroke(Stroke stroke)` Specifies the stroke for the axis and ticks.
`void`	`setAxisVisible(boolean visible)` Toggles the visibility of the axis.
`void`	`setCategory(boolean isCategory)` Specifies that this scale should display categories.
`void`	`setCategory(IlvDataSet dataSet, boolean tickBetweenCategory)` Specifies that this scale should display categories.
`void`	`setCircleSide(int side)` Sets the side where to place the labels, title, and "outside" ticks along the circular scale of a polar or radial chart.
`void`	`setCrossing(IlvAxis.Crossing crossing)` Specifies where this scale crosses its dual axis.
`void`	`setCrossingValue(double value)` Specifies where this scale crosses its dual axis.
`void`	`setDrawOrder(int drawOrder)` Sets the drawing order of this scale.
`void`	`setForeground(Color color)` Changes the color of the scale axis.
`void`	`setLabelAlignment(int alignment)` Specifies the alignment of step labels.
`void`	`setLabelColor(Color color)` Changes the color used to display the step labels.
`void`	`setLabelFont(Font font)` Sets the font used to draw the step labels.
`void`	`setLabelFormat(IlvValueFormat fmt)` Specifies a format for the step labels.
`void`	`setLabelOffset(int offset)` Specifies the offset between tick marks and labels.
`void`	`setLabelRotation(double angle)` Specifies the rotation of the step labels.
`void`	`setLabelVisible(boolean visible)` Toggles the visibility of step labels.
`void`	`setLogarithmic(double logBase)` Put the scale into logarithmic mode.
`void`	`setMajorTickSize(int size)` Specifies the size of major tick marks.
`void`	`setMajorTickVisible(boolean visible)` Toggles the visibility of major ticks.
`void`	`setMinorTickSize(int size)` Specifies the size of minor tick marks.
`void`	`setMinorTickVisible(boolean visible)` Toggles the visibility of minor ticks.
`void`	`setRadialSide(int side)` Sets the side where to place the labels, title, and "outside" ticks along the radial scale of a polar or radial chart.
`void`	`setSide(int side)` Sets the side where to place the labels, title, and "outside" ticks.
`void`	`setSkipLabelMode(int mode)` Specifies how the scale determines the labels to skip.
`void`	`setSkippingLabel(boolean skip)` Tells the scale to skip step labels when they overlap.
`void`	`setStepsDefinition(IlvStepsDefinition stepsDefinition)` Changes the steps definition.
`void`	`setStepUnit(Double stepUnit, Double subStepUnit)` Specifies the step and substep units of this scale.
`void`	`setTickLayout(int layout)` Specifies the layout of tick marks.
`void`	`setTimeUnit(IlvTimeUnit timeUnit)` Specifies a time unit for this scale.
`void`	`setTitle(String text)` Sets the scale title text.
`void`	`setTitle(String text, double rotation)` Sets the scale title to the specified string with the specified rotation.
`void`	`setTitleFont(Font font)` Sets the title font.
`void`	`setTitleOffset(int offset)` Specifies the offset between the scale title and the step labels.
`void`	`setTitlePlacement(int pos)` Sets the title placement.
`void`	`setTitleRotation(double angle)` Sets the title rotation.
`void`	`setVisible(boolean visible)` Toggles the visibility of this scale.
`Point`	`toPoint(double value)` Returns the location on the axis of the specified value.
`double`	`toValue(int x, int y)` Returns the value corresponding to the specified point on the scale.
`void`	`updateAnnotations()` Called by the scale while it computes its bounds.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TICK_INSIDE
```
public static final int TICK_INSIDE
```
    Tick layout type: ticks are drawn inside the plot area.
    
    See Also:
    
    setTickLayout(int), Constant Field Values
  - TICK_OUTSIDE
```
public static final int TICK_OUTSIDE
```
    Tick layout type: ticks are drawn outside the plot area.
    
    See Also:
    
    setTickLayout(int), Constant Field Values
  - TICK_CROSS
```
public static final int TICK_CROSS
```
    Tick layout type: ticks are drawn both inside and outside the plot area.
    
    See Also:
    
    setTickLayout(int), Constant Field Values
  - CONSTANT_SKIP
```
public static final int CONSTANT_SKIP
```
    Skip label type: indicates that the scale computes a constant number of labels to skip to avoid overlapping.
    
    See Also:
    
    setSkipLabelMode(int), Constant Field Values
  - ADAPTIVE_SKIP
```
public static final int ADAPTIVE_SKIP
```
    Skip label type: indicates that the scale considers every label from the first to the last, and determines which one should be skipped to avoid overlapping.
    
    See Also:
    
    setSkipLabelMode(int), Constant Field Values
  - LOWER_SIDE
```
public static final int LOWER_SIDE
```
    Side: Labels, title, and "outside" ticks are drawn towards decreasing values of the dual axis.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setSide(int), Constant Field Values
  - UPPER_SIDE
```
public static final int UPPER_SIDE
```
    Side: Labels, title, and "outside" ticks are drawn towards increasing values of the dual axis.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setSide(int), Constant Field Values
  - LEFT_SIDE
```
public static final int LEFT_SIDE
```
    Radial scale side (y scale in polar or radar chart): Labels, title, and "outside" ticks are drawn to the left of the radial scale.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setRadialSide(int), Constant Field Values
  - RIGHT_SIDE
```
public static final int RIGHT_SIDE
```
    Radial scale side (y scale in polar or radar chart): Labels, title, and "outside" ticks are drawn to the right of the radial scale.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setRadialSide(int), Constant Field Values
  - OUTSIDE
```
public static final int OUTSIDE
```
    Circular scale side (x scale in polar or radar chart): Labels, title, and "outside" ticks are drawn outside the circle.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setCircleSide(int), Constant Field Values
  - INSIDE
```
public static final int INSIDE
```
    Circular scale side (x scale in polar or radar chart): Labels, title, and "outside" ticks are drawn inside the circle.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setCircleSide(int), Constant Field Values
- Constructor Detail
  - IlvScale
```
public IlvScale()
```
    Creates a numeric scale with the step and substep units automatically computed.
  - IlvScale
```
public IlvScale(double stepUnit,
                double subStepUnit)
```
    Creates a new numeric scale with the specified step and substep units.
    
    Parameters:
    
    stepUnit - The step unit of the scale steps definition. If this parameter is zero, the step unit is automatically computed.
    
    subStepUnit - The substep unit of the scale steps definition. If this parameter is zero, the substep unit is automatically computed.
    
    See Also:
    
    setStepUnit(Double, Double)
  - IlvScale
```
public IlvScale(IlvTimeUnit timeUnit)
```
    Creates a new time scale with the specified time unit.
    
    Parameters:
    
    timeUnit - The time unit of the scale steps definition. If this parameter is null, the time unit is automatically computed.
    
    See Also:
    
    setTimeUnit(ilog.views.chart.IlvTimeUnit)
- Method Detail
  - getComponentOrientation
```
public final ComponentOrientation getComponentOrientation()
```
    Returns the component orientation of the chart that displays this scale.
    
    Since:
    
    JViews 8.8
  - componentOrientationChanged
```
protected void componentOrientationChanged(ComponentOrientation oldOrientation,
                                           ComponentOrientation newOrientation)
```
    This method is invoked when the component orientation of the chart that displays this scale has changed.
    
    Parameters:
    
    oldOrientation - The component orientation before the change.
    
    newOrientation - The component orientation after the change.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    getComponentOrientation()
  - getAxisStroke
```
public final Stroke getAxisStroke()
```
    Returns the stroke used to draw the axis and ticks.
    
    See Also:
    
    setAxisStroke(java.awt.Stroke)
  - setAxisStroke
```
public void setAxisStroke(Stroke stroke)
```
    Specifies the stroke for the axis and ticks.
    
    See Also:
    
    getAxisStroke()
  - getResolvedBaseTextDirection
```
public int getResolvedBaseTextDirection()
```
    Returns the resolved base text direction.
    The base text direction influences the display of text strings that are composed of segments that are read from left to right as well as of segments that are read from right to left. It determines the order of these segments.
    
    Returns:
    
    One of IlvBidiUtil.CONTEXTUAL_DIRECTION, IlvBidiUtil.LEFT_TO_RIGHT, IlvBidiUtil.RIGHT_TO_LEFT.
    
    Since:
    
    JViews 8.8
  - baseTextDirectionChanged
```
protected void baseTextDirectionChanged()
```
    This method is invoked when the effective base text direction has changed. That is, it is invoked
    1. when the value of getResolvedBaseTextDirection() has changed, or
    2. when the value of getComponentOrientation() has changed and the value of getResolvedBaseTextDirection() is IlvBidiUtil.CONTEXTUAL_DIRECTION.
    Since:
    
    JViews 8.8
  - getLabelFont
```
public final Font getLabelFont()
```
    Returns the font used to draw the step labels.
  - setLabelFont
```
public void setLabelFont(Font font)
```
    Sets the font used to draw the step labels.
  - getLabelColor
```
public final Color getLabelColor()
```
    Returns the color used to display the step labels.
    
    See Also:
    
    setLabelColor(java.awt.Color)
  - setLabelColor
```
public void setLabelColor(Color color)
```
    Changes the color used to display the step labels. If this color is not explicitly specified, the foreground of the scale is used.
    
    See Also:
    
    getLabelColor()
  - getForeground
```
public Color getForeground()
```
    Returns the color used to draw the axis and step labels.
  - setForeground
```
public void setForeground(Color color)
```
    Changes the color of the scale axis.
    
    See Also:
    
    setLabelColor(java.awt.Color)
  - getDrawOrder
```
public final int getDrawOrder()
```
    Returns the drawing order of this scale. The default drawing order is Integer.MAX_VALUE.
    
    Specified by:
    
    getDrawOrder in interface IlvChartDrawable
    
    Returns:
    
    An integer that represents the drawing order. The IlvChartDrawable objects are drawn in ascending drawing order. The drawing order also specifies whether the object is drawn above (positive values) or below (negative values) the graphical representations of the chart data.
    
    See Also:
    
    setDrawOrder(int)
  - setDrawOrder
```
public void setDrawOrder(int drawOrder)
```
    Sets the drawing order of this scale.
    
    See Also:
    
    IlvChart.DRAW_ABOVE, IlvChart.DRAW_BELOW, getDrawOrder()
  - getMajorTickSize
```
public final int getMajorTickSize()
```
    Returns the size of major tick marks.
    
    See Also:
    
    setMajorTickSize(int)
  - setMajorTickSize
```
public void setMajorTickSize(int size)
```
    Specifies the size of major tick marks. The default size is 6.
    
    See Also:
    
    getMajorTickSize()
  - getMinorTickSize
```
public final int getMinorTickSize()
```
    Returns the size of minor tick marks.
    
    See Also:
    
    setMinorTickSize(int)
  - setMinorTickSize
```
public void setMinorTickSize(int size)
```
    Specifies the size of minor tick marks. The default size is 3.
    
    See Also:
    
    getMinorTickSize()
  - getTickLayout
```
public final int getTickLayout()
```
    Returns the layout of tick marks.
    
    See Also:
    
    setTickLayout(int)
  - setTickLayout
```
public void setTickLayout(int layout)
```
    Specifies the layout of tick marks.
    
    See Also:
    
    TICK_INSIDE, TICK_OUTSIDE, TICK_CROSS, getTickLayout()
  - getLabelOffset
```
public final int getLabelOffset()
```
    Returns the offset between tick marks and labels.
    
    Returns:
    
    The offset between tick marks and labels.
    
    See Also:
    
    setLabelOffset(int)
  - setLabelOffset
```
public void setLabelOffset(int offset)
```
    Specifies the offset between tick marks and labels. The default offset is 3.
    
    See Also:
    
    getLabelOffset()
  - getTitleOffset
```
public final int getTitleOffset()
```
    Returns the offset between the scale title and the step labels.
    
    Returns:
    
    The offset between the scale title and the step labels.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setTitleOffset(int)
  - setTitleOffset
```
public void setTitleOffset(int offset)
```
    Specifies the offset between the scale title and the step labels. The default offset is 3.
    
    Parameters:
    
    offset - The new title offset.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    getTitleOffset()
  - isAutoWrapping
```
public final boolean isAutoWrapping()
```
    Indicates whether step labels are wrapped.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setAutoWrapping(boolean)
  - setAutoWrapping
```
public void setAutoWrapping(boolean autoWrapping)
```
    Toggles the automatic wrapping of step labels. When the wrapping is turned on, the scale tries to wrap the labels into several lines according to the space available between two steps. The wrapping also takes into account the explicit new line characters ('\n') that are embedded in the label string.
    Note: Label wrapping does not check the orientation nor the type of the scale. Similarly, it does not take into account the rotation of scale labels. It should only be enabled for scales whose labels are parallel to the axis.
    
    Parameters:
    
    autoWrapping - Whether automatic wrapping is used.
    
    Since:
    
    JViews 5.5
  - getLabelAlignment
```
public final int getLabelAlignment()
```
    Returns the alignment of step labels.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setLabelAlignment(int)
  - setLabelAlignment
```
public void setLabelAlignment(int alignment)
```
    Specifies the alignment of step labels. The alignment is only used for multiline labels. It can take the following values:
    - SwingConstants.LEFT: left alignment.
    - SwingConstants.CENTER (default): centered alignment.
    - SwingConstants.RIGHT: right alignment.
    Since:
    
    JViews 5.5
    
    See Also:
    
    setAutoWrapping(boolean), getLabelAlignment()
  - getTitleRotation
```
public double getTitleRotation()
```
    Returns the title rotation.
    
    See Also:
    
    setTitle(String, double)
  - setTitleRotation
```
public void setTitleRotation(double angle)
```
    Sets the title rotation.
    
    Parameters:
    
    angle - The rotation angle (in degree).
    
    Since:
    
    JViews 5.5
  - getTitleFont
```
public Font getTitleFont()
```
    Returns the title font.
    
    Since:
    
    JViews 6.5
  - setTitleFont
```
public void setTitleFont(Font font)
```
    Sets the title font.
    
    Since:
    
    JViews 6.5
  - getTitle
```
public final String getTitle()
```
    Returns the title associated to this scale.
    
    Returns:
    
    The title string, or null if no title is displayed.
    
    See Also:
    
    setTitle(String, double)
  - setTitle
```
public void setTitle(String text)
```
    Sets the scale title text.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    getTitle()
  - setTitle
```
public void setTitle(String text,
                     double rotation)
```
    Sets the scale title to the specified string with the specified rotation.
  - getTitleRenderer
```
public IlvLabelRenderer getTitleRenderer()
```
    Returns the IlvLabelRenderer used to draw the title.
  - getTitlePlacement
```
public int getTitlePlacement()
```
    Returns the title placement.
    
    See Also:
    
    setTitlePlacement(int)
  - setTitlePlacement
```
public void setTitlePlacement(int pos)
```
    Sets the title placement. The value is expressed as a percentage of the axis length, 0 meaning the title is drawn at the minimum axis value, 100 meaning the title is drawn at the maximum axis value. The default value is 50, meaning the title is drawn in the middle of the scale.
  - isViewable
```
public final boolean isViewable()
```
    Indicates whether this scale can be displayed.
    A scale can be displayed when the following conditions are verified:
    - It has been connected to a chart axis with the IlvChart.setXScale(ilog.views.chart.IlvScale) or IlvChart.setYScale(int, ilog.views.chart.IlvScale) method.
    - It is visible (see isVisible()).
    - Its crossing value is within the visible range of its dual axis.
    Specified by:
    
    isViewable in interface IlvChartAreaAccessible
    
    Since:
    
    JViews 8.8
  - getLabelRotation
```
public double getLabelRotation()
```
    Returns the rotation applied to the step labels.
    
    See Also:
    
    setLabelRotation(double)
  - setLabelRotation
```
public void setLabelRotation(double angle)
```
    Specifies the rotation of the step labels.
    
    See Also:
    
    getLabelRotation()
  - isSkippingLabel
```
public final boolean isSkippingLabel()
```
    Indicates whether the scale skips step labels when they overlap.
    
    See Also:
    
    setSkippingLabel(boolean)
  - setSkippingLabel
```
public void setSkippingLabel(boolean skip)
```
    Tells the scale to skip step labels when they overlap.
    
    Parameters:
    
    skip - If set to true, the scale may discard labels so that they do not overlap. If false, no overlapping test is performed. The default value is true.
    
    See Also:
    
    isSkippingLabel(), setSkipLabelMode(int)
  - getSkipLabelMode
```
public final int getSkipLabelMode()
```
    Indicates how the scale determines the labels to skip. The default mode is CONSTANT_SKIP.
    
    See Also:
    
    setSkipLabelMode(int), CONSTANT_SKIP, ADAPTIVE_SKIP
  - setSkipLabelMode
```
public void setSkipLabelMode(int mode)
```
    Specifies how the scale determines the labels to skip.
    
    See Also:
    
    setSkippingLabel(boolean), getSkipLabelMode(), CONSTANT_SKIP, ADAPTIVE_SKIP
  - has3DSupport
```
public boolean has3DSupport()
```
    Indicates whether the scale supports three-dimensional drawing.
    
    Specified by:
    
    has3DSupport in interface IlvChart3DSupport
    
    Specified by:
    
    has3DSupport in interface IlvChartDrawable
    
    Since:
    
    JViews 5.5
  - isVisible
```
public final boolean isVisible()
```
    Indicates whether this scale is visible.
    
    Specified by:
    
    isVisible in interface IlvChartDrawable
    
    See Also:
    
    setVisible(boolean)
  - setVisible
```
public void setVisible(boolean visible)
```
    Toggles the visibility of this scale.
    
    See Also:
    
    isVisible()
  - isAxisVisible
```
public final boolean isAxisVisible()
```
    Indicates whether the axis is visible.
    
    See Also:
    
    setAxisVisible(boolean)
  - setAxisVisible
```
public void setAxisVisible(boolean visible)
```
    Toggles the visibility of the axis.
    
    See Also:
    
    isAxisVisible()
  - isMajorTickVisible
```
public final boolean isMajorTickVisible()
```
    Indicates whether major ticks are visible.
    
    See Also:
    
    setMajorTickVisible(boolean)
  - setMajorTickVisible
```
public void setMajorTickVisible(boolean visible)
```
    Toggles the visibility of major ticks.
    
    See Also:
    
    isMajorTickVisible()
  - isMinorTickVisible
```
public final boolean isMinorTickVisible()
```
    Indicates whether minor ticks are visible.
    
    See Also:
    
    setMinorTickVisible(boolean)
  - setMinorTickVisible
```
public void setMinorTickVisible(boolean visible)
```
    Toggles the visibility of minor ticks.
    
    See Also:
    
    isMinorTickVisible()
  - isLabelVisible
```
public final boolean isLabelVisible()
```
    Indicates whether step labels are visible.
    
    See Also:
    
    setLabelVisible(boolean)
  - setLabelVisible
```
public void setLabelVisible(boolean visible)
```
    Toggles the visibility of step labels.
    
    See Also:
    
    isLabelVisible()
  - isAutoCrossing
```
public final boolean isAutoCrossing()
```
    Indicates whether the scale uses a default crossing location.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setAutoCrossing(boolean)
  - setAutoCrossing
```
public void setAutoCrossing(boolean auto)
```
    Specifies whether the scale uses a default crossing location.
    Note: The bean property "autoCrossing" must not be specified together with the bean properties "crossing" or "crossingValue".
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    isAutoCrossing(), setCrossing(ilog.views.chart.IlvAxis.Crossing)
  - getCrossing
```
public final IlvAxis.Crossing getCrossing()
```
    Returns where this scale crosses its dual axis.
    
    Returns:
    
    The crossing specified by the setCrossing(ilog.views.chart.IlvAxis.Crossing) method, or the default crossing if isAutoCrossing() returns true.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setCrossing(ilog.views.chart.IlvAxis.Crossing)
  - setCrossing
```
public void setCrossing(IlvAxis.Crossing crossing)
```
    Specifies where this scale crosses its dual axis.
    Note: The bean property "crossing" must not be specified together with the bean properties "autoCrossing" or "crossingValue".
    
    Parameters:
    
    crossing - The new crossing. If set to null, the crossing is automatically computed.
    
    See Also:
    
    getDualAxis(), isAutoCrossing()
  - getCrossingValue
```
public final double getCrossingValue()
```
    Returns the value at which this scale crosses its dual axis. If the chart owning this scale is displayed in 3-D, the crossing value is automatically determined according to the view point.
    
    See Also:
    
    IlvChart.is3D(), setCrossingValue(double), setCrossing(IlvAxis.Crossing)
  - setCrossingValue
```
public void setCrossingValue(double value)
```
    Specifies where this scale crosses its dual axis. This method has no effect if the chart owning this scale is displayed in 3-D.
    Note: The bean property "crossingValue" must not be specified together with the bean properties "autoCrossing" or "crossing".
    
    See Also:
    
    getDualAxis(), setCrossing(ilog.views.chart.IlvAxis.Crossing)
  - isAutoSide
```
public final boolean isAutoSide()
```
    Indicates whether the side of the labels, title and "outside" ticks is chosen automatically.
    
    Since:
    
    JViews 8.0
  - setAutoSide
```
public void setAutoSide(boolean auto)
```
    Specifies whether the side of the labels, title and "outside" ticks should be chosen automatically.
    Note: The bean property "autoSide" must not be specified together with the bean property "side".
    
    Since:
    
    JViews 8.0
  - getDefaultSide
```
public int getDefaultSide()
```
    Returns the default side of the labels, title and "outside" ticks.
    
    Returns:
    
    One of LOWER_SIDE, UPPER_SIDE.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    getSide()
  - getSide
```
public int getSide()
```
    Returns the side of the labels, title, and "outside" ticks.
    
    Returns:
    
    One of LOWER_SIDE, UPPER_SIDE.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    getDefaultSide(), setSide(int)
  - setSide
```
public void setSide(int side)
```
    Sets the side where to place the labels, title, and "outside" ticks.
    Note: The bean property "side" must not be specified together with the bean property "autoSide".
    
    Parameters:
    
    side - one of LOWER_SIDE, UPPER_SIDE.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    getSide(), isAutoSide()
  - getRadialSide
```
public int getRadialSide()
```
    Returns the side of the labels, title, and "outside" ticks along the radial scale of a polar or radial chart.
    
    Returns:
    
    One of LEFT_SIDE, RIGHT_SIDE.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setRadialSide(int)
  - setRadialSide
```
public void setRadialSide(int side)
```
    Sets the side where to place the labels, title, and "outside" ticks along the radial scale of a polar or radial chart.
    
    Parameters:
    
    side - one of LEFT_SIDE, RIGHT_SIDE.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getRadialSide()
  - getCircleSide
```
public int getCircleSide()
```
    Returns the side of the labels, title, and "outside" ticks along the circular scale of a polar or radial chart.
    
    Returns:
    
    One of OUTSIDE, INSIDE.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    setCircleSide(int)
  - setCircleSide
```
public void setCircleSide(int side)
```
    Sets the side where to place the labels, title, and "outside" ticks along the circular scale of a polar or radial chart.
    
    Parameters:
    
    side - one of OUTSIDE, INSIDE.
    
    Since:
    
    JViews 8.7
    
    See Also:
    
    getCircleSide()
  - getStepsDefinition
```
public final IlvStepsDefinition getStepsDefinition()
```
    Returns the object used to compute the steps of this scale.
    
    See Also:
    
    setStepsDefinition(ilog.views.chart.IlvStepsDefinition)
  - setStepsDefinition
```
public void setStepsDefinition(IlvStepsDefinition stepsDefinition)
```
    Changes the steps definition. This method lets you change the step numbering strategy.
  - setStepUnit
```
public void setStepUnit(Double stepUnit,
                        Double subStepUnit)
```
    Specifies the step and substep units of this scale. This method changes the steps definition of this scale to an instance of IlvDefaultStepsDefinition.
    
    Parameters:
    
    stepUnit - The new step unit. If null, the unit is automatically computed.
    
    subStepUnit - The new substep unit. If null, the unit is automatically computed.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    IlvDefaultStepsDefinition.setStepUnit(double), IlvDefaultStepsDefinition.setSubStepUnit(double)
  - setTimeUnit
```
public void setTimeUnit(IlvTimeUnit timeUnit)
```
    Specifies a time unit for this scale. This method changes the steps definition of this scale to an instance of IlvTimeStepsDefinition.
    
    Parameters:
    
    timeUnit - The new time unit. If this parameter is null, the time unit is automatically computed.
    
    See Also:
    
    IlvTimeStepsDefinition.setAutoUnit(boolean), IlvTimeStepsDefinition.setUnit(ilog.views.chart.IlvTimeUnit)
  - isCategory
```
public final boolean isCategory()
```
    Indicates whether this scale displays categories.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setCategory(boolean)
  - setCategory
```
public final void setCategory(boolean isCategory)
```
    Specifies that this scale should display categories.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setCategory(ilog.views.chart.data.IlvDataSet, boolean)
  - setCategory
```
public void setCategory(IlvDataSet dataSet,
                        boolean tickBetweenCategory)
```
    Specifies that this scale should display categories. This method changes the steps definition of this scale to an instance of IlvCategoryStepsDefinition.
    
    Parameters:
    
    dataSet - An optional data set argument, which is passed to the IlvCategoryStepsDefinition class. This data set is thereby used to provide step labels.
    
    tickBetweenCategory - If set to true, the scale will display ticks between categories. Otherwise, ticks will be displayed at each category.
  - setLogarithmic
```
public void setLogarithmic(double logBase)
```
    Put the scale into logarithmic mode. Calling this method changes the steps definition of the scale to an instance of IlvLogarithmicStepsDefinition. It also sets an IlvLogarithmicAxisTransformer on the associated axis.
    Note: This method should only be called on a scale already added to a chart.
    
    Parameters:
    
    logBase - The logarithmic base.
    
    See Also:
    
    IlvLogarithmicAxisTransformer, IlvLogarithmicStepsDefinition
  - getAxis
```
public final IlvAxis getAxis()
```
    Returns the axis to which this scale is connected. This method returns null until the scale is added to a chart with the IlvChart.setXScale(ilog.views.chart.IlvScale) or IlvChart.setYScale(int, ilog.views.chart.IlvScale) method.
    
    See Also:
    
    getDualAxis()
  - getDualAxis
```
public final IlvAxis getDualAxis()
```
    Returns the dual axis of this scale. This method returns null until the scale is added to a chart with the IlvChart.setXScale(ilog.views.chart.IlvScale) or IlvChart.setYScale(int, ilog.views.chart.IlvScale) method. If this scale is connected to an x-axis, the dual axis is the main y-axis of the chart. Otherwise, the dual axis is the x-axis of the chart.
    
    See Also:
    
    getAxis(), getCoordinateSystem()
  - getCoordinateSystem
```
public final IlvCoordinateSystem getCoordinateSystem()
```
    Returns the coordinate system formed by this scale axis and its dual axis.
    
    See Also:
    
    getAxis(), getDualAxis()
  - getChart
```
public final IlvChart getChart()
```
    Returns the chart displaying this scale. This method returns null until the scale is added to a chart with the IlvChart.setXScale(ilog.views.chart.IlvScale) or IlvChart.setYScale(int, ilog.views.chart.IlvScale) method.
    
    Specified by:
    
    getChart in class IlvChartOwnedDrawable
  - chartConnected
```
protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)
```
    This method is called with a non-null argument when this drawable object is being attached to a chart. It is called with a null chart argument when this drawable object is being detached from its chart.
    You should not call this method directly.
    
    Specified by:
    
    chartConnected in class IlvChartOwnedDrawable
    
    Parameters:
    
    oldChart - The previous owning chart. May be null if this drawable object was not attached to a chart before.
    
    newChart - The new associated chart. May be null if if this drawable object is being detached from its chart.
    
    See Also:
    
    IlvChartOwnedDrawable.getChart()
  - getStepValues
```
public final IlvDoubleArray getStepValues()
```
    Returns the step values.
  - getSubStepValues
```
public final IlvDoubleArray getSubStepValues()
```
    Returns the substep values.
  - recalc
```
public final void recalc()
```
    Recalculates the steps values and labels. This method should be called when a "hard reset" is needed immediately (as opposed to the automatic update).
    
    Since:
    
    JViews 5.5
  - draw
```
public void draw(Graphics dst)
```
    Draws the scale into the specified Graphics context.
    
    Specified by:
    
    draw in interface IlvChartDrawable
  - toValue
```
public double toValue(int x,
                      int y)
```
    Returns the value corresponding to the specified point on the scale.
  - toPoint
```
public Point toPoint(double value)
```
    Returns the location on the axis of the specified value.
  - computeBounds
```
protected Rectangle2D computeBounds(Rectangle2D bounds)
```
    Computes the entire bounds.
    
    Parameters:
    
    bounds - A rectangle optionally used to store the result. If this parameter is null, a new Rectangle2D is allocated.
    
    Returns:
    
    The bounds of this scale.
    
    Since:
    
    JViews 7.5
  - getBounds
```
public Rectangle2D getBounds(Rectangle2D bounds)
```
    Returns the bounds of this scale.
    
    Specified by:
    
    getBounds in interface IlvChartDrawable
    
    Parameters:
    
    bounds - A rectangle optionally used to store the result. If this parameter is null, a new Rectangle2D is allocated.
    
    Returns:
    
    The bounds of this scale.
    
    See Also:
    
    getBoundsUsingCache(java.awt.geom.Rectangle2D)
  - getBoundsUsingCache
```
public Rectangle2D getBoundsUsingCache(Rectangle2D bounds)
```
    Returns the bounds of this scale, without unnecessary recomputations. Note: This function should only be called when the geometry cache of the scales are up-to-date.
    
    Parameters:
    
    bounds - A rectangle optionally used to store the result. If this parameter is null, a new Rectangle2D is allocated.
    
    Returns:
    
    The bounds of this scale.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    getBounds(Rectangle2D)
  - drawSelectionHandles
```
public void drawSelectionHandles(Graphics g,
                                 IlvHandlesSelectionStyle style)
```
    Draws this scale with selection handles.
    
    Specified by:
    
    drawSelectionHandles in interface IlvChartAreaAccessible
    
    Since:
    
    JViews 8.8
  - drawHighlight
```
public void drawHighlight(Graphics g)
```
    Draws this scale as highlighted.
    
    Since:
    
    JViews 6.0
  - hit
```
public boolean hit(Point2D pt)
```
    Returns the result of a hit testing on the specified point.
    
    Since:
    
    JViews 6.0
  - drawIntoHitmap
```
public void drawIntoHitmap(IlvChartHitmapDefinition definition,
                           IlvChartHitmapAccumulator accumulator)
```
    Draws the rendering into a hitmap.
    
    Parameters:
    
    definition - The specification how to construct the hitmap.
    
    accumulator - The object that accumulates objects in the hitmap.
    
    Since:
    
    JViews 8.8
  - getAnnotations
```
public IlvScaleAnnotation[] getAnnotations()
```
    Returns the annotations attached to this scale.
  - setAnnotations
```
public void setAnnotations(IlvScaleAnnotation[] annotations)
```
    Sets the annotations attached to this scale.
    
    Since:
    
    JViews 6.0
  - addAnnotation
```
public void addAnnotation(IlvScaleAnnotation annotation)
```
    Adds an annotation to this scale.
  - removeAnnotation
```
public void removeAnnotation(IlvScaleAnnotation annotation)
```
    Removes the specified annotation from this scale.
  - updateAnnotations
```
public void updateAnnotations()
```
    Called by the scale while it computes its bounds. The default implementation does nothing. This method should be overridden by subclasses that need to update the annotations attached to this scale, depending on the axis range, the step or substep values or similar.
    
    Since:
    
    JViews 7.5
  - getLabelBounds
```
public Rectangle2D getLabelBounds(int stepIdx,
                                  Rectangle2D bounds)
```
    Returns the bounds of the step label at the specified index.
    
    Parameters:
    
    stepIdx - The index of the considered step label.
    
    bounds - A rectangle optionally used to store the result. If this parameter is null, a new Rectangle2D is allocated.
    
    Returns:
    
    The bounds of the step label.
    
    Throws:
    
    IndexOutOfBoundsException - If the index of the step label is not valid.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    getLabelCount()
  - getLabelCount
```
public int getLabelCount()
```
    Returns the number of step labels.
    
    Returns:
    
    The number of step labels.
    
    Since:
    
    JViews 5.5
  - getLabelValue
```
public double getLabelValue(int stepIdx)
```
    Returns the value associated with the specified step label.
    
    Throws:
    
    IndexOutOfBoundsException - If the index of the step label is not valid.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    getLabelCount()
  - getLabelFormat
```
public final IlvValueFormat getLabelFormat()
```
    Returns the format of step labels.
    
    See Also:
    
    setLabelFormat(ilog.views.chart.IlvValueFormat)
  - setLabelFormat
```
public void setLabelFormat(IlvValueFormat fmt)
```
    Specifies a format for the step labels. The specified format will be used to generate the step labels instead of calling the computeLabel method of the steps definition. Providing a custom format is thus an alternative to overriding the IlvStepsDefinition.computeLabel(double) method.
    
    See Also:
    
    computeLabel(double)
  - computeLabel
```
public String computeLabel(double value)
```
    Returns the label associated with the specified value. If a value format is specified, use that format, otherwise calls the IlvStepsDefinition.computeLabel(double) method.
    
    See Also:
    
    setLabelFormat(ilog.views.chart.IlvValueFormat)
  - getTitleBackgroundShape
```
public Shape getTitleBackgroundShape()
```
    Returns the background shape of the title. This shape depends in particular on the title string (see getTitle(), its font (see getTitleFont(), and its positioning (see getTitleOffset(), getTitlePlacement(), getTitleRotation()).
    
    Returns:
    
    The combined background shapes of the text lines, or null if the title is absent or empty.
    
    Since:
    
    JViews 8.7
  - computeLabelLocation
```
protected IlvDoublePoint computeLabelLocation(IlvDoublePoint loc,
                                              double tickAngle,
                                              int offset,
                                              double width,
                                              double height)
```
    Computes the location of a step label.
    
    Parameters:
    
    loc - The reference location on the scale axis. This parameter is modified and returned by the method.
    
    tickAngle - The tick angle.
    
    offset - The desired distance between the axis and the label boundaries.
    
    width - The width of the label.
    
    height - The height of the label.
    
    Returns:
    
    The center of the label.
    
    Since:
    
    JViews 5.5
  - getAxisIndex
```
public static int getAxisIndex(IlvScale scale)
```
    Returns the axis index of the specified scale.
    
    Throws:
    
    IllegalArgumentException - The scale is not connected to a chart.
    
    Since:
    
    JViews 6.0

Class IlvScale

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TICK_INSIDE

TICK_OUTSIDE

TICK_CROSS

CONSTANT_SKIP

ADAPTIVE_SKIP

LOWER_SIDE

UPPER_SIDE

LEFT_SIDE

RIGHT_SIDE

OUTSIDE

INSIDE

Constructor Detail

IlvScale

IlvScale

IlvScale

Method Detail

getComponentOrientation

componentOrientationChanged

getAxisStroke

setAxisStroke

getResolvedBaseTextDirection

baseTextDirectionChanged

getLabelFont

setLabelFont

getLabelColor

setLabelColor

getForeground

setForeground

getDrawOrder

setDrawOrder

getMajorTickSize

setMajorTickSize

getMinorTickSize

setMinorTickSize

getTickLayout

setTickLayout

getLabelOffset

setLabelOffset

getTitleOffset

setTitleOffset

isAutoWrapping

setAutoWrapping

getLabelAlignment

setLabelAlignment

getTitleRotation

setTitleRotation

getTitleFont

setTitleFont

getTitle

setTitle

setTitle

getTitleRenderer

getTitlePlacement

setTitlePlacement

isViewable

getLabelRotation

setLabelRotation

isSkippingLabel

setSkippingLabel

getSkipLabelMode

setSkipLabelMode

has3DSupport

isVisible

setVisible

isAxisVisible

setAxisVisible

isMajorTickVisible

setMajorTickVisible

isMinorTickVisible

setMinorTickVisible

isLabelVisible

setLabelVisible

isAutoCrossing

setAutoCrossing