thinkgeo.mapsuite.portablecore.positionstyle
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.positionstyle [2015/09/21 08:16] admin |
thinkgeo.mapsuite.portablecore.positionstyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.PositionStyle ====== | ====== ThinkGeo.MapSuite.Core.PositionStyle ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This abstract class encapsulates the labeling position logic. It is inherited by other styles, such as the TextSytle. | This abstract class encapsulates the labeling position logic. It is inherited by other styles, such as the TextSytle. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 5: | Line 8: | ||
| *ThinkGeo.MapSuite.Core.Style | *ThinkGeo.MapSuite.Core.Style | ||
| ***ThinkGeo.MapSuite.Core.PositionStyle** | ***ThinkGeo.MapSuite.Core.PositionStyle** | ||
| - | *[[ThinkGeo.MapSuite.Core.IconValueStyle]] | ||
| *[[ThinkGeo.MapSuite.Core.TextStyle]] | *[[ThinkGeo.MapSuite.Core.TextStyle]] | ||
| + | *[[ThinkGeo.MapSuite.Core.IconValueStyle]] | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| Line 12: | Line 15: | ||
| ** {{wiki:ProtectedMethod.gif|}} PositionStyle() ** | ** {{wiki:ProtectedMethod.gif|}} PositionStyle() ** | ||
| - | This is the default constructor for the class. | + | * //This is the default constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| Line 20: | Line 23: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 32: | Line 35: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 60: | Line 63: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 88: | Line 91: | ||
| ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 100: | Line 103: | ||
| ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 120: | Line 123: | ||
| ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 134: | Line 137: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:String |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //filePathName// | + | <div newline></div> |
| - | * Type:String | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //obj// | ||
| + | * Type:Object | ||
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:Int32 |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //stream// | + | <div newline></div> |
| - | * Type:Stream | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | * Description:N/A | + | |
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | + | ==== Protected Methods ==== |
| + | ** {{wiki:ProtectedMethod.gif|}} Format(String,BaseShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 177: | Line 201: | ||
| == Parameters == | == Parameters == | ||
| + | * //text// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //labeledShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | + | ** {{wiki:ProtectedMethod.gif|}} FormatCore(String,BaseShape) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:String |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //obj// | + | * //text// |
| - | * Type:Object | + | * Type:String |
| + | * Description:N/A | ||
| + | |||
| + | * //labeledShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | + | ** {{wiki:ProtectedMethod.gif|}} OnFormatting(FormattingPositionStyleEventArgs) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Int32 | + | * Type:Void |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| + | * //e// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | + | ** {{wiki:ProtectedMethod.gif|}} OnFormatted(FormattedPositionStyleEventArgs) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Type | + | * Type:Void |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| + | * //e// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method draws the features on the canvas you provided. | + | * //This method draws the features on the canvas you provided.// |
| == Remarks == | == Remarks == | ||
| - | This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently. When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection. | + | * //This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently. When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.// |
| == Return Value == | == Return Value == | ||
| Line 249: | Line 292: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ||
| - | This method returns the column data for each feature that is required for the style to properly draw. | + | * //This method returns the column data for each feature that is required for the style to properly draw.// |
| == Remarks == | == Remarks == | ||
| - | This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection. | + | * //This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.// |
| == Return Value == | == Return Value == | ||
| Line 261: | Line 304: | ||
| ** {{wiki:ProtectedMethod.gif|}} FilterFeatures(IEnumerable<Feature>,GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} FilterFeatures(IEnumerable<Feature>,GeoCanvas) ** | ||
| - | This method filters the features based on the grid size to facilitate deterministic labeling. | + | * //This method filters the features based on the grid size to facilitate deterministic labeling.// |
| == Remarks == | == Remarks == | ||
| - | This method is the concrete wrapper for the abstract method FilterFeaturesCore. In this method, we filter the features based on the grid size to facilitate deterministic labeling. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //This method is the concrete wrapper for the abstract method FilterFeaturesCore. In this method, we filter the features based on the grid size to facilitate deterministic labeling. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
| == Return Value == | == Return Value == | ||
| Line 281: | Line 324: | ||
| ** {{wiki:ProtectedMethod.gif|}} FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas) ** | ||
| - | This method filters the features based on the grid size to facilitate deterministic labeling. | + | * //This method filters the features based on the grid size to facilitate deterministic labeling.// |
| == Remarks == | == Remarks == | ||
| - | This overridden method is called from the concrete public method FilterFeatures. In this method, we filter the features based on the grid size to facilitate deterministic labeling. | + | * //This overridden method is called from the concrete public method FilterFeatures. In this method, we filter the features based on the grid size to facilitate deterministic labeling.// |
| == Return Value == | == Return Value == | ||
| Line 297: | Line 340: | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| * Description:This parameter is the canvas that will be used for calculating font sizes. | * Description:This parameter is the canvas that will be used for calculating font sizes. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} AbbreviateText(Feature,GeoCanvas) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //feature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} AbbreviateTextCore(Feature,GeoCanvas) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //feature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} GetLabelingCandidates(Feature,GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} GetLabelingCandidates(Feature,GeoCanvas) ** | ||
| - | This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set. | + | * //This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set.// |
| == Remarks == | == Remarks == | ||
| - | This method is the concrete wrapper for the abstract method GetLabelingCanidatesCore. This method determines if the feature passed in is a good candidate to be labeled based on the labeling properties set. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //This method is the concrete wrapper for the abstract method GetLabelingCanidatesCore. This method determines if the feature passed in is a good candidate to be labeled based on the labeling properties set. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
| == Return Value == | == Return Value == | ||
| Line 361: | Line 364: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetLabelingCandidateCore(Feature,GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} GetLabelingCandidateCore(Feature,GeoCanvas) ** | ||
| - | This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set. | + | * //This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set.// |
| == Remarks == | == Remarks == | ||
| - | This overridden method is called from the concrete public method GetLabelingCanidate. In this method, we take the feature you passed in and determine if it is a candidate for labeling. If it is, then we will add it to the return collection. The algorithm to determine whether the label will draw is complex and determined by a number of properties and factors. | + | * //This overridden method is called from the concrete public method GetLabelingCanidate. In this method, we take the feature you passed in and determine if it is a candidate for labeling. If it is, then we will add it to the return collection. The algorithm to determine whether the label will draw is complex and determined by a number of properties and factors.// |
| == Return Value == | == Return Value == | ||
| Line 381: | Line 384: | ||
| ** {{wiki:ProtectedMethod.gif|}} CheckDuplicate(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} CheckDuplicate(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method will determine whether the label will be suppressed because it is a duplicate. | + | * //This method will determine whether the label will be suppressed because it is a duplicate.// |
| == Remarks == | == Remarks == | ||
| - | This method is the concrete wrapper for the abstract method CheckDuplicateCore. This method will determine if the label will be suppressed because it is a duplicate. It also takes into consideration the duplicate rules for the class. So, for example, if we set to allow duplicates, then the method will always return false. If the class is set to not allow duplicates and this label is a duplicate, then it will return true and be suppressed. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //This method is the concrete wrapper for the abstract method CheckDuplicateCore. This method will determine if the label will be suppressed because it is a duplicate. It also takes into consideration the duplicate rules for the class. So, for example, if we set to allow duplicates, then the method will always return false. If the class is set to not allow duplicates and this label is a duplicate, then it will return true and be suppressed. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
| == Return Value == | == Return Value == | ||
| Line 409: | Line 412: | ||
| ** {{wiki:ProtectedMethod.gif|}} CheckDuplicateCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} CheckDuplicateCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method will determine if the label will be suppressed because it is a duplicate. | + | * //This method will determine if the label will be suppressed because it is a duplicate.// |
| == Remarks == | == Remarks == | ||
| - | This overridden method is called from the concrete public method CheckDuplicate. This method will determine if the label will be suppressed because it is a duplicate. It also takes into consideration the duplicate rules for the class. So, for example, if we set to allow duplicates, then the method will always return false. If the class is set to not allow duplicates and this label is a duplicate, then it will return true and be suppressed. | + | * //This overridden method is called from the concrete public method CheckDuplicate. This method will determine if the label will be suppressed because it is a duplicate. It also takes into consideration the duplicate rules for the class. So, for example, if we set to allow duplicates, then the method will always return false. If the class is set to not allow duplicates and this label is a duplicate, then it will return true and be suppressed.// |
| == Return Value == | == Return Value == | ||
| Line 437: | Line 440: | ||
| ** {{wiki:ProtectedMethod.gif|}} CheckOverlapping(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} CheckOverlapping(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method will determine if the label will be suppressed because of overlapping. | + | * //This method will determine if the label will be suppressed because of overlapping.// |
| == Remarks == | == Remarks == | ||
| - | This method is the concrete wrapper for the abstract method CheckOverlappingCore. This method will determine if the label will be suppressed because it is overlapping another label. It also takes into consideration the overlapping rules for the class. So, for example, if we set to allow overlap, then the method will always return false. If the class is set to not allow overlap and this label is overlapping, then it will return true and be suppressed. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //This method is the concrete wrapper for the abstract method CheckOverlappingCore. This method will determine if the label will be suppressed because it is overlapping another label. It also takes into consideration the overlapping rules for the class. So, for example, if we set to allow overlap, then the method will always return false. If the class is set to not allow overlap and this label is overlapping, then it will return true and be suppressed. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
| == Return Value == | == Return Value == | ||
| Line 465: | Line 468: | ||
| ** {{wiki:ProtectedMethod.gif|}} CheckOverlappingCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} CheckOverlappingCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method will determine whether the label will be suppressed because of overlapping. | + | * //This method will determine whether the label will be suppressed because of overlapping.// |
| == Remarks == | == Remarks == | ||
| - | This overridden method is called from the concrete public method CheckOverlapping. This method will determine if the label will be suppressed because it is overlapping another label. It also takes into consideration the overlapping rules for the class. So, for example, if we set to allow overlap, then the method will always return false. If the class is set to not allow overlap and this label is overlapping, then it will return true and be suppressed. | + | * //This overridden method is called from the concrete public method CheckOverlapping. This method will determine if the label will be suppressed because it is overlapping another label. It also takes into consideration the overlapping rules for the class. So, for example, if we set to allow overlap, then the method will always return false. If the class is set to not allow overlap and this label is overlapping, then it will return true and be suppressed.// |
| == Return Value == | == Return Value == | ||
| Line 491: | Line 494: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} lD8=(PolygonShape,String,GeoCanvas) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetLabelingCandidateForOnePolygon(PolygonShape,String,GeoCanvas) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 512: | Line 515: | ||
| * //canvas// | * //canvas// | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Format(String,BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //text// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //labeledShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} FormatCore(String,BaseShape) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //text// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //labeledShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnFormatting(FormattingPositionStyleEventArgs) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnFormatted(FormattedPositionStyleEventArgs) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]] | ||
| * Description:N/A | * Description:N/A | ||
| Line 589: | Line 520: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 601: | Line 532: | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 621: | Line 552: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 633: | Line 564: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 643: | Line 574: | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} ConvertToScreenShape(Feature,GeoCanvas) ** | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} ConvertToWorldCoordinate(PolygonShape,GeoCanvas) ** |
| - | This method converts a feature in world coordinates to screen coordinates. | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | This overridden method can be called by this class and its sub concrete classes. In this method, we take the canvas and the feature in world coordinates and convert it to screen coordinates. | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * Description:A screen coordinate shape. | + | * Description:N/A |
| == Parameters == | == Parameters == | ||
| - | * //feature// | + | * //simplyPolygon// |
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
| - | * Description:This parameter is the feature to be converted from world coordinates. | + | * Description:N/A |
| * //canvas// | * //canvas// | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:This parameter is the canvas that will be used to convert the world coordinate feature to a screen coorindate feature. | + | * Description:N/A |
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} sz8=(PolygonShape,GeoCanvas) ** | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} ConvertToScreenShape(Feature,GeoCanvas) ** |
| - | N/A | + | * //This method converts a feature in world coordinates to screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //This overridden method can be called by this class and its sub concrete classes. In this method, we take the canvas and the feature in world coordinates and convert it to screen coordinates.// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | * Description:N/A | + | * Description:A screen coordinate shape. |
| == Parameters == | == Parameters == | ||
| - | * //simplyPolygon// | + | * //feature// |
| - | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | * Description:N/A | + | * Description:This parameter is the feature to be converted from world coordinates. |
| * //canvas// | * //canvas// | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | + | * Description:This parameter is the canvas that will be used to convert the world coordinate feature to a screen coorindate feature. |
| <div newline></div> | <div newline></div> | ||
| Line 686: | Line 617: | ||
| ** {{wiki:PublicProperty.gif|}} PolygonLabelingLocationMode ** | ** {{wiki:PublicProperty.gif|}} PolygonLabelingLocationMode ** | ||
| - | This property gets and sets the mode that determines how to locate polygon's labeling | + | * //This property gets and sets the mode that determines how to locate polygon's labeling// |
| == Remarks == | == Remarks == | ||
| - | There are two ways to handle polygon's labeling location. The first is to use polygon's centroid as the labeling location, the second way is to use polygon's boungdingbox center as the labeling location. | + | * //There are two ways to handle polygon's labeling location. The first is to use polygon's centroid as the labeling location, the second way is to use polygon's boungdingbox center as the labeling location.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.PolygonLabelingLocationMode|PolygonLabelingLocationMode]] | * Type:[[ThinkGeo.MapSuite.Core.PolygonLabelingLocationMode|PolygonLabelingLocationMode]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} MaxNudgingInPixel ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} NudgingIntervalInPixel ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} BestPlacementSymbolWidth ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} BestPlacementSymbolHeight ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} AbbreviationDictionary ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Dictionary<String,String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} LeaderLineStyle ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} LeaderLineRule ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.LabelLeaderLinesRule|LabelLeaderLinesRule]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} LeaderLineMinimumLengthInPixels ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| ** {{wiki:PublicProperty.gif|}} GridSize ** | ** {{wiki:PublicProperty.gif|}} GridSize ** | ||
| - | This property gets and sets the grid size used for deterministic labeling. | + | * //This property gets and sets the grid size used for deterministic labeling.// |
| == Remarks == | == Remarks == | ||
| - | The grid size determines how many labels will be considered as candidates for drawing. The smaller the grid size, the higher the density of candidates. Making the grid size too small may have a performance impact. | + | * //The grid size determines how many labels will be considered as candidates for drawing. The smaller the grid size, the higher the density of candidates. Making the grid size too small may have a performance impact.// |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 766: | Line 633: | ||
| ** {{wiki:PublicProperty.gif|}} DuplicateRule ** | ** {{wiki:PublicProperty.gif|}} DuplicateRule ** | ||
| - | This property gets and sets the rule that determines how duplicate labels are handled. | + | * //This property gets and sets the rule that determines how duplicate labels are handled.// |
| == Remarks == | == Remarks == | ||
| - | There are three ways to handle duplicate label names. The first is to suppress all duplicates, which means if there are two street segments with the same name then only one will be drawn. The second way is to suppress duplicate labels only if they are in one quarter of the screen. In this way, the screen will be divided into four quadrants, and if the two duplicate labels are in different quadrants, then they will both draw. The last way is to draw all duplicates. | + | * //There are three ways to handle duplicate label names. The first is to suppress all duplicates, which means if there are two street segments with the same name then only one will be drawn. The second way is to suppress duplicate labels only if they are in one quarter of the screen. In this way, the screen will be divided into four quadrants, and if the two duplicate labels are in different quadrants, then they will both draw. The last way is to draw all duplicates.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.LabelDuplicateRule|LabelDuplicateRule]] | * Type:[[ThinkGeo.MapSuite.Core.LabelDuplicateRule|LabelDuplicateRule]] | ||
| Line 774: | Line 641: | ||
| ** {{wiki:PublicProperty.gif|}} OverlappingRule ** | ** {{wiki:PublicProperty.gif|}} OverlappingRule ** | ||
| - | This property gets and sets the rule that determines how overlapping labels are handled. | + | * //This property gets and sets the rule that determines how overlapping labels are handled.// |
| == Remarks == | == Remarks == | ||
| - | This defines the rules for label overlapping. Currently, either we allow overlapping or we do not. In the future, we may extend this to allow some percentage of partial overlapping. | + | * //This defines the rules for label overlapping. Currently, either we allow overlapping or we do not. In the future, we may extend this to allow some percentage of partial overlapping.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.LabelOverlappingRule|LabelOverlappingRule]] | * Type:[[ThinkGeo.MapSuite.Core.LabelOverlappingRule|LabelOverlappingRule]] | ||
| Line 782: | Line 649: | ||
| ** {{wiki:PublicProperty.gif|}} AllowLineCarriage ** | ** {{wiki:PublicProperty.gif|}} AllowLineCarriage ** | ||
| - | This property gets and sets whether the labeler will allow carriage returns to be inserted. | + | * //This property gets and sets whether the labeler will allow carriage returns to be inserted.// |
| == Remarks == | == Remarks == | ||
| - | This property enables the labeler to split long labels into multiple lines if need be. For instance, if you have a lake whose name is "Southern Homestead Lake," then the labeler may try and break the name onto multiple lines in order to better label the feature. | + | * //This property enables the labeler to split long labels into multiple lines if need be. For instance, if you have a lake whose name is "Southern Homestead Lake," then the labeler may try and break the name onto multiple lines in order to better label the feature.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 790: | Line 657: | ||
| ** {{wiki:PublicProperty.gif|}} SuppressPartialLabels ** | ** {{wiki:PublicProperty.gif|}} SuppressPartialLabels ** | ||
| - | This property gets and sets whether a partial label in the current extent will be drawn or not. | + | * //This property gets and sets whether a partial label in the current extent will be drawn or not.// |
| == Remarks == | == Remarks == | ||
| - | This property provides a solution to the "cut off" label issue in Map Suite Web Edition and Desktop Edition, which occurs when multiple tiles exist. When you set this property to true, any labels outside of the current extent will not be drawn. | + | * //This property provides a solution to the "cut off" label issue in Map Suite Web Edition and Desktop Edition, which occurs when multiple tiles exist. When you set this property to true, any labels outside of the current extent will not be drawn.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 798: | Line 665: | ||
| ** {{wiki:PublicProperty.gif|}} ForceLineCarriage ** | ** {{wiki:PublicProperty.gif|}} ForceLineCarriage ** | ||
| - | This property gets and sets whether the labeler will force carriage returns to be inserted. | + | * //This property gets and sets whether the labeler will force carriage returns to be inserted.// |
| == Remarks == | == Remarks == | ||
| - | This property forces the labeler to split long labels into multiple lines. For instance, if you have a lake whose name is "Southern Homestead Lake," then the labeler will break the name onto multiple lines in order to better label the feature. | + | * //This property forces the labeler to split long labels into multiple lines. For instance, if you have a lake whose name is "Southern Homestead Lake," then the labeler will break the name onto multiple lines in order to better label the feature.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 806: | Line 673: | ||
| ** {{wiki:PublicProperty.gif|}} FittingPolygon ** | ** {{wiki:PublicProperty.gif|}} FittingPolygon ** | ||
| - | This property gets and sets whether the labeler will try to fit the label as best as it can within the boundary of a polygon. | + | * //This property gets and sets whether the labeler will try to fit the label as best as it can within the boundary of a polygon.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 814: | Line 681: | ||
| ** {{wiki:PublicProperty.gif|}} LabelAllPolygonParts ** | ** {{wiki:PublicProperty.gif|}} LabelAllPolygonParts ** | ||
| - | This property gets and sets whether the labeler will label every part of a multi-part polygon. | + | * //This property gets and sets whether the labeler will label every part of a multi-part polygon.// |
| == Remarks == | == Remarks == | ||
| - | In some cases, you may want to label all of the parts of a multi-part polygon, while in other cases you may not. For example, you may have a series of lakes where you do want to label each polygon. In another case, you may have a country with many small islands and in this case you only want to label the largest polygon. | + | * //In some cases, you may want to label all of the parts of a multi-part polygon, while in other cases you may not. For example, you may have a series of lakes where you do want to label each polygon. In another case, you may have a country with many small islands and in this case you only want to label the largest polygon.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 822: | Line 689: | ||
| ** {{wiki:PublicProperty.gif|}} LabelAllLineParts ** | ** {{wiki:PublicProperty.gif|}} LabelAllLineParts ** | ||
| - | This property gets and sets whether the labeler will label every part of a multi-part line. | + | * //This property gets and sets whether the labeler will label every part of a multi-part line.// |
| == Remarks == | == Remarks == | ||
| - | In some cases, you may want to label all of the parts of a multi-part line, while in other cases you may not. | + | * //In some cases, you may want to label all of the parts of a multi-part line, while in other cases you may not.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 830: | Line 697: | ||
| ** {{wiki:PublicProperty.gif|}} FittingPolygonFactor ** | ** {{wiki:PublicProperty.gif|}} FittingPolygonFactor ** | ||
| - | This property gets and sets the factor to which it will keep the label inside of the polygon. | + | * //This property gets and sets the factor to which it will keep the label inside of the polygon.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 838: | Line 705: | ||
| ** {{wiki:PublicProperty.gif|}} TextLineSegmentRatio ** | ** {{wiki:PublicProperty.gif|}} TextLineSegmentRatio ** | ||
| - | This property gets and sets the ratio required for the label length to match the line length. | + | * //This property gets and sets the ratio required for the label length to match the line length.// |
| == Remarks == | == Remarks == | ||
| - | This allows you to suppress labels where the label length would greatly exceed the line length. For example, if you set the ratio to 1, then the label will be suppressed if it is longer than the line. If the ratio is lower, then the label would need to be shorter than the line. If higher, then the label is allowed to run past the length of the line. This allows you to control the look of things like road labeling. | + | * //This allows you to suppress labels where the label length would greatly exceed the line length. For example, if you set the ratio to 1, then the label will be suppressed if it is longer than the line. If the ratio is lower, then the label would need to be shorter than the line. If higher, then the label is allowed to run past the length of the line. This allows you to control the look of things like road labeling.// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 846: | Line 713: | ||
| ** {{wiki:PublicProperty.gif|}} BestPlacement ** | ** {{wiki:PublicProperty.gif|}} BestPlacement ** | ||
| - | This property gets and sets whether the labeler will attempt to change the label position to avoid overlapping for point-based features. | + | * //This property gets and sets whether the labeler will attempt to change the label position to avoid overlapping for point-based features.// |
| == Remarks == | == Remarks == | ||
| - | The positioning of point labels is mainly determined by the PointPlacement property. This allows you place the text to the right, top, bottom, etc. of the point. In some cases, placing the text in a certain place will cause many labels to be suppressed when the points are dense. This property allows you to override the PointPlacement property and allow the labeler to try other locations, if the default location would cause the label to be suppressed. | + | * //The positioning of point labels is mainly determined by the PointPlacement property. This allows you place the text to the right, top, bottom, etc. of the point. In some cases, placing the text in a certain place will cause many labels to be suppressed when the points are dense. This property allows you to override the PointPlacement property and allow the labeler to try other locations, if the default location would cause the label to be suppressed.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 854: | Line 721: | ||
| ** {{wiki:PublicProperty.gif|}} PointPlacement ** | ** {{wiki:PublicProperty.gif|}} PointPlacement ** | ||
| - | This property gets and sets the location of the label for point features relative to the point. | + | * //This property gets and sets the location of the label for point features relative to the point.// |
| == Remarks == | == Remarks == | ||
| - | This property allows you to choose where the labels are created relative to the point. For example, you can set the property to RightCenter, which would ensure that all labels are placed to the right of and vertically centered with the point. Different kinds of point layers can be positioned differently. If the point layer is dense and position is not a main concern, then you can try the BestPlacement property. That property overrides this property and tries to fit the label in the best location so that the minimum number of labels are suppressed due to overlapping issues. | + | * //This property allows you to choose where the labels are created relative to the point. For example, you can set the property to RightCenter, which would ensure that all labels are placed to the right of and vertically centered with the point. Different kinds of point layers can be positioned differently. If the point layer is dense and position is not a main concern, then you can try the BestPlacement property. That property overrides this property and tries to fit the label in the best location so that the minimum number of labels are suppressed due to overlapping issues.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.PointPlacement|PointPlacement]] | * Type:[[ThinkGeo.MapSuite.Core.PointPlacement|PointPlacement]] | ||
| Line 862: | Line 729: | ||
| ** {{wiki:PublicProperty.gif|}} MaskType ** | ** {{wiki:PublicProperty.gif|}} MaskType ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.MaskType|MaskType]] | * Type:[[ThinkGeo.MapSuite.Core.MaskType|MaskType]] | ||
| Line 870: | Line 737: | ||
| ** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 878: | Line 745: | ||
| ** {{wiki:PublicProperty.gif|}} IsActive ** | ** {{wiki:PublicProperty.gif|}} IsActive ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 886: | Line 753: | ||
| ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** | ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
| Line 894: | Line 761: | ||
| ** {{wiki:PublicProperty.gif|}} Filters ** | ** {{wiki:PublicProperty.gif|}} Filters ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
| Line 903: | Line 770: | ||
| ** {{wiki:ProtectedProperty.gif|}} LabelPositions ** | ** {{wiki:ProtectedProperty.gif|}} LabelPositions ** | ||
| - | Gets a value represents a keyValuepair which is a feature id and label position of the feature | + | * //Gets a value represents a keyValuepair which is a feature id and label position of the feature// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Dictionary<String,[[ThinkGeo.MapSuite.Core.WorldLabelingCandidate|WorldLabelingCandidate]]> | * Type:Dictionary<String,[[ThinkGeo.MapSuite.Core.WorldLabelingCandidate|WorldLabelingCandidate]]> | ||
| Line 911: | Line 778: | ||
| ** {{wiki:ProtectedProperty.gif|}} XOffsetInPixel ** | ** {{wiki:ProtectedProperty.gif|}} XOffsetInPixel ** | ||
| - | This property gets and sets the X pixel offset used for drawing each feature. | + | * //This property gets and sets the X pixel offset used for drawing each feature.// |
| == Remarks == | == Remarks == | ||
| - | This property allows you to specify an X offset. When combined with a Y offset, it is useful to allow you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to better align it with raster satellite data. | + | * //This property allows you to specify an X offset. When combined with a Y offset, it is useful to allow you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to better align it with raster satellite data.// |
| == Return Value == | == Return Value == | ||
| * Type:Single | * Type:Single | ||
| Line 919: | Line 786: | ||
| ** {{wiki:ProtectedProperty.gif|}} YOffsetInPixel ** | ** {{wiki:ProtectedProperty.gif|}} YOffsetInPixel ** | ||
| - | This property gets and sets the Y pixel offset used for drawing each feature. | + | * //This property gets and sets the Y pixel offset used for drawing each feature.// |
| == Remarks == | == Remarks == | ||
| - | This property allows you to specify a Y offset. When combined with an X offset, it is useful to allow you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to better align it with raster satellite data. | + | * //This property allows you to specify a Y offset. When combined with an X offset, it is useful to allow you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to better align it with raster satellite data.// |
| == Return Value == | == Return Value == | ||
| * Type:Single | * Type:Single | ||
| Line 927: | Line 794: | ||
| ** {{wiki:ProtectedProperty.gif|}} CustomTextStyles ** | ** {{wiki:ProtectedProperty.gif|}} CustomTextStyles ** | ||
| - | This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other. | + | * //This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other.// |
| == Remarks == | == Remarks == | ||
| - | Using this collection you can stack multiple area styles on top of each other. When we draw the feature we will draw them in order in the collection. You can use these stacks to create drop shadow effects along with multiple colored outlines etc. | + | * //Using this collection you can stack multiple area styles on top of each other. When we draw the feature we will draw them in order in the collection. You can use these stacks to create drop shadow effects along with multiple colored outlines etc.// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]> | ||
| Line 935: | Line 802: | ||
| ** {{wiki:ProtectedProperty.gif|}} RotationAngle ** | ** {{wiki:ProtectedProperty.gif|}} RotationAngle ** | ||
| - | This property gets and sets the rotation angle of the item being positioned. | + | * //This property gets and sets the rotation angle of the item being positioned.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 943: | Line 810: | ||
| ** {{wiki:ProtectedProperty.gif|}} FittingLineInScreen ** | ** {{wiki:ProtectedProperty.gif|}} FittingLineInScreen ** | ||
| - | This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a line on the screen. | + | * //This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a line on the screen.// |
| == Remarks == | == Remarks == | ||
| - | A label will normally be displayed in the center of a line. If only a small piece of the line is visible on the screen, we cannot see it's label by default. If we set this property to ture though, the label will be displayed in the center of that piece in screen. | + | * //A label will normally be displayed in the center of a line. If only a small piece of the line is visible on the screen, we cannot see it's label by default. If we set this property to ture though, the label will be displayed in the center of that piece in screen.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 951: | Line 818: | ||
| ** {{wiki:ProtectedProperty.gif|}} FittingPolygonInScreen ** | ** {{wiki:ProtectedProperty.gif|}} FittingPolygonInScreen ** | ||
| - | This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a polygon on the screen. | + | * //This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a polygon on the screen.// |
| == Remarks == | == Remarks == | ||
| - | A label will normally be displayed in the center of a polygon. If only a small piece of the polygon is visible on the screen, we cannot see it's label by default. If we set this property to ture though, the label will be displayed in the center of that piece in screen. | + | * //A label will normally be displayed in the center of a polygon. If only a small piece of the polygon is visible on the screen, we cannot see it's label by default. If we set this property to ture though, the label will be displayed in the center of that piece in screen.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 959: | Line 826: | ||
| ** {{wiki:ProtectedProperty.gif|}} TextFormat ** | ** {{wiki:ProtectedProperty.gif|}} TextFormat ** | ||
| - | This property gets and sets the format that will be applied to the text. | + | * //This property gets and sets the format that will be applied to the text.// |
| == Remarks == | == Remarks == | ||
| - | With this property, you can apply formats to the text that is retrieved from the feature. | + | * //With this property, you can apply formats to the text that is retrieved from the feature.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 967: | Line 834: | ||
| ** {{wiki:ProtectedProperty.gif|}} NumericFormat ** | ** {{wiki:ProtectedProperty.gif|}} NumericFormat ** | ||
| - | This property gets and sets the format that will be applied to the text which can be parsed to double type. | + | * //This property gets and sets the format that will be applied to the text which can be parsed to double type.// |
| == Remarks == | == Remarks == | ||
| - | With this property, you can apply formats to the text that is retrieved from the feature. | + | * //With this property, you can apply formats to the text that is retrieved from the feature.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 975: | Line 842: | ||
| ** {{wiki:ProtectedProperty.gif|}} DateFormat ** | ** {{wiki:ProtectedProperty.gif|}} DateFormat ** | ||
| - | This property gets and sets the format that will be applied to the text which can be parsed to DateTime type. | + | * //This property gets and sets the format that will be applied to the text which can be parsed to DateTime type.// |
| == Remarks == | == Remarks == | ||
| - | With this property, you can apply formats to the text that is retrieved from the feature. | + | * //With this property, you can apply formats to the text that is retrieved from the feature.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 983: | Line 850: | ||
| ** {{wiki:ProtectedProperty.gif|}} TextSolidBrush ** | ** {{wiki:ProtectedProperty.gif|}} TextSolidBrush ** | ||
| - | This property gets and sets the SolidBrush that will be used to draw the text. | + | * //This property gets and sets the SolidBrush that will be used to draw the text.// |
| == Remarks == | == Remarks == | ||
| - | You can use this property to draw a solid color; however, if you need to use other brushes, you can access them through the Advanced property of this class. | + | * //You can use this property to draw a solid color; however, if you need to use other brushes, you can access them through the Advanced property of this class.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| Line 991: | Line 858: | ||
| ** {{wiki:ProtectedProperty.gif|}} Font ** | ** {{wiki:ProtectedProperty.gif|}} Font ** | ||
| - | This property gets and sets the font that will be used to draw the text. | + | * //This property gets and sets the font that will be used to draw the text.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]] | * Type:[[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]] | ||
| Line 999: | Line 866: | ||
| ** {{wiki:ProtectedProperty.gif|}} HaloPen ** | ** {{wiki:ProtectedProperty.gif|}} HaloPen ** | ||
| - | This property gets and sets the halo pen you may use to draw a halo around the text. | + | * //This property gets and sets the halo pen you may use to draw a halo around the text.// |
| == Remarks == | == Remarks == | ||
| - | The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background. | + | * //The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | ||
| Line 1007: | Line 874: | ||
| ** {{wiki:ProtectedProperty.gif|}} TextColumnName ** | ** {{wiki:ProtectedProperty.gif|}} TextColumnName ** | ||
| - | This property gets and sets the column name in the data that you want to get the text from. | + | * //This property gets and sets the column name in the data that you want to get the text from.// |
| == Remarks == | == Remarks == | ||
| - | This property is used when retrieving text from a feature. You will want to specify the name of the column that contains the text you want to draw. | + | * //This property is used when retrieving text from a feature. You will want to specify the name of the column that contains the text you want to draw.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 1015: | Line 882: | ||
| ** {{wiki:ProtectedProperty.gif|}} Mask ** | ** {{wiki:ProtectedProperty.gif|}} Mask ** | ||
| - | This property gets and sets the AreaStyle used to draw a mask behind the text. | + | * //This property gets and sets the AreaStyle used to draw a mask behind the text.// |
| == Remarks == | == Remarks == | ||
| - | A mask is a plate behind the text that is rectangular and slightly larger than the width and height of the text. It allows the label to stand out well on a busy background. You can also try the HaloPen property instead of the mask, if the mask effect is too pronounced. | + | * //A mask is a plate behind the text that is rectangular and slightly larger than the width and height of the text. It allows the label to stand out well on a busy background. You can also try the HaloPen property instead of the mask, if the mask effect is too pronounced.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | ||
| Line 1023: | Line 890: | ||
| ** {{wiki:ProtectedProperty.gif|}} MaskMargin ** | ** {{wiki:ProtectedProperty.gif|}} MaskMargin ** | ||
| - | This property gets and sets the margin around the text that will be used for the mask. | + | * //This property gets and sets the margin around the text that will be used for the mask.// |
| == Remarks == | == Remarks == | ||
| - | This determines how much larger the mask is than the text, in pixels. | + | * //This determines how much larger the mask is than the text, in pixels.// |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 1031: | Line 898: | ||
| ** {{wiki:ProtectedProperty.gif|}} Advanced ** | ** {{wiki:ProtectedProperty.gif|}} Advanced ** | ||
| - | This property gets the advanced properties of the class. | + | * //This property gets the advanced properties of the class.// |
| == Remarks == | == Remarks == | ||
| - | The advanced properties have been consolidated in the Advanced property. This way, the standard options are more easily visible and the advanced options are hidden away. | + | * //The advanced properties have been consolidated in the Advanced property. This way, the standard options are more easily visible and the advanced options are hidden away.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.TextStyleAdvanced|TextStyleAdvanced]] | * Type:[[ThinkGeo.MapSuite.Core.TextStyleAdvanced|TextStyleAdvanced]] | ||
| Line 1039: | Line 906: | ||
| ** {{wiki:ProtectedProperty.gif|}} AllowSpline ** | ** {{wiki:ProtectedProperty.gif|}} AllowSpline ** | ||
| - | This property gets and sets whether line labels are allowed to spline around curved lines. | + | * //This property gets and sets whether line labels are allowed to spline around curved lines.// |
| == Remarks == | == Remarks == | ||
| - | This property will allow the labeler to spline the label around curved lines. This is useful for curved streets that need to be labeled. This can have a considerable performance impact, so we suggest you experiment with it to ensure it can meet your needs. | + | * //This property will allow the labeler to spline the label around curved lines. This is useful for curved streets that need to be labeled. This can have a considerable performance impact, so we suggest you experiment with it to ensure it can meet your needs.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 1047: | Line 914: | ||
| ** {{wiki:ProtectedProperty.gif|}} ForceHorizontalLabelForLine ** | ** {{wiki:ProtectedProperty.gif|}} ForceHorizontalLabelForLine ** | ||
| - | This property gets and sets whether we should force horizontal labeling for lines. | + | * //This property gets and sets whether we should force horizontal labeling for lines.// |
| == Remarks == | == Remarks == | ||
| - | Normally, lines are labeled in the direction of the line. There may be some cases, however, when you want to have the line labeled horizontally regardless of the line's direction. In such a case, you can set this property to force the lines to be labeled horizontally. | + | * //Normally, lines are labeled in the direction of the line. There may be some cases, however, when you want to have the line labeled horizontally regardless of the line's direction. In such a case, you can set this property to force the lines to be labeled horizontally.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 1055: | Line 922: | ||
| ** {{wiki:ProtectedProperty.gif|}} SplineType ** | ** {{wiki:ProtectedProperty.gif|}} SplineType ** | ||
| - | Gets or sets the SplineType for labeling. | + | * //Gets or sets the SplineType for labeling.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.SplineType|SplineType]] | * Type:[[ThinkGeo.MapSuite.Core.SplineType|SplineType]] | ||
| Line 1063: | Line 930: | ||
| ** {{wiki:ProtectedProperty.gif|}} DrawingLevel ** | ** {{wiki:ProtectedProperty.gif|}} DrawingLevel ** | ||
| - | Gets or sets the DrawingLavel for this style. | + | * //Gets or sets the DrawingLavel for this style.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] | * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] | ||
| - | ** {{wiki:ProtectedProperty.gif|}} uBs= ** | + | ** {{wiki:ProtectedProperty.gif|}} IsDefault ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 1079: | Line 946: | ||
| ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** | ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
| Line 1087: | Line 954: | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| ** {{wiki:PublicEvent.gif|}} Formatting ** | ** {{wiki:PublicEvent.gif|}} Formatting ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| Event Arguments:[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} Formatted ** | ** {{wiki:PublicEvent.gif|}} Formatted ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| Event Arguments:[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]] | ||
thinkgeo.mapsuite.portablecore.positionstyle.1442823365.txt.gz · Last modified: 2015/09/21 08:16 by admin