LabelingCandidate¶
Namespace: ThinkGeo.Core
This class represents a candidate for labeling.
public class LabelingCandidate : System.IComparable`1[[ThinkGeo.Core.LabelingCandidate, ThinkGeo.Core, Version=14.0.0.0, Culture=neutral, PublicKeyToken=null]]
Inheritance Object → LabelingCandidate
Implements IComparable<LabelingCandidate>
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.
Properties¶
Feature¶
Gets or sets the Feature.
public Feature Feature { get; set; }
Property Value¶
Key¶
Gets or sets the Key.
public string Key { get; set; }
Property Value¶
PositionStyle¶
Gets or sets the PositionStyle.
public PositionStyle PositionStyle { get; set; }
Property Value¶
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
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
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
Methods¶
CompareTo(LabelingCandidate)¶
Performs compare to.
public int CompareTo(LabelingCandidate other)
Parameters¶
other LabelingCandidate
The other.
Returns¶
Int32
The result of the operation.
Sort(List<LabelingCandidate>, Single, Single)¶
Performs sort.
public static void Sort(List<LabelingCandidate> featureLabelingCandidates, float canvasWidth, float canvasHeight)
Parameters¶
featureLabelingCandidates List<LabelingCandidate>
The feature labeling candidates.
canvasWidth Single
The canvas width.
canvasHeight Single
The canvas height.