ilog.views.graphlayout.labellayout.annealing

Class IlvAnnealingPointLabelDescriptor

java.lang.Object

ilog.views.graphlayout.labellayout.annealing.IlvAnnealingLabelDescriptor

ilog.views.graphlayout.labellayout.annealing.IlvAnnealingPointLabelDescriptor

public class IlvAnnealingPointLabelDescriptor
extends IlvAnnealingLabelDescriptor

The class IlvAnnealingPointLabelDescriptor can be used to specify that the label should be placed close to specific point (the point labeling problem). A typical application is to place labels of cities on a map. These labels should be close to the related cities, but they should not overlap each other and should not overlap any city.

Sample drawings produced by the Annealing Label Layout algorithm with point label descriptors:

Click on the image to see it in normal size.

CSS example:

ilvAnnealingPointLabelDescriptor {
class : "ilog.views.graphlayout.labellayout.annealing.IlvAnnealingPointLabelDescriptor";
halfHeight : "3.0";
halfWidth : "3.0";
maxDistFromPath : "3.0";
preferredDirection : "2";
preferredDistFromPath : "3.0";
shape : "ELLIPTIC";
treatAs : "2";
}

Property Summary

Properties

Modifier and Type	Property and Description
java.lang.String	class Default constructor.
double	halfHeight Sets the half height of the path around the reference point.
double	halfWidth Sets the half width of the path around the reference point.
double	maxDistFromPath Sets the maximum distance from the location on the path.
int	preferredDirection Sets the preferred direction where the label is placed relative to the reference point or related obstacle.
double	preferredDistFromPath Sets the preferred distance from the location on the path.
int	shape Sets the shape of the allowed area around the reference point or related obstacle.
int	treatAs Sets how the label should be treated by the IlvLabelLayoutRenderer of the IlvSDMEngine.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

class

public java.lang.String class

Default constructor.

CSS example: class : "ilog.views.graphlayout.labellayout.annealing.IlvAnnealingPointLabelDescriptor";

halfHeight

public double halfHeight

Sets the half height of the path around the reference point. The value is only taken into account if the reference point is not null.

CSS example: halfHeight : "3.0";

halfWidth

public double halfWidth

Sets the half width of the path around the reference point. The value is only taken into account if the reference point is not null.

CSS example: halfWidth : "3.0";

maxDistFromPath

public double maxDistFromPath

Sets the maximum distance from the location on the path.

CSS example: maxDistFromPath : "3.0";

preferredDirection

public int preferredDirection

Sets the preferred direction where the label is placed relative to the reference point or related obstacle. Possible directions are:

• IlvDirection.Left
• IlvDirection.Right
• IlvDirection.Top
• IlvDirection.Bottom (the default value)

CSS example: preferredDirection : "2";

preferredDistFromPath

public double preferredDistFromPath

Sets the preferred distance from the location on the path. It must be smaller than the maximum distance from path.

CSS example: preferredDistFromPath : "3.0";

shape

public int shape

Sets the shape of the allowed area around the reference point or related obstacle. Possible shapes are:

• #ELLIPTIC
• #RECTANGULAR

CSS example: shape : "ELLIPTIC";

Allowed values:

ELLIPTIC

RECTANGULAR

treatAs

public int treatAs

Sets how the label should be treated by the IlvLabelLayoutRenderer of the IlvSDMEngine. This method is internally used. You should not call this method.

CSS example: treatAs : "2";