ThinkGeo.MapSuite.Core.PositionStyle

This abstract class encapsulates the labeling position logic. It is inherited by other styles, such as the TextSytle.

• System.Object
  • ThinkGeo.MapSuite.Core.Style
    • ThinkGeo.MapSuite.Core.PositionStyle
      • ThinkGeo.MapSuite.Core.TextStyle
      • ThinkGeo.MapSuite.Core.IconValueStyle

PositionStyle()

• This is the default constructor for the class.

• None

CloneDeep()

• N/A

• N/A

• Type:Style
• Description:N/A

Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

• N/A

• N/A

• Type:Void
• Description:N/A

• features
  • Type:IEnumerable<Feature>
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

• N/A

• N/A

• Type:Void
• Description:N/A

• shapes
  • Type:IEnumerable<BaseShape>
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

GetRequiredColumnNames()

• N/A

• N/A

• Type:Collection<String>
• Description:N/A

DrawSample(GeoCanvas,DrawingRectangleF)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• drawingExtent
  • Type:DrawingRectangleF
  • Description:N/A

DrawSample(GeoCanvas)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

ToString()

• N/A

• N/A

• Type:String
• Description:N/A

Equals(Object)

• N/A

• N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

• N/A

• N/A

• Type:Int32
• Description:N/A

GetType()

• N/A

• N/A

• Type:Type
• Description:N/A

Format(String,BaseShape)

• N/A

• N/A

• Type:String
• Description:N/A

• text
  • Type:String
  • Description:N/A

• labeledShape
  • Type:BaseShape
  • Description:N/A

FormatCore(String,BaseShape)

• N/A

• N/A

• Type:String
• Description:N/A

• text
  • Type:String
  • Description:N/A

• labeledShape
  • Type:BaseShape
  • Description:N/A

