User Tools

Site Tools


thinkgeo.mapsuite.core.valuestyle

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
thinkgeo.mapsuite.core.valuestyle [2015/09/17 10:41]
admin
— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.Core.ValueStyle ====== 
-This class allows you to match a value with data in the feature to determine how to draw that feature. 
-===== Inheritance Hierarchy ===== 
-  *System.Object 
-    *ThinkGeo.MapSuite.Core.Style 
-      ***ThinkGeo.MapSuite.Core.ValueStyle** 
-        *[[ThinkGeo.MapSuite.Core.NoaaWeatherWarningsStyle]] 
-===== Members Summary ===== 
-=== Public Constructors === 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​ValueStyle()|ValueStyle]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​N/​A 
-  * **Summary**:​This is a constructor for the class. 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​ValueStyle(String,​Collection<​ValueItem>​)|ValueStyle]]** 
-  * **Parameters**:​String,​Collection<​[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]>​ 
-  * **DeclaringType**:​N/​A 
-  * **Summary**:​This is a constructor for this class. 
-</​div>​ 
- 
-=== Protected Constructors === 
-=== Public Methods === 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​CloneDeep()|CloneDeep]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​Draw(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​)|Draw]]** 
-  * **Parameters**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​Draw(IEnumerable<​BaseShape>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​)|Draw]]** 
-  * **Parameters**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>,​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​DrawSample(GeoCanvas,​DrawingRectangleF)|DrawSample]]** 
-  * **Parameters**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​DrawSample(GeoCanvas)|DrawSample]]** 
-  * **Parameters**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​Equals(Object)|Equals]]** 
-  * **Parameters**:​Object 
-  * **DeclaringType**:​Object 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​GetHashCode()|GetHashCode]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​Object 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​GetRequiredColumnNames()|GetRequiredColumnNames]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​GetType()|GetType]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​Object 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​SaveStyle(String)|SaveStyle]]** 
-  * **Parameters**:​String 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​SaveStyle(Stream)|SaveStyle]]** 
-  * **Parameters**:​Stream 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​PublicMethod.gif|}}[[#​ToString()|ToString]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​Object 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-=== Protected Methods === 
-<div class_table>​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​CloneDeepCore()|CloneDeepCore]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​DrawCore(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​)|DrawCore]]** 
-  * **Parameters**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **DeclaringType**:​N/​A 
-  * **Summary**:​This method draws the features on the canvas you provided. 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​DrawSampleCore(GeoCanvas,​DrawingRectangleF)|DrawSampleCore]]** 
-  * **Parameters**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-  * **DeclaringType**:​N/​A 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​Finalize()|Finalize]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​Object 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​N/​A 
-  * **Summary**:​This method returns the column data for each feature that is required for the style to properly draw. 
-</​div>​ 
- 
-<div class_table>​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​MemberwiseClone()|MemberwiseClone]]** 
-  * **Parameters**:​N/​A 
-  * **DeclaringType**:​Object 
-  * **Summary**:​N/​A 
-</​div>​ 
- 
-=== Public Properties === 
-**{{wiki:​PublicProperty.gif|}}[[#​ColumnName|ColumnName]]** 
-  * **Return**:​String 
-  * **Summary**:​This property gets and sets the column name used to match with the value specified in the items. 
- 
-**{{wiki:​PublicProperty.gif|}}[[#​Filters|Filters]]** 
-  * **Return**:​Collection<​String>​ 
-  * **Summary**:​N/​A 
- 
-**{{wiki:​PublicProperty.gif|}}[[#​IsActive|IsActive]]** 
-  * **Return**:​Boolean 
-  * **Summary**:​N/​A 
- 
-**{{wiki:​PublicProperty.gif|}}[[#​Name|Name]]** 
-  * **Return**:​String 
-  * **Summary**:​N/​A 
- 
-**{{wiki:​PublicProperty.gif|}}[[#​RequiredColumnNames|RequiredColumnNames]]** 
-  * **Return**:​Collection<​String>​ 
-  * **Summary**:​N/​A 
- 
-**{{wiki:​PublicProperty.gif|}}[[#​ValueItems|ValueItems]]** 
-  * **Return**:​Collection<​[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]>​ 
-  * **Summary**:​This property gets the collection of ValueItems. Each item can have its own value to match. 
- 
-=== Protected Properties === 
-**{{wiki:​ProtectedProperty.gif|}}[[#​FiltersCore|FiltersCore]]** 
-  * **Return**:​Collection<​String>​ 
-  * **Summary**:​N/​A 
- 
-=== Public Events === 
-===== Public Constructors ===== 
-=== ValueStyle() === 
-This is a constructor for the class. 
-==== Remarks ==== 
-If you use this constructor,​ you need to set the required properties manually. 
-==== Parameters ==== 
-[[#Public Constructors|Go Back]] 
-=== ValueStyle(String,​Collection<​ValueItem>​) === 
-This is a constructor for this class. 
-==== Remarks ==== 
-N/A 
-==== Parameters ==== 
-**columnName** 
-  * **Type**:​String 
-  * **Description:​The columnName used to match with the value specified in the items. 
- 
-**valueItems** 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]>​ 
-  * **Description:​The collection of ValueItems. Each item can have its own value to match. 
- 
-[[#Public Constructors|Go Back]] 
-===== Protected Constructors ===== 
-===== Public Methods ===== 
-=== CloneDeep() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#Public Methods|Go Back]] 
-=== Draw(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**features** 
-  * **Type**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​ 
-  * **Description**:​N/​A 
- 
-**canvas** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **Description**:​N/​A 
- 
-**labelsInThisLayer** 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Description**:​N/​A 
- 
-**labelsInAllLayers** 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Description**:​N/​A 
- 
-[[#Public Methods|Go Back]] 
-=== Draw(IEnumerable<​BaseShape>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**shapes** 
-  * **Type**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>​ 
-  * **Description**:​N/​A 
- 
-**canvas** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **Description**:​N/​A 
- 
-**labelsInThisLayer** 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Description**:​N/​A 
- 
-**labelsInAllLayers** 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Description**:​N/​A 
- 
-[[#Public Methods|Go Back]] 
-=== DrawSample(GeoCanvas,​DrawingRectangleF) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**canvas** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **Description**:​N/​A 
- 
-**drawingExtent** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-  * **Description**:​N/​A 
- 
-[[#Public Methods|Go Back]] 
-=== DrawSample(GeoCanvas) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**canvas** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **Description**:​N/​A 
- 
-[[#Public Methods|Go Back]] 
-=== Equals(Object) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:​Boolean 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**obj** 
-  * **Type**:​Object 
-  * **Description**:​N/​A 
- 
-[[#Public Methods|Go Back]] 
-=== GetHashCode() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:​Int32 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#Public Methods|Go Back]] 
-=== GetRequiredColumnNames() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:​Collection<​String>​ 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#Public Methods|Go Back]] 
-=== GetType() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Type 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#Public Methods|Go Back]] 
-=== SaveStyle(String) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**filePathName** 
-  * **Type**:​String 
-  * **Description**:​N/​A 
- 
-[[#Public Methods|Go Back]] 
-=== SaveStyle(Stream) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**stream** 
-  * **Type**:​Stream 
-  * **Description**:​N/​A 
- 
-[[#Public Methods|Go Back]] 
-=== ToString() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:​String 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#Public Methods|Go Back]] 
-===== Protected Methods ===== 
-=== CloneDeepCore() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#​Protected Methods|Go Back]] 
-=== DrawCore(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) === 
-This method draws the features on the canvas you provided. 
-==== Remarks ==== 
-This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently. When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore,​ we read that property and add it to the collection. 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​None 
- 
-==== Parameters ==== 
-**features** 
-  * **Type**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​ 
-  * **Description**:​This parameter represents the features you want to draw on the canvas. 
- 
-**canvas** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **Description**:​This parameter represents the canvas you want to draw the features on. 
- 
-**labelsInThisLayer** 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Description**:​The labels will be drawn in the current layer only. 
- 
-**labelsInAllLayers** 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Description**:​The labels will be drawn in all layers. 
- 
-[[#​Protected Methods|Go Back]] 
-=== DrawSampleCore(GeoCanvas,​DrawingRectangleF) === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-**canvas** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **Description**:​N/​A 
- 
-**drawingExtent** 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-  * **Description**:​N/​A 
- 
-[[#​Protected Methods|Go Back]] 
-=== Finalize() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:Void 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#​Protected Methods|Go Back]] 
-=== GetRequiredColumnNamesCore() === 
-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** 
-  * **Return Type**:​Collection<​String>​ 
-  * **Description**:​This method returns a collection of the column names that it needs. 
- 
-==== Parameters ==== 
-[[#​Protected Methods|Go Back]] 
-=== MemberwiseClone() === 
-N/A 
-==== Remarks ==== 
-N/A 
- 
-**Return Value** 
-  * **Return Type**:​Object 
-  * **Description**:​N/​A 
- 
-==== Parameters ==== 
-[[#​Protected Methods|Go Back]] 
-===== Public Properties ===== 
-=== ColumnName === 
-This property gets and sets the column name used to match with the value specified in the items. 
-==== Remarks ==== 
-This is the column we use for matching. 
-==== Return Value ==== 
-**Return Type**:​String 
- 
-[[#Public Properties|Go Back]] 
-=== Filters === 
-N/A 
-==== Remarks ==== 
-N/A 
-==== Return Value ==== 
-**Return Type**:​Collection<​String>​ 
- 
-[[#Public Properties|Go Back]] 
-=== IsActive === 
-N/A 
-==== Remarks ==== 
-N/A 
-==== Return Value ==== 
-**Return Type**:​Boolean 
- 
-[[#Public Properties|Go Back]] 
-=== Name === 
-N/A 
-==== Remarks ==== 
-N/A 
-==== Return Value ==== 
-**Return Type**:​String 
- 
-[[#Public Properties|Go Back]] 
-=== RequiredColumnNames === 
-N/A 
-==== Remarks ==== 
-N/A 
-==== Return Value ==== 
-**Return Type**:​Collection<​String>​ 
- 
-[[#Public Properties|Go Back]] 
-=== ValueItems === 
-This property gets the collection of ValueItems. Each item can have its own value to match. 
-==== Remarks ==== 
-You will want to add ValueItems to this collection. Each item can have its own style and matching string. 
-==== Return Value ==== 
-**Return Type**:​Collection<​[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]>​ 
- 
-[[#Public Properties|Go Back]] 
-===== Protected Properties ===== 
-=== FiltersCore === 
-N/A 
-==== Remarks ==== 
-N/A 
-==== Return Value ==== 
-**Return Type**:​Collection<​String>​ 
- 
-[[#​Protected Properties|Go Back]] 
-===== Public Events ===== 
  
thinkgeo.mapsuite.core.valuestyle.1442486510.txt.gz ยท Last modified: 2015/09/17 10:41 by admin