ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.portablecore.labelingcandidate
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.PortableCore.LabelingCandidate
<!– Class –> This class represents a candidate for labeling.
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.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.PortableCore.LabelingCandidate *ThinkGeo.MapSuite.PortableCore.WorldLabelingCandidate
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 LabelingCandidate | This is a constructor for the class. | ||
| LabelingCandidate | String, PolygonShape, PointShape | This is a constructor for the class. | |
| LabelingCandidate | String, PolygonShape, PointShape, Collection<LabelInformation> | This is a constructor for the class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 CenterPoint | PointShape | This property gets and sets the center point for the center of the label. | |
| LabelInformation | Collection<LabelInformation> | This property gets and sets the label information for this label. | |
| OriginalText | String | This property gets and sets the original text for the label. | |
| ScreenArea | PolygonShape | This property gets and sets the screen area that encompasses the label. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
LabelingCandidate()
This is a constructor for the class.
Overloads
This is the default constructor.
Remarks
If you use this constructor, then you should set the applicable properties manually.
Parameters
| Name | Type | Description |
|---|
LabelingCandidate(String, PolygonShape, PointShape)
This is a constructor for the class.
Overloads
This constructor allows you to pass in the area of the label as well as the center point.
Parameters
| Name | Type | Description |
|---|---|---|
| originalText | String<!– System.String –> | This parameter represents the text of the label before it is potentially modified. |
| simplePolygonInScreenCoordinates | PolygonShape<!– ThinkGeo.MapSuite.PortableCore.PolygonShape –> | This parameter is a polygon (in screen coordinates) representing the area to be labeled. |
| centerPointInScreenCoordinates | PointShape<!– ThinkGeo.MapSuite.PortableCore.PointShape –> | This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled. |
LabelingCandidate(String, PolygonShape, PointShape, Collection<LabelInformation>)
This is a constructor for the class.
Overloads
This constructor allows you to pass in the area of the label and the center point.
Parameters
| Name | Type | Description |
|---|---|---|
| originalText | String<!– System.String –> | This parameter represents the text of the label before it is potentially modified. |
| simplePolygonInScreenCoordinates | PolygonShape<!– ThinkGeo.MapSuite.PortableCore.PolygonShape –> | This parameter is a polygon (in screen coordinates) representing the area to be labeled. |
| centerPointInScreenCoordinates | PointShape<!– ThinkGeo.MapSuite.PortableCore.PointShape –> | This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled. |
| labelInformation | Collection<LabelInformation><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.LabelInformation} –> | This parameter is the labeling information for this labeling candidate. |
Protected Constructors
Public Methods
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
CenterPoint
This property gets and sets the center point for the center of the label.
Return Value
| Return Type |
|---|
| PointShape<!– ThinkGeo.MapSuite.PortableCore.PointShape –> |
<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> Go Back
LabelInformation
This property gets and sets the label information for this label.
Return Value
| Return Type |
|---|
| Collection<LabelInformation><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.LabelInformation} –> |
<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> Go Back
OriginalText
This property gets and sets the original text for the label.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> Go Back
ScreenArea
This property gets and sets the screen area that encompasses the label.
Return Value
| Return Type |
|---|
| PolygonShape<!– ThinkGeo.MapSuite.PortableCore.PolygonShape –> |
<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> Go Back
Protected Properties
Public Events
thinkgeo.mapsuite.portablecore.labelingcandidate.1440040132.txt.gz · Last modified: 2015/09/21 08:12 (external edit)