User Tools

Site Tools


api:thinkgeo.mapsuite.styles.pointstyle

ThinkGeo.MapSuite.Styles.PointStyle

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Styles.Style
      • ThinkGeo.MapSuite.Styles.PointBaseStyle
        • ThinkGeo.MapSuite.Styles.PointStyle

Members Summary

Public Constructors

PointStyle()

  • This is a constructor for the class.
Remarks
  • If you use this constructor, you should set the various properties manually. Specifically, you will want to set the PointType, which allows you to choose between bitmap, character and symbol as an option for displaying your points.
Parameters

PointStyle(GeoImage)

  • This is a constructor for the class.
Remarks
  • If you use this constructor, the PointStyle will be set to Bitmap.
Parameters
  • image
    • Type:GeoImage
    • Description:This parameter is the GeoImage of the image you want to use to display the point.

PointStyle(GeoFont,Int32,GeoSolidBrush)

  • This is a constructor for the class.
Remarks
  • If you use this constructor, the PointStyle will be set to Character.
Parameters
  • characterFont
    • Type:GeoFont
    • Description:This parameter is the font from which the character will be selected.
  • characterIndex
    • Type:Int32
    • Description:This parameter is the index of the character in the chosen font.
  • characterSolidBrush
    • Description:This parameter is the SolidBrush used to draw the character.

PointStyle(PointSymbolType,GeoSolidBrush,Int32)

  • This is a constructor for the class.
Remarks
  • If you use this constructor, the PointStyle will be set to Symbol.
Parameters
  • symbolType
    • Description:This parameter is the type of symbol you want to use, such as a square or a circle.
  • symbolSolidBrush
    • Description:This parameter is the SolidBrush you want to use to fill the inside of the symbol.
  • symbolSize
    • Type:Int32
    • Description:This parameter is the size you want the symbol to be.

PointStyle(PointSymbolType,GeoSolidBrush,GeoPen,Int32)

  • This is a constructor for the class.
Remarks
  • If you use this constructor, the PointStyle will be set to Symbol.
Parameters
  • symbolType
    • Description:This parameter is the type of symbol you want to use, such as a square or a circle.
  • symbolSolidBrush
    • Description:This parameter is the SolidBrush you want to use to fill the inside of the symbol.
  • symbolPen
    • Type:GeoPen
    • Description:This parameter is the Pen used to draw the outline of the symbol.
  • symbolSize
    • Type:Int32
    • Description:This parameter is the size you want the symbol to be.

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.

DrawSampleCore(GeoCanvas,DrawingRectangleF)

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

CloneDeepCore()

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

GetRequiredColumnNamesCore()

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

PointType

  • N/A
Remarks
  • When using the PointStyle you choose between a bitmap, a font or a predefined symbol to represent the point. Each of these options has corresponding properties on the point symbol. If you set the type to character, then you need to set the properties that start with “Character,” such as “CharacterFont.” The same is true for the symbol.
Return Value

Image

  • N/A
Remarks
  • This property is where you can set the image for the points if the PointType is Bitmap. It uses a GeoImage, so you can either reference a file or supply a stream.
Return Value

ImageScale

  • N/A
Remarks
  • This property allows you to scale the image up and down depending on how large or small you want it. It can be changed dynamically, so you could change it at every scale level to resize the bitmap based on the current scale. A scale of 1 would be the original size, while a scale of 2 would double the size. A scale of .5 would reduce the size of the image by half, and so on.
Return Value
  • Type:Double

CharacterFont

  • N/A
Remarks
  • This property allows you to set the font from which to select a character index if you choose the Character PointType.
Return Value

CharacterIndex

  • N/A
Remarks
  • You need to specify the index position of the character you want to use from the font you selected. For example, if you choose 1, then we will use the first character in the font you set in the CharacterFont property.
Return Value
  • Type:Int32

CharacterSolidBrush

  • N/A
Remarks
  • This brush is used to draw the character. It is only used if the PointType is Character. If you need a brush other than the SolidBrush, you should look in the advanced property of the class.
Return Value

SymbolType

  • N/A
Remarks
  • You can choose between a number of predefined symbols. The symbols are simple geometric objects that are typically used for abstract representations on a map. If there is a specific symbol you need that is not part of our symbol collection, you can submit it to us and we will consider adding it.
Return Value

Mask

  • N/A
Remarks
  • N/A
Return Value

MaskMargin

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

MaskType

  • N/A
Remarks
  • N/A
Return Value

IsDefault

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

Advanced

  • N/A
Remarks
  • N/A
Return Value

DrawingLevel

  • N/A
Remarks
  • N/A
Return Value

SymbolSolidBrush

  • N/A
Remarks
  • N/A
Return Value

SymbolPen

  • N/A
Remarks
  • N/A
Return Value

SymbolSize

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

RotationAngle

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

XOffsetInPixel

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

YOffsetInPixel

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

CustomPointStyles

  • 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

FiltersCore

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

Public Events

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