OnFormatting(FormattingPositionStyleEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:FormattingPositionStyleEventArgs
  • Description:N/A

OnFormatted(FormattedPositionStyleEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:FormattedPositionStyleEventArgs
  • Description:N/A

DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

• 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.

• Type:Void
• Description:None

• features
  • Type:IEnumerable<Feature>
  • Description:This parameter represents the features you want to draw on the canvas.

• canvas
  • Type:GeoCanvas
  • Description:This parameter represents the canvas you want to draw the features on.

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in the current layer only.

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in all layers.

GetRequiredColumnNamesCore()

• 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.

• Type:Collection<String>
• Description:This method returns a collection of the column names that it needs.

FilterFeatures(IEnumerable<Feature>,GeoCanvas)

• This method filters the features based on the grid size to facilitate deterministic labeling.

• 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.

• Type:Collection<Feature>
• Description:This method returns the features that will be considered for labeling.

• features
  • Type:IEnumerable<Feature>
  • Description:This parameter represents the features that will be filtered.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas that will be used for calculating font sizes.

FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas)

• 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.

• Type:Collection<Feature>
• Description:This method returns the features that will be considered for labeling.

• features
  • Type:IEnumerable<Feature>
  • Description:This parameter represents the features that will be filtered.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas that will be used for calculating font sizes.

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 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.

• Type:Collection<LabelingCandidate>
• Description:A collection of labeling candidates.

• feature
  • Type:Feature
  • Description:This parameter is the feature that will be considered as a labeling candidate.

• canvas
  • Type:GeoCanvas
  • Description: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.

GetLabelingCandidateCore(Feature,GeoCanvas)

• 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 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.

• Type:Collection<LabelingCandidate>
• Description:A collection of labeling candidates.

• feature
  • Type:Feature
  • Description:This parameter is the feature that will be considered as a labeling candidate.

• canvas
  • Type:GeoCanvas
  • Description: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.

CheckDuplicate(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

• 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.

• Type:Boolean
• Description:This method returns whether the label will be suppressed as a duplicate.

• labelingCandidate
  • Type:LabelingCandidate
  • Description:This parameter is the labeling candidate that will be checked to determine if it is a duplicate.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas used for calculations.

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in the current layer only.

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in all layers.

CheckDuplicateCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

• 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.

• Type:Boolean
• Description:This method returns whether the label will be suppressed as a duplicate.

• labelingCandidate
  • Type:LabelingCandidate
  • Description:This parameter is the labeling candidate that will be checked to determine if it is a duplicate.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas that will be used for calculations.

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in the current layer only.

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in all layers.

CheckOverlapping(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

• 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.

• Type:Boolean
• Description:This method returns whether the label will be suppressed because of overlapping.

• labelingCandidate
  • Type:LabelingCandidate
  • Description:This parameter is the labeling candidate that will be checked to determine if it is overlapping.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas that will be used for calculations.

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in the current layer only.

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in all layers.

CheckOverlappingCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

• 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.

• Type:Boolean
• Description:This method returns whether the label will be suppressed because of overlapping.

• labelingCandidate
  • Type:LabelingCandidate
  • Description:This parameter is the labeling candidate that will be checked to determine if it is overlapping.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas that will be used for calculations.

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in the current layer only.

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in all layers.

GetLabelingCandidateForOnePolygon(PolygonShape,String,GeoCanvas)

• N/A

• N/A

• Type:LabelingCandidate
• Description:N/A

• polygon
  • Type:PolygonShape
  • Description:N/A

• text
  • Type:String
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

CloneDeepCore()

• N/A

• N/A

• Type:Style
• Description:N/A

DrawSampleCore(GeoCanvas,DrawingRectangleF)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• drawingExtent
  • Type:DrawingRectangleF
  • Description:N/A

Finalize()

• N/A

• N/A

• Type:Void
• Description:N/A

MemberwiseClone()

• N/A

• N/A

• Type:Object
• Description:N/A

ConvertToWorldCoordinate(PolygonShape,GeoCanvas)

• N/A

• N/A

• Type:Feature
• Description:N/A

• simplyPolygon
  • Type:PolygonShape
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

ConvertToScreenShape(Feature,GeoCanvas)

• This method converts a feature in world coordinates to screen coordinates.

• 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.

• Type:BaseShape
• Description:A screen coordinate shape.

• feature
  • Type:Feature
  • Description:This parameter is the feature to be converted from world coordinates.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas that will be used to convert the world coordinate feature to a screen coorindate feature.

PolygonLabelingLocationMode

• 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.

• Type:PolygonLabelingLocationMode

GridSize

• 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.

• Type:Int32

DuplicateRule

• 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.

• Type:LabelDuplicateRule

OverlappingRule

• 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.

• Type:LabelOverlappingRule

AllowLineCarriage

• 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.

• Type:Boolean

SuppressPartialLabels

• 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.

• Type:Boolean

ForceLineCarriage

• 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.

• Type:Boolean

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.

• None

• Type:Boolean

LabelAllPolygonParts

• 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.

• Type:Boolean

LabelAllLineParts

• 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.

• Type:Boolean

FittingPolygonFactor

• This property gets and sets the factor to which it will keep the label inside of the polygon.

• None

• Type:Double

TextLineSegmentRatio

• 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.

• Type:Double

BestPlacement

• 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.

• Type:Boolean

PointPlacement

• 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.

• Type:PointPlacement

MaskType

• N/A

• N/A

• Type:MaskType

Name

• N/A

• N/A

• Type:String

IsActive

• N/A

• N/A

• Type:Boolean

RequiredColumnNames

• N/A

• N/A

• Type:Collection<String>

Filters

• N/A

• N/A

• Type:Collection<String>

LabelPositions

• Gets a value represents a keyValuepair which is a feature id and label position of the feature

• N/A

• Type:Dictionary<String,WorldLabelingCandidate>

XOffsetInPixel

• 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.

• Type:Single

YOffsetInPixel

• 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.

• Type:Single

CustomTextStyles

• 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.

• Type:Collection<TextStyle>

RotationAngle

• This property gets and sets the rotation angle of the item being positioned.

• None

• Type:Double

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.

• 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.

• Type:Boolean

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.

• 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.

• Type:Boolean

TextFormat

• 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.

• Type:String

NumericFormat

• 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.

• Type:String

DateFormat

• 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.

• Type:String

TextSolidBrush

• 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.

• Type:GeoSolidBrush

Font

• This property gets and sets the font that will be used to draw the text.

• None

• Type:GeoFont

HaloPen

• 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.

• Type:GeoPen

TextColumnName

• 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.

• Type:String

Mask

• 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.

• Type:AreaStyle

MaskMargin

• 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.

• Type:Int32

Advanced

• 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.

• Type:TextStyleAdvanced

AllowSpline

• 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.

• Type:Boolean

ForceHorizontalLabelForLine

• 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.

• Type:Boolean

SplineType

• Gets or sets the SplineType for labeling.

• N/A

• Type:SplineType

DrawingLevel

• Gets or sets the DrawingLavel for this style.

• N/A

• Type:DrawingLevel

IsDefault

• N/A

• N/A

• Type:Boolean

FiltersCore

• N/A

• N/A

• Type:Collection<String>

Formatting

• N/A

• N/A

Event Arguments:FormattingPositionStyleEventArgs

Formatted

• N/A

• N/A

Event Arguments:FormattedPositionStyleEventArgs