Products
Professional Services
Demos and Downloads
Help and Support
Products
Professional Services
Demos and Downloads
Help and Support
This is an old revision of the document!
<!– Class –> This class allows you to choose different icons based on values in the data of a feature.
When you create an IconValueStyle, you need to add multiple IconValueItems to its collection. You input the column name in the IconValueStyle and it will compare the data's value to each IconValueItem's FieldValue. If they match, then it will draw the Feature using the properties of the IconValueItem. In this way, you can render different data with different icons or text.
The MinimumLength and MaximumLength properties are important because they are used to ensure that a properly sized icon is used to draw things like road signs. For example, you can set the minimum and maximum values so that the sign icon for a single-digit road number uses one icon, while a two-digit road uses another, wider sign icon in a separate IconValueItem.
*System.Object ThinkGeo.MapSuite.PortableCore.Style *ThinkGeo.MapSuite.PortableCore.PositionStyle ThinkGeo.MapSuite.PortableCore.IconValueStyle
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | This is the constructor for the class. | ||
![]() | String | This is the constructor for the class. | |
![]() | String, IEnumerable<IconValueItem> | This is the constructor for the class. |
Name | Parameters | DeclaringType | Summary |
---|
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Style | Create a copy of style using the deep clone process. | |
![]() | IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style | This method draws the shapes on the canvas you provided. |
![]() | IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style | This method draws the features on the canvas you provided. |
![]() | GeoCanvas, DrawingRectangleF | Style | This method draws a sample feature on the canvas you provided. |
![]() | GeoCanvas | Style | |
![]() | Object | Object | |
![]() | Object | ||
![]() | Style | This method returns the column data for each feature that is required for the style to properly draw. | |
![]() | Object | ||
![]() | Object |
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | LabelingCandidate, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | PositionStyle | This method will determine whether the label will be suppressed because it is a duplicate. |
![]() | LabelingCandidate, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | PositionStyle | This method will determine if the label will be suppressed because it is a duplicate. |
![]() | LabelingCandidate, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | PositionStyle | This method will determine if the label will be suppressed because of overlapping. |
![]() | LabelingCandidate, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | PositionStyle | This method will determine whether the label will be suppressed because of overlapping. |
![]() | Style | Create a copy of style using the deep clone process. The default implementation method uses serialization. | |
![]() | IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style(overriden) | This method draws the features on the canvas you provided. |
![]() | GeoCanvas, DrawingRectangleF | Style | This method draws a sample feature on the canvas you provided. |
![]() | IEnumerable<Feature>, GeoCanvas | PositionStyle | This method filters the features based on the grid size to facilitate deterministic labeling. |
![]() | Object | ||
![]() | String, BaseShape | PositionStyle | |
![]() | String, BaseShape | PositionStyle | |
![]() | Feature, GeoCanvas | PositionStyle(overriden) | This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set. |
![]() | Feature, GeoCanvas | PositionStyle | This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set. |
![]() | Style(overriden) | This method returns the column data for each feature that is required for the style to properly draw. | |
![]() | Object | ||
![]() | FormattedPositionStyleEventArgs | PositionStyle | |
![]() | FormattingPositionStyleEventArgs | PositionStyle |
Name | Return | DeclaringType | Summary |
---|---|---|---|
![]() | Boolean | PositionStyle | This property gets and sets whether the labeler will allow carriage returns to be inserted. |
![]() | Boolean | PositionStyle | This property gets and sets whether the labeler will attempt to change the label position to avoid overlapping for point-based features. |
![]() | String | This property gets and sets the column name that will be used for the drawing and matching. | |
![]() | LabelDuplicateRule | PositionStyle | This property gets and sets the rule that determines how duplicate labels are handled. |
![]() | Collection<String> | Style | |
![]() | Boolean | PositionStyle | 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. |
![]() | Double | PositionStyle | This property gets and sets the factor to which it will keep the label inside of the polygon. |
![]() | Boolean | PositionStyle | This property gets and sets whether the labeler will force carriage returns to be inserted. |
![]() | Int32 | PositionStyle | This property gets and sets the grid size used for deterministic labeling. |
![]() | Collection<IconValueItem> | This property gets the collection of IconValueItems for matching. | |
![]() | Boolean | Style | This property gets and sets the active status of the style. |
![]() | Boolean | PositionStyle | This property gets and sets whether the labeler will label every part of a multi-part line. |
![]() | Boolean | PositionStyle | This property gets and sets whether the labeler will label every part of a multi-part polygon. |
![]() | MaskType | PositionStyle | |
![]() | String | Style | This property gets and set the name of the style. |
![]() | LabelOverlappingRule | PositionStyle | This property gets and sets the rule that determines how overlapping labels are handled. |
![]() | PointPlacement | PositionStyle | This property gets and sets the location of the label for point features relative to the point. |
![]() | PolygonLabelingLocationMode | PositionStyle | This property gets and sets the mode that determines how to locate polygon's labeling |
![]() | Collection<String> | Style | This property gets the collection of fields that are required for the style. |
![]() | Boolean | PositionStyle | This property gets and sets whether a partial label in the current extent will be drawn or not. |
![]() | Double | PositionStyle | This property gets and sets the ratio required for the label length to match the line length. |
Name | Return | DeclaringType | Summary |
---|---|---|---|
![]() | TextStyleAdvanced | PositionStyle | This property gets the advanced properties of the class. |
![]() | Boolean | PositionStyle | This property gets and sets whether line labels are allowed to spline around curved lines. |
![]() | Collection<TextStyle> | PositionStyle | This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other. |
![]() | String | PositionStyle | This property gets and sets the format that will be applied to the text which can be parsed to DateTime type. |
![]() | DrawingLevel | PositionStyle | Gets or sets the DrawingLavel for this style. |
![]() | Collection<String> | Style | |
![]() | Boolean | PositionStyle | 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. |
![]() | Boolean | PositionStyle | 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. |
![]() | GeoFont | PositionStyle | This property gets and sets the font that will be used to draw the text. |
![]() | Boolean | PositionStyle | This property gets and sets whether we should force horizontal labeling for lines. |
![]() | GeoPen | PositionStyle | This property gets and sets the halo pen you may use to draw a halo around the text. |
![]() | Dictionary<String,WorldLabelingCandidate> | PositionStyle | Gets a value represents a keyValuepair which is a feature id and label position of the feature |
![]() | AreaStyle | PositionStyle | This property gets and sets the AreaStyle used to draw a mask behind the text. |
![]() | Int32 | PositionStyle | This property gets and sets the margin around the text that will be used for the mask. |
![]() | String | PositionStyle | This property gets and sets the format that will be applied to the text which can be parsed to double type. |
![]() | Double | PositionStyle | This property gets and sets the rotation angle of the item being positioned. |
![]() | SplineType | PositionStyle | Gets or sets the SplineType for labeling. |
![]() | String | PositionStyle | This property gets and sets the column name in the data that you want to get the text from. |
![]() | String | PositionStyle | This property gets and sets the format that will be applied to the text. |
![]() | GeoSolidBrush | PositionStyle | This property gets and sets the SolidBrush that will be used to draw the text. |
![]() | Single | PositionStyle | This property gets and sets the X pixel offset used for drawing each feature. |
![]() | Single | PositionStyle | This property gets and sets the Y pixel offset used for drawing each feature. |
Name | Event Arguments | DeclaringType | Summary |
---|---|---|---|
![]() | FormattedPositionStyleEventArgs | PositionStyle | |
![]() | FormattingPositionStyleEventArgs | PositionStyle |
This is the constructor for the class.
This is the default constructor. If you use this constructor, then you need to set the required properties manually.
If you use this constructor, then you need to set the required properties manually.
Name | Type | Description |
---|
This is the constructor for the class.
This constructor allows you to pass in the column name.
Name | Type | Description |
---|---|---|
columnName | String<!– System.String –> | This parameter is the column name you want to match on. |
This is the constructor for the class.
This constructor allows you to pass in the column name.
Name | Type | Description |
---|---|---|
columnName | String<!– System.String –> | This parameter is the column name you want to match on. |
iconValueItems | IEnumerable<IconValueItem><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.IconValueItem} –> | This parameter is the icon value items you want to match on. |
Create a copy of style using the deep clone process.
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Type | Description |
---|---|
Style<!– ThinkGeo.MapSuite.PortableCore.Style –> | A cloned style. |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This method draws the shapes on the canvas you provided.
This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the shapes you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each shape differently.
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 Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
shapes | IEnumerable<BaseShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.BaseShape} –> | This parameter represents the shapes you want to draw on the canvas. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter represents the canvas you want to draw the shapes on. |
labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This method draws the features on the canvas you provided.
This method is the concrete wrapper for the abstract method DrawCore. 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.
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 Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} –> | This parameter represents the features you want to draw on the canvas. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This method draws a sample feature on the canvas you provided.
This method is the concrete wrapper for the abstract method DrawSampleCore. In this method we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area.
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 Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
drawingExtent | DrawingRectangleF<!– ThinkGeo.MapSuite.PortableCore.DrawingRectangleF –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
Return Type | Description |
---|---|
Boolean<!– System.Boolean –> |
Name | Type | Description |
---|---|---|
obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
Return Type | Description |
---|---|
Int32<!– System.Int32 –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
This method returns the column data for each feature that is required for the style to properly draw.
This method is the concrete wrapper for the abstract method GetRequiredColumnNamesCore. 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.
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 Type | Description |
---|---|
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns a collection of column names that the style needs. |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
Return Type | Description |
---|---|
Type<!– System.Type –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type | Description |
---|---|
String<!– System.String –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
This method will determine whether the label will be suppressed because it is a duplicate.
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 Type | Description |
---|---|
Boolean<!– System.Boolean –> | This method returns whether the label will be suppressed as a duplicate. |
Name | Type | Description |
---|---|---|
labelingCandidate | LabelingCandidate<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> | This parameter is the labeling candidate that will be checked to determine if it is a duplicate. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter is the canvas used for calculations. |
labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This method will determine if the label will be suppressed because it is a duplicate.
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 Type | Description |
---|---|
Boolean<!– System.Boolean –> | This method returns whether the label will be suppressed as a duplicate. |
Name | Type | Description |
---|---|---|
labelingCandidate | LabelingCandidate<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> | This parameter is the labeling candidate that will be checked to determine if it is a duplicate. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter is the canvas that will be used for calculations. |
labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This method will determine if the label will be suppressed because of overlapping.
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 Type | Description |
---|---|
Boolean<!– System.Boolean –> | This method returns whether the label will be suppressed because of overlapping. |
Name | Type | Description |
---|---|---|
labelingCandidate | LabelingCandidate<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> | This parameter is the labeling candidate that will be checked to determine if it is overlapping. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter is the canvas that will be used for calculations. |
labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This method will determine whether the label will be suppressed because of overlapping.
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 Type | Description |
---|---|
Boolean<!– System.Boolean –> | This method returns whether the label will be suppressed because of overlapping. |
Name | Type | Description |
---|---|---|
labelingCandidate | LabelingCandidate<!– ThinkGeo.MapSuite.PortableCore.LabelingCandidate –> | This parameter is the labeling candidate that will be checked to determine if it is overlapping. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter is the canvas that will be used for calculations. |
labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Create a copy of style using the deep clone process. The default implementation method uses serialization.
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Type | Description |
---|---|
Style<!– ThinkGeo.MapSuite.PortableCore.Style –> | A cloned style. |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This method draws the features on the canvas you provided.
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 Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} –> | This parameter represents the features you want to draw on the canvas. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.PortableCore.Style(overriden) –> Go Back
This method draws a sample feature on the canvas you provided.
This virtual method is called from the concrete public method Draw. In this method, we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area.
When implementing this virtual method, consider the canvas size and draw the sample image appropriately. You should keep in mind that the sample typically shows up on a legend.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
drawingExtent | DrawingRectangleF<!– ThinkGeo.MapSuite.PortableCore.DrawingRectangleF –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This method filters 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 Type | Description |
---|---|
Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} –> | This method returns the features that will be considered for labeling. |
Name | Type | Description |
---|---|---|
features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} –> | This parameter represents the features that will be filtered. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter is the canvas that will be used for calculating font sizes. |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type | Description |
---|---|
String<!– System.String –> |
Name | Type | Description |
---|---|---|
text | String<!– System.String –> | |
labeledShape | BaseShape<!– ThinkGeo.MapSuite.PortableCore.BaseShape –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Return Type | Description |
---|---|
String<!– System.String –> |
Name | Type | Description |
---|---|---|
text | String<!– System.String –> | |
labeledShape | BaseShape<!– ThinkGeo.MapSuite.PortableCore.BaseShape –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set.
This overridden method is called from the concrete public method Draw. 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 Type | Description |
---|---|
Collection<LabelingCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.LabelingCandidate} –> |
Name | Type | Description |
---|---|---|
feature | Feature<!– ThinkGeo.MapSuite.PortableCore.Feature –> | This parameter is the feature that will be considered as a labeling candidate. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter is the canvas that will be used to draw the feature. This method will not draw on this canvas, but rather will use it to determine font size, etc. |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle(overriden) –> Go Back
This method determines whether the specified feature is a good candidate to be labeled, based on the labeling properties set.
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 Type | Description |
---|---|
Collection<LabelingCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.LabelingCandidate} –> | A collection of labeling candidates. |
Name | Type | Description |
---|---|---|
feature | Feature<!– ThinkGeo.MapSuite.PortableCore.Feature –> | This parameter is the feature that will be considered as a labeling candidate. |
canvas | GeoCanvas<!– ThinkGeo.MapSuite.PortableCore.GeoCanvas –> | This parameter is the canvas that will be used to draw the feature. This method will not draw on this canvas, but rather will use it to determine font size, etc. |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This method returns the column data for each feature that is required for the style to properly draw.
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 Type | Description |
---|---|
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns a collection of the column names that it needs. |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.PortableCore.Style(overriden) –> Go Back
Return Type | Description |
---|---|
Object<!– System.Object –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
e | FormattedPositionStyleEventArgs<!– ThinkGeo.MapSuite.PortableCore.FormattedPositionStyleEventArgs –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
e | FormattingPositionStyleEventArgs<!– ThinkGeo.MapSuite.PortableCore.FormattingPositionStyleEventArgs –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets whether the labeler will allow carriage returns to be inserted.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets whether the labeler will attempt to change the label position to avoid overlapping for point-based features.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the column name that will be used for the drawing and matching.
This column name will be used to draw the text on the icon (if necessary) and to also match the value in the IconStyleItem.
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.PortableCore.IconValueStyle –> Go Back
This property gets and sets the rule that determines how duplicate labels are handled.
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 Type |
---|
LabelDuplicateRule<!– ThinkGeo.MapSuite.PortableCore.LabelDuplicateRule –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Return Type |
---|
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
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.
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the factor to which it will keep the label inside of the polygon.
Return Type |
---|
Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets whether the labeler will force carriage returns to be inserted.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the grid size used for deterministic labeling.
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 Type |
---|
Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets the collection of IconValueItems for matching.
You should create your IconValueItems and place them in this collection for consideration.
Return Type |
---|
Collection<IconValueItem><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.IconValueItem} –> |
<!– ThinkGeo.MapSuite.PortableCore.IconValueStyle –> Go Back
This property gets and sets the active status of the style.
If the style is not active then it will not draw.
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This property gets and sets whether the labeler will label every part of a multi-part line.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets whether the labeler will label every part of a multi-part 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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Return Type |
---|
MaskType<!– ThinkGeo.MapSuite.PortableCore.MaskType –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and set the name of the style.
This name is not used by the system; it is only for the developer. However, it can be used if you generate your own legend.
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This property gets and sets the rule that determines how overlapping labels are handled.
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 Type |
---|
LabelOverlappingRule<!– ThinkGeo.MapSuite.PortableCore.LabelOverlappingRule –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the location of the label for point features relative to the point.
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 Type |
---|
PointPlacement<!– ThinkGeo.MapSuite.PortableCore.PointPlacement –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the mode that determines how to locate polygon's labeling
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 Type |
---|
PolygonLabelingLocationMode<!– ThinkGeo.MapSuite.PortableCore.PolygonLabelingLocationMode –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets the collection of fields that are required for the style.
This property gets the collection of fields that are required for the style. These are in addition to any other columns you specify in styles that inherit from this one. For example, if you have use a ValueStyle and it requires a column name for the value comparison, then that column does not need to be in this collection. You only use the RequiredColumnNames for columns you need beyond those required by specific inherited styles.
Return Type |
---|
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
This property gets and sets whether a partial label in the current extent will be drawn or not.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the ratio required for the label length to match the line length.
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 Type |
---|
Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets the advanced properties of the class.
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 Type |
---|
TextStyleAdvanced<!– ThinkGeo.MapSuite.PortableCore.TextStyleAdvanced –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets whether line labels are allowed to spline around curved lines.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other.
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 Type |
---|
Collection<TextStyle><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.TextStyle} –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the format that will be applied to the text which can be parsed to DateTime type.
With this property, you can apply formats to the text that is retrieved from the feature.
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Gets or sets the DrawingLavel for this style.
Return Type |
---|
DrawingLevel<!– ThinkGeo.MapSuite.PortableCore.DrawingLevel –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Return Type |
---|
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.PortableCore.Style –> Go Back
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.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
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.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the font that will be used to draw the text.
Return Type |
---|
GeoFont<!– ThinkGeo.MapSuite.PortableCore.GeoFont –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets whether we should force horizontal labeling for lines.
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 Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the halo pen you may use to draw a halo around the text.
The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background.
Return Type |
---|
GeoPen<!– ThinkGeo.MapSuite.PortableCore.GeoPen –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Gets a value represents a keyValuepair which is a feature id and label position of the feature
Return Type |
---|
Dictionary<String,WorldLabelingCandidate><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.PortableCore.WorldLabelingCandidate} –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the AreaStyle used to draw a mask behind the text.
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 Type |
---|
AreaStyle<!– ThinkGeo.MapSuite.PortableCore.AreaStyle –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the margin around the text that will be used for the mask.
This determines how much larger the mask is than the text, in pixels.
Return Type |
---|
Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the format that will be applied to the text which can be parsed to double type.
With this property, you can apply formats to the text that is retrieved from the feature.
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the rotation angle of the item being positioned.
Return Type |
---|
Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Gets or sets the SplineType for labeling.
Return Type |
---|
SplineType<!– ThinkGeo.MapSuite.PortableCore.SplineType –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the column name in the data that you want to get the text from.
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 Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the format that will be applied to the text.
With this property, you can apply formats to the text that is retrieved from the feature.
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the SolidBrush that will be used to draw the text.
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 Type |
---|
GeoSolidBrush<!– ThinkGeo.MapSuite.PortableCore.GeoSolidBrush –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the X pixel offset used for drawing each feature.
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 Type |
---|
Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
This property gets and sets the Y pixel offset used for drawing each feature.
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 Type |
---|
Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Event Arguments |
---|
FormattedPositionStyleEventArgs<!– ThinkGeo.MapSuite.PortableCore.FormattedPositionStyleEventArgs –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
Event Arguments |
---|
FormattingPositionStyleEventArgs<!– ThinkGeo.MapSuite.PortableCore.FormattingPositionStyleEventArgs –> |
<!– ThinkGeo.MapSuite.PortableCore.PositionStyle –> Go Back
NOTOC MapSuitePortableCore ThinkGeo.MapSuite.PortableCore UpdateDocumentation
8501 Wade Blvd Ste 550
Frisco, TX 75034
United States
sales@thinkgeo.com
1-785-727-4133
Online Store
- Desktop
WPF
WinForms
- Web
WebAPI HTML5/JavaScript
ASP.NET MVC
WebForms with AJAX
- Mobile
iOS
Android™
World Street
World Imagery
Routing
Geocoding
Reverse Geocoding
Elevation
Quick Start Guides
Documentation
Blogs
Discussion Forums
Customer Portal
About Us
News & Announcemets
Privacy Policy
Copyright 2003-2017 ThinkGeo LLC.
All rights reserved.