User Tools

Site Tools


api:thinkgeo.mapsuite.styles.iconvaluestyle

ThinkGeo.MapSuite.Styles.IconValueStyle

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Styles.Style
      • ThinkGeo.MapSuite.Styles.PositionStyle
        • ThinkGeo.MapSuite.Styles.IconValueStyle

Members Summary

Public Constructors

IconValueStyle()

  • This is the constructor for the class.
Remarks
  • If you use this constructor, then you need to set the required properties manually.
Parameters

IconValueStyle(String)

  • This is the constructor for the class.
Remarks
  • None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column name you want to match on.

IconValueStyle(String,IEnumerable<IconValueItem>)

  • This is the constructor for the class.
Remarks
  • None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column name you want to match on.
  • iconValueItems
    • Type:IEnumerable<IconValueItem>
    • Description:This parameter is the icon value items you want to match on.

Protected Constructors

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

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

GetType()

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

Protected Methods

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 canvas you provided. Each style (based on its properties) may draw each feature differently. When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
Return Value
  • Type:Void
  • Description:None
Parameters
  • 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()

  • 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

GetLabelingCandidateCore(Feature,GeoCanvas)

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

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

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

FilterFeatures(IEnumerable<Feature>,GeoCanvas)

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

FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas)

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

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

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

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

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

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

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

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

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

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

GetLabelingCandidateForOnePolygon(PolygonShape,String,GeoCanvas)

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

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

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

Finalize()

  • 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

Public Properties

ColumnName

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

IconValueItems

  • N/A
Remarks
  • You should create your IconValueItems and place them in this collection for consideration.
Return Value

PolygonLabelingLocationMode

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

DuplicateRule

  • N/A
Remarks
  • N/A
Return Value

OverlappingRule

  • N/A
Remarks
  • N/A
Return Value

AllowLineCarriage

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

SuppressPartialLabels

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

ForceLineCarriage

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

FittingPolygon

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

LabelAllPolygonParts

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

LabelAllLineParts

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

FittingPolygonFactor

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

TextLineSegmentRatio

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

BestPlacement

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

PointPlacement

  • N/A
Remarks
  • N/A
Return Value

IsDefault

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

MaskType

  • N/A
Remarks
  • N/A
Return Value

Name

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

StyleClass

  • 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

IsStyleDefault

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

LabelPositions

  • N/A
Remarks
  • N/A
Return Value

XOffsetInPixel

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

YOffsetInPixel

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

CustomTextStyles

  • N/A
Remarks
  • N/A
Return Value

RotationAngle

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

FittingLineInScreen

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

FittingPolygonInScreen

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

TextFormat

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

NumericFormat

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

DateFormat

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

TextSolidBrush

  • N/A
Remarks
  • N/A
Return Value

Font

  • N/A
Remarks
  • N/A
Return Value

HaloPen

  • N/A
Remarks
  • N/A
Return Value

TextColumnName

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

Mask

  • N/A
Remarks
  • N/A
Return Value

MaskMargin

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

Advanced

  • N/A
Remarks
  • N/A
Return Value

AllowSpline

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

ForceHorizontalLabelForLine

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

SplineType

  • N/A
Remarks
  • N/A
Return Value

DrawingLevel

  • N/A
Remarks
  • N/A
Return Value

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

api/thinkgeo.mapsuite.styles.iconvaluestyle.txt · Last modified: 2017/01/11 06:53 (external edit)