Class LabelingCandidate

Namespace

ThinkGeo.Core

Assembly

ThinkGeo.Core.dll

This class represents a candidate for labeling.

public class LabelingCandidate

Inheritance

object

LabelingCandidate

Derived

WorldLabelingCandidate

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This class is used in the internals of the labeling system. We keep track of every potential label in this class as it goes through the labeling rules.

Constructors

LabelingCandidate()

This is a constructor for the class.

public LabelingCandidate()

Remarks

If you use this constructor, then you should set the applicable properties manually.

LabelingCandidate(string, PolygonShape, ScreenPointF)

This is a constructor for the class.

public LabelingCandidate(string originalText, PolygonShape simplePolygonInScreenCoordinates, ScreenPointF centerPointInScreenCoordinate)

Parameters

originalText string

This parameter represents the text of the label before it is potentially modified.

simplePolygonInScreenCoordinates PolygonShape

This parameter is a polygon (in screen coordinates) representing the area to be labeled.

centerPointInScreenCoordinate ScreenPointF

This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled.

Remarks

None

LabelingCandidate(string, PolygonShape, ScreenPointF, Collection<LabelInformation>)

This is a constructor for the class.

public LabelingCandidate(string originalText, PolygonShape simplePolygonInScreenCoordinates, ScreenPointF centerPointInScreenCoordinate, Collection<LabelInformation> labelInformation)

Parameters

originalText string

This parameter represents the text of the label before it is potentially modified.

simplePolygonInScreenCoordinates PolygonShape

This parameter is a polygon (in screen coordinates) representing the area to be labeled.

centerPointInScreenCoordinate ScreenPointF

This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled.

labelInformation Collection<LabelInformation>

This parameter is the labeling information for this labeling candidate.

Remarks

None

Properties

CenterPointInScreenCoordinate

This property gets and sets the center point for the center of the label.

public ScreenPointF CenterPointInScreenCoordinate { get; set; }

Property Value

ScreenPointF

This property gets the center point for the center of the label.

Remarks

None

LabelInformation

This property gets and sets the label information for this label.

public Collection<LabelInformation> LabelInformation { get; }

Property Value

Collection<LabelInformation>

This property gets the label information for this label.

Remarks

None

OriginalText

This property gets and sets the original text for the label.

public string OriginalText { get; set; }

Property Value

string

This property gets the original text for the label.

Remarks

None

ScreenArea

This property gets and sets the screen area that encompasses the label.

public PolygonShape ScreenArea { get; set; }

Property Value

PolygonShape

This property gets the screen area that encompasses the label.

Remarks

None