This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.core.pointstyle [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.core.pointstyle [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.PointStyle ====== | ====== ThinkGeo.MapSuite.Core.PointStyle ====== | ||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
This class allows you to define how points are drawn on the canvas. | This class allows you to define how points are drawn on the canvas. | ||
- | === Remarks === | ||
- | This class allows you to define how points are drawn on the canvas. There are three main drawing types: bitmap, character, and symbol. The bitmap allows you to represent each point with a bitmap. The character allows you to choose a font and an index in the font so you can use that character for the point. This is especially helpful with fonts like Wingdings that have many feature-style graphics. The symbol type is a collection of simple geometric symbols that we have assembled to represent abstract items on the map. | ||
- | |||
- | When you select a PointType, you need to be sure to set the various properties associated with that type. The property names are prefixed to help you. For example, all of the character-related properties are prefixed with "Character" and the symbol properties follow a similar pattern. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.Core.Style]] | + | *ThinkGeo.MapSuite.Core.Style |
- | ***[[ThinkGeo.MapSuite.Core.PointBaseStyle]] | + | *ThinkGeo.MapSuite.Core.PointBaseStyle |
- | ****[[ThinkGeo.MapSuite.Core.PointStyle]] | + | ***ThinkGeo.MapSuite.Core.PointStyle** |
- | *****[[ThinkGeo.MapSuite.Core.ClusterPointStyle]] | + | *[[ThinkGeo.MapSuite.Core.ClusterPointStyle]] |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} PointStyle() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#PointStyle()|PointStyle]] | | | This is a constructor for the class. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#PointStyle(GeoImage)|PointStyle]] | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | | This is a constructor for the class. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#PointStyle(GeoFont, Int32, GeoSolidBrush)|PointStyle]] | [[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]], Int32, [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | | This is a constructor for the class. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#PointStyle(PointSymbolType, GeoSolidBrush, Int32)|PointStyle]] | [[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]], [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]], Int32 | | This is a constructor for the class. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#PointStyle(PointSymbolType, GeoSolidBrush, GeoPen, Int32)|PointStyle]] | [[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]], [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]], [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]], Int32 | | This is a constructor for the class. | | + | |
- | ==== Protected Constructors ==== | + | * //This is a constructor for the class.// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == 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 Bitmap.// | ||
+ | == 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 ==== | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | Create a copy of style using the deep clone process. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws the features on the canvas you provided. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]] | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws the shapes on the canvas you provided. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas, DrawingRectangleF)|DrawSample]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws a sample feature on the canvas you provided. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas)|DrawSample]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRequiredColumnNames()|GetRequiredColumnNames]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method returns the column data for each feature that is required for the style to properly draw. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Uri)|LoadStyle]] | Uri | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Stream)|LoadStyle]] | Stream | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(String)|SaveStyle]] | String | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(Stream)|SaveStyle]] | Stream | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
- | ==== Protected Methods ==== | + | * //N/A// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | Create a copy of style using the deep clone process. The default implementation method uses serialization. | | + | * //N/A// |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|DrawCore]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden) | This method draws the features on the canvas you provided. | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawSampleCore(GeoCanvas, DrawingRectangleF)|DrawSampleCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden) | This method draws a sample feature on the canvas you provided. | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method returns the column data for each feature that is required for the style to properly draw. | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
- | ==== Public Properties ==== | + | == Return Value == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Advanced|Advanced]] | [[ThinkGeo.MapSuite.Core.PointStyleAdvanced|PointStyleAdvanced]] | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | | | + | * Description:N/A |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CharacterFont|CharacterFont]] | [[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]] | | This property gets and sets the font that is used for the character if the PointType is Character. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CharacterIndex|CharacterIndex]] | Int32 | | This property gets and sets the index position of the character you want to use from the font you selected in the CharacterFont property. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CharacterSolidBrush|CharacterSolidBrush]] | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | | This property gets and sets the SolidBrush used to color the font character for the point. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomPointStyles|CustomPointStyles]] | Collection<[[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]]> | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | This property returns a collection of area styles allowing you to stack multiple area styles on top of each other. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingLevel|DrawingLevel]] | [[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Filters|Filters]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Image|Image]] | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | | This property gets and sets the image used if the PointType property is Bitmap. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#ImageScale|ImageScale]] | Double | | This property gets and sets the scale of the image you want to draw. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#IsActive|IsActive]] | Boolean | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets and sets the active status of the style. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets and set the name of the style. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#PointType|PointType]] | [[ThinkGeo.MapSuite.Core.PointType|PointType]] | | This property gets and sets the type of point you want to draw. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#RequiredColumnNames|RequiredColumnNames]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets the collection of fields that are required for the style. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#RotationAngle|RotationAngle]] | Single | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | This property gets and sets the angle of rotation for the drawing of the point. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolPen|SymbolPen]] | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | This property gets and sets the SolidBrush used to draw the oultine of the Symbol. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolSize|SymbolSize]] | Single | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | This property gets and sets the size of the symbol if the PointType is Symbol. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolSolidBrush|SymbolSolidBrush]] | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | This property gets and sets the SolidBrush used to color the interior of the Symbol. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolType|SymbolType]] | [[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]] | | This property gets and sets the type of symbol you want to use if the PointType is Symbol. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#XOffsetInPixel|XOffsetInPixel]] | Single | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | This property gets and sets the X pixel offset for drawing each feature. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#YOffsetInPixel|YOffsetInPixel]] | Single | [[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]] | This property gets and sets the Y pixel offset for drawing each feature. | | + | |
- | ==== Protected Properties ==== | + | == Parameters == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
- | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#FiltersCore|FiltersCore]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
- | ==== Public Events ==== | + | * //N/A// |
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //N/A// | ||
- | ===== Public Constructors ===== | + | == Return Value == |
- | ==== PointStyle() ==== | + | * Type:Void |
- | This is a constructor for the class. | + | * Description:N/A |
- | === Overloads === | + | |
- | This is the default constructor. If you use this constructor, you should set the various properties manually. | + | |
- | === 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 === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ==== PointStyle(GeoImage) ==== | + | * //features// |
- | This is a constructor for the class. | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
- | === Overloads === | + | * Description:N/A |
- | This constructor is used for bitmap based points. | + | |
- | === Remarks === | + | |
- | If you use this constructor, the PointStyle will be set to Bitmap. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | image | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.Core.GeoImage --> | This parameter is the GeoImage of the image you want to use to display the point. | | + | |
- | [[#Public Constructors|Go Back]] | + | * //canvas// |
- | ==== PointStyle(GeoFont, Int32, GeoSolidBrush) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
- | This is a constructor for the class. | + | * Description:N/A |
- | === Overloads === | + | |
- | This constructor is used for character based points. | + | |
- | === Remarks === | + | |
- | If you use this constructor, the PointStyle will be set to Character. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | characterFont | [[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]]<!-- ThinkGeo.MapSuite.Core.GeoFont --> | This parameter is the font from which the character will be selected. | | + | |
- | | characterIndex | Int32<!-- System.Int32 --> | This parameter is the index of the character in the chosen font. | | + | |
- | | characterSolidBrush | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | This parameter is the SolidBrush used to draw the character. | | + | |
- | [[#Public Constructors|Go Back]] | + | * //labelsInThisLayer// |
- | ==== PointStyle(PointSymbolType, GeoSolidBrush, Int32) ==== | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
- | This is a constructor for the class. | + | * Description:N/A |
- | === Overloads === | + | |
- | This constructor is used for symbol-based points (such as squares and circles) with only a fill. | + | |
- | === Remarks === | + | |
- | If you use this constructor, the PointStyle will be set to Symbol. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | symbolType | [[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]]<!-- ThinkGeo.MapSuite.Core.PointSymbolType --> | This parameter is the type of symbol you want to use, such as a square or a circle. | | + | |
- | | symbolSolidBrush | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | This parameter is the SolidBrush you want to use to fill the inside of the symbol. | | + | |
- | | symbolSize | Int32<!-- System.Int32 --> | This parameter is the size you want the symbol to be. | | + | |
- | [[#Public Constructors|Go Back]] | + | * //labelsInAllLayers// |
- | ==== PointStyle(PointSymbolType, GeoSolidBrush, GeoPen, Int32) ==== | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
- | This is a constructor for the class. | + | * Description:N/A |
- | === Overloads === | + | |
- | This constructor is used for symbol-based points (such as squares and circles) with a fill and outline. | + | |
- | === Remarks === | + | |
- | If you use this constructor, the PointStyle will be set to Symbol. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | symbolType | [[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]]<!-- ThinkGeo.MapSuite.Core.PointSymbolType --> | This parameter is the type of symbol you want to use, such as a square or a circle. | | + | |
- | | symbolSolidBrush | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | This parameter is the SolidBrush you want to use to fill the inside of the symbol. | | + | |
- | | symbolPen | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen --> | This parameter is the Pen used to draw the outline of the symbol. | | + | |
- | | symbolSize | Int32<!-- System.Int32 --> | This parameter is the size you want the symbol to be. | | + | |
- | [[#Public Constructors|Go Back]] | + | <div newline></div> |
- | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
- | ===== Public Methods ===== | + | |
- | ==== CloneDeep() ==== | + | |
- | Create a copy of style using the deep clone process. | + | |
- | === Remarks === | + | |
- | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | A cloned style. | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | + | * Description:N/A |
- | This method draws the features on the canvas you provided. | + | |
- | === Remarks === | + | |
- | This method is the concrete wrapper for the abstract method DrawCore. 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. | + | |
- | 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. | + | == Parameters == |
- | === Return Value === | + | * //shapes// |
- | ^ Return Type ^ Description ^ | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> |
- | | Void<!-- System.Void --> | | | + | * Description:N/A |
- | === Parameters === | + | * //canvas// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
- | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | This parameter represents the features you want to draw on the canvas. | | + | * Description:N/A |
- | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | + | |
- | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | + | |
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //labelsInThisLayer// |
- | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
- | ==== Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | + | * Description:N/A |
- | This method draws the shapes on the canvas you provided. | + | |
- | === Remarks === | + | |
- | This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the shapes you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each shape differently. | + | |
- | 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. | + | * //labelsInAllLayers// |
- | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
- | ^ Return Type ^ Description ^ | + | * Description:N/A |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** |
- | | shapes | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.BaseShape} --> | This parameter represents the shapes you want to draw on the canvas. | | + | |
- | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the shapes on. | | + | |
- | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | + | |
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== DrawSample(GeoCanvas, DrawingRectangleF) ==== | + | * //N/A// |
- | This method draws a sample feature on the canvas you provided. | + | |
- | === Remarks === | + | |
- | This method is the concrete wrapper for the abstract method DrawSampleCore. 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. | + | |
- | 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 == |
- | === Return Value === | + | * Type:Collection<String> |
- | ^ Return Type ^ Description ^ | + | * Description:N/A |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
- | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** |
- | | drawingExtent | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF --> | | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== DrawSample(GeoCanvas) ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
- | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | + | * Description:N/A |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //canvas// |
- | ==== Equals(Object) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
- | === Return Value === | + | * Description:N/A |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | | | + | |
- | === Parameters === | + | * //drawingExtent// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
- | | obj | Object<!-- System.Object --> | | | + | * Description:N/A |
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** |
- | ==== GetHashCode() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Int32<!-- System.Int32 --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== GetRequiredColumnNames() ==== | + | * Description:N/A |
- | This method returns the column data for each feature that is required for the style to properly draw. | + | |
- | === Remarks === | + | |
- | This method is the concrete wrapper for the abstract method GetRequiredColumnNamesCore. 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. | + | == Parameters == |
+ | * //canvas// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
+ | * Description:N/A | ||
- | 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. | + | <div newline></div> |
- | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** |
- | ^ Return Type ^ Description ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of column names that the style needs. | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== GetType() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Type<!-- System.Type --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //filePathName// |
+ | * Type:String | ||
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** |
- | ==== LoadStyle(Uri) ==== | + | |
- | <!-- static --> | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | styleUri | Uri<!-- System.Uri --> | | | + | * //N/A// |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== LoadStyle(Stream) ==== | + | * Description:N/A |
- | <!-- static --> | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //stream// |
- | | styleStream | Stream<!-- System.IO.Stream --> | | | + | * Type:Stream |
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | ==== SaveStyle(String) ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | filePathName | String<!-- System.String --> | | | + | * //N/A// |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:String |
- | ==== SaveStyle(Stream) ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
- | | stream | Stream<!-- System.IO.Stream --> | | | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== ToString() ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //obj// |
- | ===== Protected Methods ===== | + | * Type:Object |
- | ==== CloneDeepCore() ==== | + | * Description:N/A |
- | Create a copy of style using the deep clone process. The default implementation method uses serialization. | + | |
- | === Remarks === | + | |
- | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | A cloned style. | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //N/A// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | + | * //N/A// |
- | 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 == |
- | === Return Value === | + | * Type:Int32 |
- | ^ Return Type ^ Description ^ | + | * Description:N/A |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
- | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | This parameter represents the features you want to draw on the canvas. | | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | + | |
- | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | + | |
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | + | * //N/A// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== DrawSampleCore(GeoCanvas, DrawingRectangleF) ==== | + | * //N/A// |
- | 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 == |
- | === Return Value === | + | * Type:Type |
- | ^ Return Type ^ Description ^ | + | * Description:N/A |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
- | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | + | ==== Protected Methods ==== |
- | | drawingExtent | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF --> | | | + | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
- | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | + | * //This method draws the features on the canvas you provided.// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== Finalize() ==== | + | * //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 === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
+ | * Description:None | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | * //features// |
- | ==== GetRequiredColumnNamesCore() ==== | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
- | This method returns the column data for each feature that is required for the style to properly draw. | + | * Description:This parameter represents the features you want to draw on the canvas. |
- | === 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. | + | * //canvas// |
- | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
- | ^ Return Type ^ Description ^ | + | * Description:This parameter represents the canvas you want to draw the features on. |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of column names that the style needs. | | + | |
- | === Parameters === | + | * //labelsInThisLayer// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
+ | * Description:The labels will be drawn in the current layer only. | ||
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //labelsInAllLayers// |
- | [[#Protected Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
- | ==== MemberwiseClone() ==== | + | * Description:The labels will be drawn in all layers. |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** |
- | <!-- System.Object --> | + | * //This method draws a sample feature on the canvas you provided.// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ===== Public Properties ===== | + | * //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.// |
- | ==== Advanced ==== | + | |
- | === Return Value === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:Void |
- | | [[ThinkGeo.MapSuite.Core.PointStyleAdvanced|PointStyleAdvanced]]<!-- ThinkGeo.MapSuite.Core.PointStyleAdvanced --> | | + | * 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 Bitmap. | ||
+ | == 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 == | ||
+ | * 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 ** | ||
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== CharacterFont ==== | ||
This property gets and sets the font that is used for the character if the PointType is Character. | This property gets and sets the font that is used for the character if the PointType is Character. | ||
- | === Remarks === | + | == Remarks == |
This property allows you to set the font from which to select a character index if you choose the Character PointType. | This property allows you to set the font from which to select a character index if you choose the Character PointType. | ||
- | === Return Value === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]] |
- | | [[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]]<!-- ThinkGeo.MapSuite.Core.GeoFont --> | | + | |
+ | ** {{wiki:PublicProperty.gif|}} CharacterIndex ** | ||
- | <!-- ThinkGeo.MapSuite.Core.PointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== 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. | 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 === | + | == 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. | 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 === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:Int32 |
- | | Int32<!-- System.Int32 --> | | + | |
+ | ** {{wiki:PublicProperty.gif|}} CharacterSolidBrush ** | ||
- | <!-- ThinkGeo.MapSuite.Core.PointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== CharacterSolidBrush ==== | ||
This property gets and sets the SolidBrush used to color the font character for the point. | This property gets and sets the SolidBrush used to color the font character for the point. | ||
- | === Remarks === | + | == 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. | 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 === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
- | | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointStyle --> | + | ** {{wiki:PublicProperty.gif|}} SymbolType ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== CustomPointStyles ==== | + | |
- | This property returns a collection of area styles allowing you to stack multiple area styles on top of each other. | + | |
- | === Remarks === | + | |
- | Using this collection, you can stack multiple styles on top of each other. When we draw the feature, we will draw them in order that they exist in the collection. You can use these stacks to create drop shadow effects, multiple colored outlines, etc. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Collection<[[ThinkGeo.MapSuite.Core.PointBaseStyle|PointBaseStyle]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.PointBaseStyle} --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | This property gets and sets the type of symbol you want to use if the PointType is Symbol. |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== DrawingLevel ==== | + | 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 === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]] |
- | | [[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]<!-- ThinkGeo.MapSuite.Core.DrawingLevel --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | ** {{wiki:PublicProperty.gif|}} Mask ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== Filters ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== Image ==== | + | N/A |
- | This property gets and sets the image used if the PointType property is Bitmap. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] |
- | 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 === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.Core.GeoImage --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointStyle --> | + | ** {{wiki:PublicProperty.gif|}} Advanced ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== 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 === | + | |
- | ^ Return Type ^ | + | |
- | | Double<!-- System.Double --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointStyle --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== IsActive ==== | + | N/A |
- | This property gets and sets the active status of the style. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.PointStyleAdvanced|PointStyleAdvanced]] |
- | If the style is not active then it will not draw. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Boolean<!-- System.Boolean --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | ** {{wiki:PublicProperty.gif|}} DrawingLevel ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== Name ==== | + | |
- | This property gets and set the name of the style. | + | |
- | === Remarks === | + | |
- | This name is not used by the system; it is only for the developer. However, it can be used if you generate your own legend. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== PointType ==== | + | N/A |
- | This property gets and sets the type of point you want to draw. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] |
- | 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 === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.PointType|PointType]]<!-- ThinkGeo.MapSuite.Core.PointType --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointStyle --> | + | ** {{wiki:PublicProperty.gif|}} SymbolSolidBrush ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== RequiredColumnNames ==== | + | |
- | This property gets the collection of fields that are required for the style. | + | |
- | === Remarks === | + | |
- | This property gets the collection of fields that are required for the style. These are in addition to any other columns you specify in styles that inherit from this one. For example, if you have use a ValueStyle and it requires a column name for the value comparison, then that column does not need to be in this collection. You only use the RequiredColumnNames for columns you need beyond those required by specific inherited styles. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== RotationAngle ==== | + | N/A |
- | This property gets and sets the angle of rotation for the drawing of the point. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
- | This property controls the rotation of the bitmap, character or symbol, depending on the PointType. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Single<!-- System.Single --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | ** {{wiki:PublicProperty.gif|}} SymbolPen ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== SymbolPen ==== | + | |
- | This property gets and sets the SolidBrush used to draw the oultine of the Symbol. | + | |
- | === Remarks === | + | |
- | This pen is used to draw the outline of the Symbol. By default the pen draws a transparent (invisible) color, which just leaves you with a fill. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== SymbolSize ==== | + | N/A |
- | This property gets and sets the size of the symbol if the PointType is Symbol. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] |
- | The allows you to make the symbol larger and smaller. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Single<!-- System.Single --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | ** {{wiki:PublicProperty.gif|}} SymbolSize ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== SymbolSolidBrush ==== | + | |
- | This property gets and sets the SolidBrush used to color the interior of the Symbol. | + | |
- | === Remarks === | + | |
- | This brush is used to draw the interior of the symbol. It is only used if the PointType is Symbol. If you need a brush other than the SolidBrush, you should look in the advanced property of the class. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== SymbolType ==== | + | N/A |
- | This property gets and sets the type of symbol you want to use if the PointType is Symbol. | + | == Return Value == |
- | === Remarks === | + | * Type:Single |
- | 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 === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.PointSymbolType|PointSymbolType]]<!-- ThinkGeo.MapSuite.Core.PointSymbolType --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointStyle --> | + | ** {{wiki:PublicProperty.gif|}} RotationAngle ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== XOffsetInPixel ==== | + | |
- | This property gets and sets the X pixel offset for drawing each feature. | + | |
- | === 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 === | + | |
- | ^ Return Type ^ | + | |
- | | Single<!-- System.Single --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | N/A |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== YOffsetInPixel ==== | + | N/A |
- | This property gets and sets the Y pixel offset for drawing each feature. | + | == Return Value == |
- | === Remarks === | + | * Type:Single |
- | 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 === | + | |
- | ^ Return Type ^ | + | |
- | | Single<!-- System.Single --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.PointBaseStyle --> | + | ** {{wiki:PublicProperty.gif|}} XOffsetInPixel ** |
- | [[#Public Properties|Go Back]] | + | |
- | ===== Protected Properties ===== | + | |
- | ==== FiltersCore ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.Style --> | + | N/A |
- | [[#Protected Properties|Go Back]] | + | == Remarks == |
- | ===== Public Events ===== | + | N/A |
- | __NOTOC__ | + | == Return Value == |
- | [[Category:MapSuiteCore]] | + | * Type:Single |
- | [[Category:ThinkGeo.MapSuite.Core]] | + | |
- | [[Category:UpdateDocumentation]] | + | ** {{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|}} IsDefault ** | ||
+ | |||
+ | 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 ==== | ||