Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.portablecore.style [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.portablecore.style [2015/09/23 01:41]
admin
@@ Line 1: / Line 1: @@
-====== ThinkGeo.MapSuite.PortableCore.Style ======
+====== ThinkGeo.MapSuite.Core.Style ======
-<!-- Class -->
 This abstract class is the root for all styles used for drawing features.
-=== Remarks ===
-If you need to create your own style in the future, we suggest that you first consider extending an existing style. If you are doing something new, then you can inherit from this class.
-The key method to override is DrawCore. If you want to provide a sample for the legend, you will also want to extend the DrawSampleCore.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.PortableCore.Style]]
+    ***ThinkGeo.MapSuite.Core.Style**
-***[[ThinkGeo.MapSuite.PortableCore.AreaStyle]]
+      *[[ThinkGeo.MapSuite.Core.LineStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.ClassBreakStyle]]
+      *[[ThinkGeo.MapSuite.Core.PointBaseStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.ClusterPointStyle]]
+      *[[ThinkGeo.MapSuite.Core.AreaStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.CompositeStyle]]
+      *[[ThinkGeo.MapSuite.Core.ClassBreakStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.DotDensityStyle]]
+      *[[ThinkGeo.MapSuite.Core.DotDensityStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.FilterStyle]]
+      *[[ThinkGeo.MapSuite.Core.CompositeStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.GradientStyle]]
+      *[[ThinkGeo.MapSuite.Core.FilterStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.HeatStyle]]
+      *[[ThinkGeo.MapSuite.Core.GradientStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.HueFamilyAreaStyle]]
+      *[[ThinkGeo.MapSuite.Core.HeatStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.IconStyle]]
+      *[[ThinkGeo.MapSuite.Core.PositionStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.IconValueStyle]]
+      *[[ThinkGeo.MapSuite.Core.RegexStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.LineStyle]]
+      *[[ThinkGeo.MapSuite.Core.ValueStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.NoaaWeatherStationStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.NoaaWeatherWarningsStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.PointBaseStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.PointStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.PositionStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.QualityFamilyAreaStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.RegexStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.TextStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.ValueStyle]]
-***[[ThinkGeo.MapSuite.PortableCore.WellPointStyle]]
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
 ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:ProtectedMethod.gif|}} Style() **
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Style()|Style]]   |    |    | This is the default constructor for the style and should be called by inherited classes.   |
+  * //This is the default constructor for the style and should be called by inherited classes.//
+== Remarks ==
+  * //This is the default constructor for the style and should be called by inherited classes.//
+== Parameters ==
+<div newline></div>
 ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} CloneDeep() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]]   |    |    | 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.PortableCore.Feature|Feature]]>, [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>   |    | 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.PortableCore.BaseShape|BaseShape]]>, [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>   |    | This method draws the shapes on the canvas you provided.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas, DrawingRectangleF)|DrawSample]]   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]   |    | This method draws a sample feature on the canvas you provided.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas)|DrawSample]]   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]   |    |    |
