Differences

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

--- thinkgeo.mapsuite.portablecore.style [2015/09/21 08:19]
admin
+++ thinkgeo.mapsuite.portablecore.style [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.Style ======
+{{section>upgrade_map_suite_to_10.0}}
 This abstract class is the root for all styles used for drawing features.
 ===== Inheritance Hierarchy =====
   *System.Object
     ***ThinkGeo.MapSuite.Core.Style**
-      *[[ThinkGeo.MapSuite.Core.PointBaseStyle]]
       *[[ThinkGeo.MapSuite.Core.LineStyle]]
+      *[[ThinkGeo.MapSuite.Core.PointBaseStyle]]
+      *[[ThinkGeo.MapSuite.Core.AreaStyle]]
+      *[[ThinkGeo.MapSuite.Core.ClassBreakStyle]]
+      *[[ThinkGeo.MapSuite.Core.DotDensityStyle]]
       *[[ThinkGeo.MapSuite.Core.CompositeStyle]]
       *[[ThinkGeo.MapSuite.Core.FilterStyle]]
-      *[[ThinkGeo.MapSuite.Core.NoaaWeatherStationStyle]]
-      *[[ThinkGeo.MapSuite.Core.ValueStyle]]
       *[[ThinkGeo.MapSuite.Core.GradientStyle]]
       *[[ThinkGeo.MapSuite.Core.HeatStyle]]
-      *[[ThinkGeo.MapSuite.Core.AreaStyle]]
       *[[ThinkGeo.MapSuite.Core.PositionStyle]]
-      *[[ThinkGeo.MapSuite.Core.ClassBreakStyle]]
-      *[[ThinkGeo.MapSuite.Core.DotDensityStyle]]
       *[[ThinkGeo.MapSuite.Core.RegexStyle]]
+      *[[ThinkGeo.MapSuite.Core.ValueStyle]]
 ===== Members Summary =====
 ==== Public Constructors ====
@@ Line 22: / Line 24: @@
 ** {{wiki:ProtectedMethod.gif|}} 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.
+  * //This is the default constructor for the style and should be called by inherited classes.//
 == Parameters ==
 <div newline></div>
@@ Line 30: / Line 32: @@
 ** {{wiki:PublicMethod.gif|}} CloneDeep() **
-Create a copy of style using the deep clone process.
+  * //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.
+  * //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 ==
@@ Line 42: / Line 44: @@
 ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-This method draws the features on the canvas you provided.
+  * //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.
+  * //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.//
 == Return Value ==
@@ Line 70: / Line 72: @@
 ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-This method draws the shapes on the canvas you provided.
+  * //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.
+  * //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 ==
@@ Line 98: / Line 100: @@
 ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **
-This method returns the column data for each feature that is required for the style to properly draw.
+  * //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. 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 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.//
 == Return Value ==
@@ Line 110: / Line 112: @@
 ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) **
-This method draws a sample feature on the canvas you provided.
+  * //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.
+  * //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 ==
@@ Line 130: / Line 132: @@
 ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 141: / Line 143: @@
   * //canvas//
     * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:N/A
-<div newline></div>
-** {{wiki:PublicMethod.gif|}} SaveStyle(String) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:Void
-  * Description:N/A
-== Parameters ==
-  * //filePathName//
-    * Type:String
-    * Description:N/A
-<div newline></div>
-** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:Void
-  * Description:N/A
-== Parameters ==
-  * //stream//
-    * Type:Stream
     * Description:N/A
@@ Line 178: / Line 148: @@
 ** {{wiki:PublicMethod.gif|}} ToString() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 190: / Line 160: @@
 ** {{wiki:PublicMethod.gif|}} Equals(Object) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 206: / Line 176: @@
 ** {{wiki:PublicMethod.gif|}} GetHashCode() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 218: / Line 188: @@
 ** {{wiki:PublicMethod.gif|}} GetType() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 227: / Line 197: @@
 == Parameters ==
-<div newline></div>
-** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} LoadStyle(Uri) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
-  * Description:N/A
-== Parameters ==
-  * //styleUri//
-    * Type:Uri
-    * Description:N/A
-<div newline></div>
-** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} LoadStyle(Stream) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
-  * Description:N/A
-== Parameters ==
-  * //styleStream//
-    * Type:Stream
-    * Description:N/A
 <div newline></div>
 ==== Protected Methods ====
 ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
-Create a copy of style using the deep clone process. The default implementation method uses serialization.
+  * //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.
+  * //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 ==
@@ Line 275: / Line 213: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-This method draws the features on the canvas you provided.
+  * //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.
+  * //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 ==
@@ Line 303: / Line 241: @@
 ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() **
-This method returns the column data for each feature that is required for the style to properly draw.
+  * //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.
+  * //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 ==
@@ Line 315: / Line 253: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) **
-This method draws a sample feature on the canvas you provided.
+  * //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.
+  * //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 ==
@@ Line 335: / Line 273: @@
 ** {{wiki:ProtectedMethod.gif|}} Finalize() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 347: / Line 285: @@
 ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 360: / Line 298: @@
 ** {{wiki:PublicProperty.gif|}} Name **
-This property gets and set the name of the style.
+  * //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.
+  * //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
@@ Line 368: / Line 306: @@
 ** {{wiki:PublicProperty.gif|}} IsActive **
-This property gets and sets the active status of the style.
+  * //This property gets and sets the active status of the style.//
 == Remarks ==
-If the style is not active then it will not draw.
+  * //If the style is not active then it will not draw.//
 == Return Value ==
   * Type:Boolean
@@ Line 376: / Line 314: @@
 ** {{wiki:PublicProperty.gif|}} RequiredColumnNames **
-This property gets the collection of fields that are required for the style.
+  * //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.
+  * //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>
@@ Line 384: / Line 322: @@
 ** {{wiki:PublicProperty.gif|}} Filters **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:Collection<String>
@@ Line 393: / Line 331: @@
 ** {{wiki:ProtectedProperty.gif|}} FiltersCore **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:Collection<String>

User Tools

Site Tools

Differences

Page Tools