ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.PointStyle ======
This class allows you to define how points are drawn on the canvas.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.Core.Style
      *ThinkGeo.MapSuite.Core.PointBaseStyle
        ***ThinkGeo.MapSuite.Core.PointStyle**
          *[[ThinkGeo.MapSuite.Core.ClusterPointStyle]]
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} 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 ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} PointStyle(GeoImage) **

This is a constructor for the class.
== Remarks ==
If you use this constructor, the PointStyle will be set to NativeImage.
== Parameters ==
  * //image//
    * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
    * Description:This parameter is the GeoImage of the image you want to use to display the point.

<div newline></div>
** {{wiki:PublicMethod.gif|}} 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:[[ThinkGeo.MapSuite.Core.GeoFont|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//
    * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]
    * Description:This parameter is the SolidBrush used to draw the character.

<div newline></div>
** {{wiki:PublicMethod.gif|}} 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//
    * Type:[[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]]
    * Description:This parameter is the type of symbol you want to use, such as a square or a circle.

  * //symbolSolidBrush//
    * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]
    * 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.

<div newline></div>
** {{wiki:PublicMethod.gif|}} 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//
    * Type:[[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]]
    * Description:This parameter is the type of symbol you want to use, such as a square or a circle.

  * //symbolSolidBrush//
    * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]
    * Description:This parameter is the SolidBrush you want to use to fill the inside of the symbol.

  * //symbolPen//
    * Type:[[ThinkGeo.MapSuite.Core.GeoPen|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.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} CloneDeep() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //features//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //shapes//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //drawingExtent//
    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

This method draws the features on the canvas you provided.
== 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<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:This parameter represents the features you want to draw on the canvas.

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:This parameter represents the canvas you want to draw the features on.

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in the current layer only.

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in all layers.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) **

This method draws a sample feature on the canvas you provided.
== 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:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:This parameter represents the canvas you want to draw the features on.

  * //drawingExtent//
    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} PointType **

This property gets and sets the type of point you want to draw.
== 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 ==
  * Type:[[ThinkGeo.MapSuite.Core.PointType|PointType]]

** {{wiki:PublicProperty.gif|}} Image **

This property gets and sets the image used if the PointType property is NativeImage.
== Remarks ==
This property is where you can set the image for the points if the PointType is NativeImage. It uses a GeoImage, so you can either reference a file or supply a stream.
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]

** {{wiki:PublicProperty.gif|}} ImageScale **

This property gets and sets the scale of the image you want to draw.
== 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

** {{wiki:PublicProperty.gif|}} CharacterFont **

This property gets and sets the font that is used for the character if the PointType is Character.
== Remarks ==
This property allows you to set the font from which to select a character index if you choose the Character PointType.
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]]

** {{wiki:PublicProperty.gif|}} CharacterIndex **

This property gets and sets the index position of the character you want to use from the font you selected in the CharacterFont property.
== 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

** {{wiki:PublicProperty.gif|}} CharacterSolidBrush **

This property gets and sets the SolidBrush used to color the font character for the point.
== 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 ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]

** {{wiki:PublicProperty.gif|}} SymbolType **

This property gets and sets the type of symbol you want to use if the PointType is Symbol.
== 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 ==
  * Type:[[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]]

** {{wiki:PublicProperty.gif|}} Advanced **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.PointStyleAdvanced|PointStyleAdvanced]]

** {{wiki:PublicProperty.gif|}} DrawingLevel **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]

** {{wiki:PublicProperty.gif|}} SymbolSolidBrush **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]

** {{wiki:PublicProperty.gif|}} SymbolPen **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]

** {{wiki:PublicProperty.gif|}} SymbolSize **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} RotationAngle **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} XOffsetInPixel **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} YOffsetInPixel **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} CustomPointStyles **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]]>

** {{wiki:PublicProperty.gif|}} Name **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} IsActive **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} RequiredColumnNames **

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

** {{wiki:PublicProperty.gif|}} Filters **

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

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} e2U= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:ProtectedProperty.gif|}} FiltersCore **

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

==== Public Events ====
User Tools

Site Tools

Page Tools
