thinkgeo.mapsuite.core.valuestyle
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.valuestyle [2015/09/17 10:41] admin |
thinkgeo.mapsuite.core.valuestyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.ValueStyle ====== | ====== ThinkGeo.MapSuite.Core.ValueStyle ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class allows you to match a value with data in the feature to determine how to draw that feature. | This class allows you to match a value with data in the feature to determine how to draw that feature. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 7: | Line 10: | ||
| *[[ThinkGeo.MapSuite.Core.NoaaWeatherWarningsStyle]] | *[[ThinkGeo.MapSuite.Core.NoaaWeatherWarningsStyle]] | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} ValueStyle() ** |
| - | **{{wiki:PublicMethod.gif|}}[[#ValueStyle()|ValueStyle]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is a constructor for the class. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is a constructor for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#ValueStyle(String,Collection<ValueItem>)|ValueStyle]]** | + | == Remarks == |
| - | * **Parameters**:String,Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> | + | * //If you use this constructor, you need to set the required properties manually.// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is a constructor for this class. | + | <div newline></div> |
| - | </div> | + | ** {{wiki:PublicMethod.gif|}} ValueStyle(String,Collection<ValueItem>) ** |
| - | === Protected Constructors === | + | * //This is a constructor for this class.// |
| - | === Public Methods === | + | == Remarks == |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#CloneDeep()|CloneDeep]]** | + | == Parameters == |
| - | * **Parameters**:N/A | + | * //columnName// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | * Type:String |
| - | * **Summary**:N/A | + | * Description:The columnName used to match with the value specified in the items. |
| - | </div> | + | |
| - | <div class_table> | + | * //valueItems// |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)|Draw]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * Description:The collection of ValueItems. Each item can have its own value to match. |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)|Draw]]** | + | ==== Protected Constructors ==== |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>,[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | ==== Public Methods ==== |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawSample(GeoCanvas,DrawingRectangleF)|DrawSample]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawSample(GeoCanvas)|DrawSample]]** | + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | <div newline></div> |
| - | * **Parameters**:Object | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetRequiredColumnNames()|GetRequiredColumnNames]]** | + | * Type:Void |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * //features// |
| - | * **Parameters**:N/A | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | * **DeclaringType**:Object | + | * Description:N/A |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //canvas// |
| - | **{{wiki:PublicMethod.gif|}}[[#SaveStyle(String)|SaveStyle]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Parameters**:String | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //labelsInThisLayer// |
| - | **{{wiki:PublicMethod.gif|}}[[#SaveStyle(Stream)|SaveStyle]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Parameters**:Stream | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //labelsInAllLayers// |
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Protected Methods === | + | <div newline></div> |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | **{{wiki:ProtectedMethod.gif|}}[[#CloneDeepCore()|CloneDeepCore]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)|DrawCore]]** | + | == Remarks == |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method draws the features on the canvas you provided. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#DrawSampleCore(GeoCanvas,DrawingRectangleF)|DrawSampleCore]]** | + | * Type:Void |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * //shapes// |
| - | * **Parameters**:N/A | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> |
| - | * **DeclaringType**:Object | + | * Description:N/A |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //canvas// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Parameters**:N/A | + | * Description: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> | + | * //labelsInThisLayer// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Public Properties === | + | * //labelsInAllLayers// |
| - | **{{wiki:PublicProperty.gif|}}[[#ColumnName|ColumnName]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Return**:String | + | * Description:N/A |
| - | * **Summary**:This property gets and sets the column name used to match with the value specified in the items. | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#Filters|Filters]]** | + | <div newline></div> |
| - | * **Return**:Collection<String> | + | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#IsActive|IsActive]]** | + | * //N/A// |
| - | * **Return**:Boolean | + | == Remarks == |
| - | * **Summary**:N/A | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#Name|Name]]** | + | == Return Value == |
| - | * **Return**:String | + | * Type:Collection<String> |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#RequiredColumnNames|RequiredColumnNames]]** | + | == Parameters == |
| - | * **Return**:Collection<String> | + | <div newline></div> |
| - | * **Summary**:N/A | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** |
| - | **{{wiki:PublicProperty.gif|}}[[#ValueItems|ValueItems]]** | + | * //N/A// |
| - | * **Return**:Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> | + | == Remarks == |
| - | * **Summary**:This property gets the collection of ValueItems. Each item can have its own value to match. | + | * //N/A// |
| - | === Protected Properties === | + | == Return Value == |
| - | **{{wiki:ProtectedProperty.gif|}}[[#FiltersCore|FiltersCore]]** | + | * Type:Void |
| - | * **Return**:Collection<String> | + | * Description:N/A |
| - | * **Summary**:N/A | + | |
| - | === Public Events === | + | == Parameters == |
| - | ===== Public Constructors ===== | + | * //canvas// |
| - | === ValueStyle() === | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | This is a constructor for the class. | + | * Description:N/A |
| - | ==== 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** | + | * //drawingExtent// |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
| - | * **Description:The collection of ValueItems. Each item can have its own value to match. | + | * Description:N/A |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** |
| - | ===== Public Methods ===== | + | |
| - | === CloneDeep() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | === Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | * //canvas// |
| - | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **features** | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | |
| - | * **Description**:N/A | + | |
| - | **canvas** | + | * //N/A// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | **labelsInThisLayer** | + | == Return Value == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | **labelsInAllLayers** | + | == Parameters == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * //filePathName// |
| - | * **Description**:N/A | + | * Type:String |
| + | * Description:N/A | ||
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **shapes** | + | * Type:Void |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | **canvas** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * //stream// |
| - | * **Description**:N/A | + | * Type:Stream |
| + | * Description:N/A | ||
| - | **labelsInThisLayer** | + | <div newline></div> |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | * **Description**:N/A | + | |
| - | **labelsInAllLayers** | + | * //N/A// |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === DrawSample(GeoCanvas,DrawingRectangleF) === | + | * Type:String |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **canvas** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | **drawingExtent** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | * Type:Boolean |
| - | * **Description**:N/A | + | * Description:N/A |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === DrawSample(GeoCanvas) === | + | * //obj// |
| - | N/A | + | * Type:Object |
| - | ==== Remarks ==== | + | * Description:N/A |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Void | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **canvas** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === Equals(Object) === | + | * Type:Int32 |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Boolean | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **obj** | + | == Remarks == |
| - | * **Type**:Object | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === GetHashCode() === | + | * Type:Type |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Int32 | + | <div newline></div> |
| - | * **Description**:N/A | + | ==== Protected Methods ==== |
| + | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | ==== Parameters ==== | + | * //This method draws the features on the canvas you provided.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetRequiredColumnNames() === | + | * //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.// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Collection<String> | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:None |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //features// |
| - | === GetType() === | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | N/A | + | * Description:This parameter represents the features you want to draw on the canvas. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //canvas// |
| - | * **Return Type**:Type | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Description**:N/A | + | * Description:This parameter represents the canvas you want to draw the features on. |
| - | ==== Parameters ==== | + | * //labelsInThisLayer// |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | === SaveStyle(String) === | + | * Description:The labels will be drawn in the current layer only. |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //labelsInAllLayers// |
| - | * **Return Type**:Void | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Description**:N/A | + | * Description:The labels will be drawn in all layers. |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **filePathName** | + | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** |
| - | * **Type**:String | + | |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | * //This method returns the column data for each feature that is required for the style to properly draw.// |
| - | === SaveStyle(Stream) === | + | == Remarks == |
| - | N/A | + | * //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.// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Collection<String> |
| - | * **Description**:N/A | + | * Description:This method returns a collection of the column names that it needs. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **stream** | + | <div newline></div> |
| - | * **Type**:Stream | + | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | * //N/A// |
| - | === ToString() === | + | == Remarks == |
| - | N/A | + | * //N/A// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:String | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //canvas// |
| - | ===== Protected Methods ===== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | === CloneDeepCore() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //drawingExtent// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** |
| - | === 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** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **features** | + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * Description:N/A |
| - | * **Description**:This parameter represents the features you want to draw on the canvas. | + | |
| - | **canvas** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | <div newline></div> |
| - | * **Description**:This parameter represents the canvas you want to draw the features on. | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | **labelsInThisLayer** | + | * //N/A// |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | == Remarks == |
| - | * **Description**:The labels will be drawn in the current layer only. | + | * //N/A// |
| - | **labelsInAllLayers** | + | == Return Value == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * Type:Void |
| - | * **Description**:The labels will be drawn in all layers. | + | * Description:N/A |
| - | [[#Protected Methods|Go Back]] | + | == Parameters == |
| - | === DrawSampleCore(GeoCanvas,DrawingRectangleF) === | + | <div newline></div> |
| - | N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **canvas** | + | * Type:Object |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | **drawingExtent** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | <div newline></div> |
| - | * **Description**:N/A | + | ==== Public Properties ==== |
| + | ** {{wiki:PublicProperty.gif|}} ColumnName ** | ||
| - | [[#Protected Methods|Go Back]] | + | This property gets and sets the column name used to match with the value specified in the items. |
| - | === Finalize() === | + | == Remarks == |
| - | N/A | + | This is the column we use for matching. |
| - | ==== Remarks ==== | + | == Return Value == |
| - | N/A | + | * Type:String |
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} ValueItems ** |
| - | * **Return Type**:Void | + | |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | This property gets the collection of ValueItems. Each item can have its own value to match. |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | === GetRequiredColumnNamesCore() === | + | You will want to add ValueItems to this collection. Each item can have its own style and matching string. |
| - | This method returns the column data for each feature that is required for the style to properly draw. | + | == Return Value == |
| - | ==== Remarks ==== | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> |
| - | 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** | + | ** {{wiki:PublicProperty.gif|}} Name ** |
| - | * **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 | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} IsActive ** |
| - | * **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 | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Collection<String> | + | * Type:Boolean |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** |
| - | === IsActive === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Boolean | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === Name === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:String | + | * Type:Collection<String> |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Filters ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === RequiredColumnNames === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Collection<String> | + | * Type:Collection<String> |
| - | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
| - | === ValueItems === | + | ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** |
| - | 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 | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Collection<String> | + | * Type:Collection<String> |
| - | [[#Protected Properties|Go Back]] | + | ==== Public Events ==== |
| - | ===== Public Events ===== | + | |
thinkgeo.mapsuite.core.valuestyle.1442486510.txt.gz · Last modified: 2015/09/17 10:41 by admin