thinkgeo.mapsuite.core.labelingcandidate
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.labelingcandidate [2015/09/17 10:33] admin |
thinkgeo.mapsuite.core.labelingcandidate [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.LabelingCandidate ====== | ====== ThinkGeo.MapSuite.Core.LabelingCandidate ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents a candidate for labeling. | This class represents a candidate for labeling. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 6: | Line 9: | ||
| *[[ThinkGeo.MapSuite.Core.WorldLabelingCandidate]] | *[[ThinkGeo.MapSuite.Core.WorldLabelingCandidate]] | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} LabelingCandidate() ** |
| - | **{{wiki:PublicMethod.gif|}}[[#LabelingCandidate()|LabelingCandidate]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is a constructor for the class. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is a constructor for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#LabelingCandidate(String,PolygonShape,PointShape)|LabelingCandidate]]** | + | == Remarks == |
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * //If you use this constructor, then you should set the applicable properties manually.// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is a constructor for the class. | + | <div newline></div> |
| - | </div> | + | ** {{wiki:PublicMethod.gif|}} LabelingCandidate(String,PolygonShape,PointShape) ** |
| - | <div class_table> | + | * //This is a constructor for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#LabelingCandidate(String,PolygonShape,PointShape,Collection<LabelInformation>)|LabelingCandidate]]** | + | == Remarks == |
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]],[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]> | + | * //None// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is a constructor for the class. | + | * //originalText// |
| - | </div> | + | * Type:String |
| + | * Description:This parameter represents the text of the label before it is potentially modified. | ||
| - | === Protected Constructors === | + | * //simplePolygonInScreenCoordinates// |
| - | === Public Methods === | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
| - | <div class_table> | + | * Description:This parameter is a polygon (in screen coordinates) representing the area to be labeled. |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | |
| - | * **Parameters**:Object | + | |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //centerPointInScreenCoordinates// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Parameters**:N/A | + | * Description:This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | ** {{wiki:PublicMethod.gif|}} LabelingCandidate(String,PolygonShape,PointShape,Collection<LabelInformation>) ** |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is a constructor for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //None// |
| - | * **DeclaringType**:Object | + | == Parameters == |
| - | * **Summary**:N/A | + | * //originalText// |
| - | </div> | + | * Type:String |
| + | * Description:This parameter represents the text of the label before it is potentially modified. | ||
| - | === Protected Methods === | + | * //simplePolygonInScreenCoordinates// |
| - | <div class_table> | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * Description:This parameter is a polygon (in screen coordinates) representing the area to be labeled. |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //centerPointInScreenCoordinates// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | * **Parameters**:N/A | + | * Description:This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Public Properties === | + | * //labelInformation// |
| - | **{{wiki:PublicProperty.gif|}}[[#CenterPoint|CenterPoint]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]> |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Description:This parameter is the labeling information for this labeling candidate. |
| - | * **Summary**:This property gets and sets the center point for the center of the label. | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#LabelInformation|LabelInformation]]** | + | <div newline></div> |
| - | * **Return**:Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]> | + | ==== Protected Constructors ==== |
| - | * **Summary**:This property gets and sets the label information for this label. | + | ==== Public Methods ==== |
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | **{{wiki:PublicProperty.gif|}}[[#OriginalText|OriginalText]]** | + | * //N/A// |
| - | * **Return**:String | + | == Remarks == |
| - | * **Summary**:This property gets and sets the original text for the label. | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#ScreenArea|ScreenArea]]** | + | == Return Value == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | + | * Type:String |
| - | * **Summary**:This property gets and sets the screen area that encompasses the label. | + | * Description:N/A |
| - | === Protected Properties === | + | == Parameters == |
| - | === Public Events === | + | <div newline></div> |
| - | ===== Public Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | === LabelingCandidate() === | + | |
| - | This is a constructor for the class. | + | |
| - | ==== Remarks ==== | + | |
| - | If you use this constructor, then you should set the applicable properties manually. | + | |
| - | ==== Parameters ==== | + | |
| - | [[#Public Constructors|Go Back]] | + | |
| - | === LabelingCandidate(String,PolygonShape,PointShape) === | + | |
| - | This is a constructor for the class. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | ==== Parameters ==== | + | |
| - | **originalText** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter represents the text of the label before it is potentially modified. | + | |
| - | **simplePolygonInScreenCoordinates** | + | * //N/A// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | + | == Remarks == |
| - | * **Description:This parameter is a polygon (in screen coordinates) representing the area to be labeled. | + | * //N/A// |
| - | **centerPointInScreenCoordinates** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:Boolean |
| - | * **Description:This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled. | + | * Description:N/A |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | === LabelingCandidate(String,PolygonShape,PointShape,Collection<LabelInformation>) === | + | * //obj// |
| - | This is a constructor for the class. | + | * Type:Object |
| - | ==== Remarks ==== | + | * Description:N/A |
| - | None | + | |
| - | ==== Parameters ==== | + | |
| - | **originalText** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter represents the text of the label before it is potentially modified. | + | |
| - | **simplePolygonInScreenCoordinates** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | * **Description:This parameter is a polygon (in screen coordinates) representing the area to be labeled. | + | |
| - | **centerPointInScreenCoordinates** | + | * //N/A// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | == Remarks == |
| - | * **Description:This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled. | + | * //N/A// |
| - | **labelInformation** | + | == Return Value == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]> | + | * Type:Int32 |
| - | * **Description:This parameter is the labeling information for this labeling candidate. | + | * Description:N/A |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ===== Protected Constructors ===== | + | <div newline></div> |
| - | ===== Public Methods ===== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | === Equals(Object) === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Boolean | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **obj** | + | * Type:Type |
| - | * **Type**:Object | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === GetHashCode() === | + | <div newline></div> |
| - | N/A | + | ==== Protected Methods ==== |
| - | ==== Remarks ==== | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Int32 | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | === GetType() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Type | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | ==== Parameters ==== | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === ToString() === | + | * //N/A// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:String | + | * Type:Object |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ===== Protected Methods ===== | + | ==== Public Properties ==== |
| - | === Finalize() === | + | ** {{wiki:PublicProperty.gif|}} OriginalText ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | This property gets and sets the original text for the label. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | None |
| + | == Return Value == | ||
| + | * Type:String | ||
| - | ==== Parameters ==== | + | ** {{wiki:PublicProperty.gif|}} ScreenArea ** |
| - | [[#Protected Methods|Go Back]] | + | |
| - | === MemberwiseClone() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | This property gets and sets the screen area that encompasses the label. |
| - | * **Return Type**:Object | + | == Remarks == |
| - | * **Description**:N/A | + | |
| - | + | ||
| - | ==== Parameters ==== | + | |
| - | [[#Protected Methods|Go Back]] | + | |
| - | ===== Public Properties ===== | + | |
| - | === CenterPoint === | + | |
| - | This property gets and sets the center point for the center of the label. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} CenterPoint ** |
| - | === LabelInformation === | + | |
| - | This property gets and sets the label information for this label. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]> | + | |
| - | [[#Public Properties|Go Back]] | + | This property gets and sets the center point for the center of the label. |
| - | === OriginalText === | + | == Remarks == |
| - | This property gets and sets the original text for the label. | + | |
| - | ==== Remarks ==== | + | |
| None | None | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:String | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} LabelInformation ** |
| - | === ScreenArea === | + | |
| - | This property gets and sets the screen area that encompasses the label. | + | This property gets and sets the label information for this label. |
| - | ==== Remarks ==== | + | == Remarks == |
| None | None | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]> |
| - | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
| - | ===== Protected Properties ===== | + | ==== Public Events ==== |
| - | ===== Public Events ===== | + | |
thinkgeo.mapsuite.core.labelingcandidate.1442486007.txt.gz · Last modified: 2015/09/17 10:33 by admin