User Tools

Site Tools


12.0:apis:thinkgeo.core.positionstyle

ThinkGeo.Core.PositionStyle

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

PositionStyle()

  • This is the default constructor for the class.
Remarks
  • None
Parameters

Public Methods

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Style
  • Description:N/A
Parameters

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapes
    • Type:IEnumerable<BaseShape>
    • Description:N/A

GetRequiredColumnNames()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters

DrawSample(GeoCanvas,DrawingRectangleF)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawSample(GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

SaveStyle(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • filePathName
    • Type:String
    • Description:N/A

SaveStyle(Stream)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • stream
    • Type:Stream
    • Description:N/A

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

Protected Methods

Format(String,BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • text
    • Type:String
    • Description:N/A
  • labeledShape

FormatCore(String,BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • text
    • Type:String
    • Description:N/A
  • labeledShape

OnFormatting(FormattingPositionStyleEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnFormatted(FormattedPositionStyleEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

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

  • N/A
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 view 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
  • Type:Void
  • Description:None
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter represents the features you want to draw on the view.
  • canvas
    • Type:GeoCanvas
    • Description:This parameter represents the view 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()

  • N/A
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.
Return Value
  • Type:Collection<String>
  • Description:This method returns a collection of the column names that it needs.
Parameters

FilterFeatures(IEnumerable<Feature>,GeoCanvas)

  • N/A
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.
Return Value
  • Type:Collection<Feature>
  • Description:This method returns the features that will be considered for labeling.
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter represents the features that will be filtered.
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the view that will be used for calculating font sizes.

FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas)

  • N/A
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.
Return Value
  • Type:Collection<Feature>
  • Description:This method returns the features that will be considered for labeling.
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter represents the features that will be filtered.
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the view that will be used for calculating font sizes.

AbbreviateText(Feature,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • feature

AbbreviateTextCore(Feature,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • feature

GetLabelingCandidates(Feature,GeoCanvas)

  • N/A
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.
Return Value
  • Type:Collection<LabelingCandidate>
  • Description:A collection of labeling candidates.
Parameters
  • 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 view that will be used to draw the feature. This method will not draw on this view, but rather will use it to determine font size, etc.

GetLabelingCandidateCore(Feature,GeoCanvas)

  • N/A
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.
Return Value
  • Type:Collection<LabelingCandidate>
  • Description:A collection of labeling candidates.
Parameters
  • 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 view that will be used to draw the feature. This method will not draw on this view, but rather will use it to determine font size, etc.

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

  • N/A
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.
Return Value
  • Type:Boolean
  • Description:This method returns whether the label will be suppressed as a duplicate.
Parameters
  • 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 view 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>)

  • N/A
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.
Return Value
  • Type:Boolean
  • Description:This method returns whether the label will be suppressed as a duplicate.
Parameters
  • 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 view 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>)

  • N/A
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.
Return Value
  • Type:Boolean
  • Description:This method returns whether the label will be suppressed because of overlapping.
Parameters
  • 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 view 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>)

  • N/A
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.
Return Value
  • Type:Boolean
  • Description:This method returns whether the label will be suppressed because of overlapping.
Parameters
  • 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 view 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
Remarks
  • N/A
Return Value
Parameters
  • text
    • Type:String
    • Description:N/A

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Style
  • Description:N/A
Parameters

DrawSampleCore(GeoCanvas,DrawingRectangleF)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ConvertToScreenShape(Feature,GeoCanvas)

  • N/A
Remarks
  • This overridden method can be called by this class and its sub concrete classes. In this method, we take the view and the feature in world coordinates and convert it to screen coordinates.
Return Value
  • Type:BaseShape
  • Description:A screen coordinate shape.
Parameters
  • feature
    • Type:Feature
    • Description:This parameter is the feature to be converted from world coordinates.
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the view that will be used to convert the world coordinate feature to a screen coorindate feature.

Public Properties

PolygonLabelingLocationMode

  • N/A
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.
Return Value

MaxNudgingInPixel

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

NudgingIntervalInPixel

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

BestPlacementSymbolWidth

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

BestPlacementSymbolHeight

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

AbbreviationDictionary

  • N/A
Remarks
  • N/A
Return Value
  • Type:Dictionary<String,String>

LeaderLineStyle

  • N/A
Remarks
  • N/A
Return Value

LeaderLineRule

  • N/A
Remarks
  • N/A
Return Value

LeaderLineMinimumLengthInPixels

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

GridSize

  • N/A
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.
Return Value
  • Type:Int32

DuplicateRule

  • N/A
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.
Return Value

OverlappingRule

  • N/A
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.
Return Value

AllowLineCarriage

  • N/A
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.
Return Value
  • Type:Boolean

SuppressPartialLabels

  • N/A
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.
Return Value
  • Type:Boolean

ForceLineCarriage

  • N/A
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.
Return Value
  • Type:Boolean

FittingPolygon

  • N/A
Remarks
  • None
Return Value
  • Type:Boolean

LabelAllPolygonParts

  • N/A
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.
Return Value
  • Type:Boolean

LabelAllLineParts

  • N/A
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.
Return Value
  • Type:Boolean

FittingPolygonFactor

  • N/A
Remarks
  • None
Return Value
  • Type:Double

TextLineSegmentRatio

  • N/A
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.
Return Value
  • Type:Double

TextPlacement

  • N/A
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.
Return Value

MaskType

  • N/A
Remarks
  • N/A
Return Value

Name

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

IsActive

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

RequiredColumnNames

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Filters

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Protected Properties

LabelPositions

  • N/A
Remarks
  • N/A
Return Value

XOffsetInPixel

  • N/A
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.
Return Value
  • Type:Single

YOffsetInPixel

  • N/A
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.
Return Value
  • Type:Single

CustomTextStyles

  • N/A
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.
Return Value

RotationAngle

  • N/A
Remarks
  • None
Return Value
  • Type:Double

FittingLineInScreen

  • N/A
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.
Return Value
  • Type:Boolean

FittingPolygonInScreen

  • N/A
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.
Return Value
  • Type:Boolean

TextFormat

  • N/A
Remarks
  • With this property, you can apply formats to the text that is retrieved from the feature.
Return Value
  • Type:String

NumericFormat

  • N/A
Remarks
  • With this property, you can apply formats to the text that is retrieved from the feature.
Return Value
  • Type:String

DateFormat

  • N/A
Remarks
  • With this property, you can apply formats to the text that is retrieved from the feature.
Return Value
  • Type:String

TextBrush

  • N/A
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.
Return Value

Font

  • N/A
Remarks
  • None
Return Value

HaloPen

  • N/A
Remarks
  • The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background.
Return Value

TextColumnName

  • N/A
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.
Return Value
  • Type:String

Mask

  • N/A
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.
Return Value

MaskMargin

  • N/A
Remarks
  • This determines how much larger the mask is than the text, in pixels.
Return Value

AllowSpline

  • N/A
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.
Return Value
  • Type:Boolean

ForceHorizontalLabelForLine

  • N/A
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.
Return Value
  • Type:Boolean

SplineType

  • N/A
Remarks
  • N/A
Return Value

DrawingLevel

  • N/A
Remarks
  • N/A
Return Value

IsDefault

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Alignment

  • N/A
Remarks
  • N/A
Return Value

LetterCase

  • N/A
Remarks
  • N/A
Return Value

MaxCharAngleDelta

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

MinDistance

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

Spacing

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

WrapWidth

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

BasePoint

  • N/A
Remarks
  • N/A
Return Value

TextContent

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

TextLetterSpacing

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

TextBaseline

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

FiltersCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Public Events

Formatting

  • N/A
Remarks
  • N/A

Event Arguments:FormattingPositionStyleEventArgs

Formatted

  • N/A
Remarks
  • N/A

Event Arguments:FormattedPositionStyleEventArgs

12.0/apis/thinkgeo.core.positionstyle.txt · Last modified: 2019/09/26 09:43 (external edit)