-| {{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]]   |    |    | 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}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //Create a copy of style using the deep clone process.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]]   |    |    | Create a copy of style using the deep clone process. The default implementation method uses serialization.   |
+  * //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.//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|DrawCore]]   | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]>, [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>   |    | This method draws the features on the canvas you provided.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawSampleCore(GeoCanvas, DrawingRectangleF)|DrawSampleCore]]   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]   |    | 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]]   |    |    | 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}}[[#Filters|Filters]]   | Collection<String>   |    |    |
+  * Description:A cloned style.
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsActive|IsActive]]   | Boolean   |    | This property gets and sets the active status of the style.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   |    | This property gets and set the name of the style.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#RequiredColumnNames|RequiredColumnNames]]   | Collection<String>   |    | This property gets the collection of fields that are required for the style.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+<div newline></div>
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#FiltersCore|FiltersCore]]   | Collection<String>   |    |    |
+** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-==== Public Events ====
+  * //This method draws the features on the canvas you provided.//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== 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.//
-===== Public Constructors =====
+== Return Value ==
-===== Protected Constructors =====
+  * Type:Void
-==== Style() ====
+  * Description:None
-This is the default constructor for the style and should be called by inherited classes.
-=== Remarks ===
-This is the default constructor for the style and should be called by inherited classes.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Protected Constructors|Go Back]]
+== Parameters ==
-===== Public Methods =====
+  * //features//
-==== CloneDeep() ====
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
-Create a copy of style using the deep clone process.
+    * Description:This parameter represents the features you want to draw on the canvas.
-=== 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.PortableCore.Style|Style]]<!-- ThinkGeo.MapSuite.PortableCore.Style -->   | A cloned style.   |
-=== Parameters ===
+  * //canvas//
-^  Name ^  Type ^  Description ^
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:This parameter represents the canvas you want to draw the features on.
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+  * //labelsInThisLayer//
-[[#Public Methods|Go Back]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-==== Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ====
+    * Description:The labels will be drawn in the current layer only.
-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.
+  * //labelsInAllLayers//
-=== Return Value ===
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-^ Return Type ^ Description ^
+    * Description:The labels will be drawn in all layers.
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-| features   | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} -->   | This parameter represents the features you want to draw on the canvas.   |
-| canvas   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
-| labelsInThisLayer   | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} -->   | The labels will be drawn in the current layer only.   |
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} -->   | The labels will be drawn in all layers.   |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+  * //This method draws the shapes on the canvas you provided.//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ====
+  * //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.//
-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.
+== Return Value ==
-=== Return Value ===
+  * Type:Void
-^ Return Type ^ Description ^
+  * Description:None
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //shapes//
-| shapes   | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.BaseShape} -->   | This parameter represents the shapes you want to draw on the canvas.   |
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>
-| canvas   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas -->   | This parameter represents the canvas you want to draw the shapes on.   |
+    * Description:This parameter represents the shapes you want to draw on the canvas.
-| labelsInThisLayer   | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} -->   | The labels will be drawn in the current layer only.   |
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} -->   | The labels will be drawn in all layers.   |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+  * //canvas//
-[[#Public Methods|Go Back]]
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-==== DrawSample(GeoCanvas, DrawingRectangleF) ====
+    * Description:This parameter represents the canvas you want to draw the shapes on.
-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.
+  * //labelsInThisLayer//
-=== Return Value ===
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-^ Return Type ^ Description ^
+    * Description:The labels will be drawn in the current layer only.
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //labelsInAllLayers//
-^  Name ^  Type ^  Description ^
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-| canvas   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
+    * Description:The labels will be drawn in all layers.
-| drawingExtent   | [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingRectangleF -->   |    |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **
-==== DrawSample(GeoCanvas) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //This method returns the column data for each feature that is required for the style to properly draw.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| canvas   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas -->   |    |
+  * //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. 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.//
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Collection<String>
-==== Equals(Object) ====
+  * Description:This method returns a collection of column names that the style needs.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| obj   | Object<!-- System.Object -->   |    |
+** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) **
-<!-- System.Object -->
+  * //This method draws a sample feature on the canvas you provided.//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetHashCode() ====
+  * //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 Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:None
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //canvas//
-==== GetRequiredColumnNames() ====
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-This method returns the column data for each feature that is required for the style to properly draw.
+    * Description:This parameter represents the canvas you want to draw the features on.
-=== 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.
+  * //drawingExtent//
+    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
+    * 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|}} DrawSample(GeoCanvas) **
-^ 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.PortableCore.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 ^
+  * //canvas//
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:N/A
-<!-- System.Object -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} ToString() **
-==== ToString() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:String
-===== Protected Methods =====
+  * Description:N/A
-==== CloneDeepCore() ====
-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.PortableCore.Style|Style]]<!-- ThinkGeo.MapSuite.PortableCore.Style -->   | A cloned style.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-<!-- ThinkGeo.MapSuite.PortableCore.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 abstract 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 implementing this abstract 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:Boolean
-^ Return Type ^ Description ^
+  * Description:N/A
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //obj//
-| features   | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} -->   | This parameter represents the features you want to draw on the canvas.   |
+    * Type:Object
-| canvas   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
+    * Description:N/A
-| labelsInThisLayer   | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} -->   | The labels will be drawn in the current layer only.   |
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} -->   | The labels will be drawn in all layers.   |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+<div newline></div>
-[[#Protected Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-==== 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.
+  * //N/A//
-=== Return Value ===
+== Remarks ==
-^ Return Type ^ Description ^
+  * //N/A//
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
-| canvas   | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
+  * Description:N/A
-| drawingExtent   | [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingRectangleF -->   |    |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-==== Finalize() ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Type
-==== GetRequiredColumnNamesCore() ====
+  * Description:N/A
-This method returns the column data for each feature that is required for the style to properly draw.
-=== 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.
+== Parameters ==
-=== Return Value ===
+<div newline></div>
-^ Return Type ^ Description ^
+==== Protected Methods ====
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   | This method returns a collection of column names that the style needs.   |
+** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
-=== Parameters ===
+  * //Create a copy of style using the deep clone process. The default implementation method uses serialization.//
-^  Name ^  Type ^  Description ^
+== 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.//
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
-==== MemberwiseClone() ====
+  * Description:A cloned style.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-<!-- System.Object -->
+  * //This method draws the features on the canvas you provided.//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-===== Public Properties =====
+  * //This abstract 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 implementing this abstract 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.//
-==== Filters ====
-=== Return Value ===
-^ Return Type ^
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+== Return Value ==
-[[#Public Properties|Go Back]]
+  * Type:Void
-==== IsActive ====
+  * Description:None
-This property gets and sets the active status of the style.
-=== Remarks ===
-If the style is not active then it will not draw.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+  * //features//
-==== Name ====
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
-This property gets and set the name of the style.
+    * Description:This parameter represents the features you want to draw on the canvas.
-=== 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.PortableCore.Style -->
+  * //canvas//
-[[#Public Properties|Go Back]]
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-==== RequiredColumnNames ====
+    * Description:This parameter represents the canvas you want to draw the features on.
-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.PortableCore.Style -->
+  * //labelsInThisLayer//
-[[#Public Properties|Go Back]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-===== Protected Properties =====
+    * Description:The labels will be drawn in the current layer only.
-==== FiltersCore ====
-=== Return Value ===
-^ Return Type ^
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   |
-<!-- ThinkGeo.MapSuite.PortableCore.Style -->
+  * //labelsInAllLayers//
-[[#Protected Properties|Go Back]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-===== Public Events =====
+    * Description:The labels will be drawn in all layers.
-__NOTOC__
-[[Category:MapSuitePortableCore]]
+<div newline></div>
-[[Category:ThinkGeo.MapSuite.PortableCore]]
+** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() **
-[[Category:UpdateDocumentation]]
+  * //This method returns the column data for each feature that is required for the style to properly draw.//
+== 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 column names that the style needs.
+== Parameters ==
+<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|}} 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|}} 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 ==
+  * Type:String
+** {{wiki:PublicProperty.gif|}} IsActive **
+  * //This property gets and sets the active status of the style.//
+== Remarks ==
+  * //If the style is not active then it will not draw.//
+== Return Value ==
+  * Type:Boolean
+** {{wiki:PublicProperty.gif|}} 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 ==
+  * Type:Collection<String>
+** {{wiki:PublicProperty.gif|}} Filters **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Collection<String>
+==== Protected Properties ====
+** {{wiki:ProtectedProperty.gif|}} FiltersCore **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Collection<String>
+==== Public Events ====

User Tools

Site Tools

Differences

Page Tools