Package com.luciad.view.gxy

Interface ILcdGXYLabelPriorityProvider

public interface ILcdGXYLabelPriorityProvider
A provider of label priorities. This interface assumes that all labels for an object have the same priority.

Priorities must have a value between 0 (highest priority) and Integer.MAX_VALUE (lowest priority).

Label priorities are typically used when placing labels. Labels with a high priority will then be processed first, and have a higher chance of being placed. Labels with a low priority will be processed last, and have less chance to find a placement where they don't overlap with already placed labels.

To define priorities per label, ILcdGXYMultiLabelPriorityProvider can be used.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPriority(Object aObject, ILcdGXYContext aGXYContext)
    Returns the label priority for the given object, 0 being the highest priority, Integer.MAX_VALUE the lowest priority.

  • Method Details

    • getPriority

      int getPriority(Object aObject, ILcdGXYContext aGXYContext)
      Returns the label priority for the given object, 0 being the highest priority, Integer.MAX_VALUE the lowest priority. Negative values are not allowed.
      Parameters:
      aObject - the object whose label priority is to be returned.
      aGXYContext - the ILcdGXYContext the label priority will be used for.
      Returns:
      the label priority for the given object.