This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.gradientstyle [2015/09/17 10:31] admin |
thinkgeo.mapsuite.core.gradientstyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.GradientStyle ====== | ====== ThinkGeo.MapSuite.Core.GradientStyle ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This gradient style is a new style with the concept of GradientBrush. By specifying the LowerValue and its color, as well as the UpperValue and its color, we can set the color of each feature based on a column value using linear interpolation. | This gradient style is a new style with the concept of GradientBrush. By specifying the LowerValue and its color, as well as the UpperValue and its color, we can set the color of each feature based on a column value using linear interpolation. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 6: | Line 9: | ||
| ***ThinkGeo.MapSuite.Core.GradientStyle** | ***ThinkGeo.MapSuite.Core.GradientStyle** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush) ** |
| - | **{{wiki:PublicMethod.gif|}}[[#GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush)|GradientStyle]]** | + | |
| - | * **Parameters**:String,Double,[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]],Double,[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, and the upperValue and its corresponding SolidBrush. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, and the upperValue and its corresponding SolidBrush.// |
| - | **{{wiki:PublicMethod.gif|}}[[#GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush,Double,GeoSolidBrush)|GradientStyle]]** | + | == Remarks == |
| - | * **Parameters**:String,Double,[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]],Double,[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]],Double,[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * //In this constructor, the NoDataValue defaults to -9999 and the NoDataBrush color is transparent.// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, the upperValue and its corresponding SolidBrush, and the NoDataValue and its corresponding SolidBrush. | + | * //columnName// |
| - | </div> | + | * Type:String |
| + | * Description:N/A | ||
| - | === Protected Constructors === | + | * //lowerValue// |
| - | === Public Methods === | + | * Type:Double |
| - | <div class_table> | + | * Description:N/A |
| - | **{{wiki:PublicMethod.gif|}}[[#CloneDeep()|CloneDeep]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //lowerGeoSolidBrush// |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)|Draw]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
| - | * **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:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //upperValue// |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)|Draw]]** | + | * Type:Double |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>,[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //upperGeoSolidBrush// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawSample(GeoCanvas,DrawingRectangleF)|DrawSample]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawSample(GeoCanvas)|DrawSample]]** | + | ** {{wiki:PublicMethod.gif|}} GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush,Double,GeoSolidBrush) ** |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, the upperValue and its corresponding SolidBrush, and the NoDataValue and its corresponding SolidBrush.// |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | == Remarks == |
| - | * **Parameters**:Object | + | * //N/A// |
| - | * **DeclaringType**:Object | + | == Parameters == |
| - | * **Summary**:N/A | + | * //columnName// |
| - | </div> | + | * Type:String |
| + | * Description:N/A | ||
| - | <div class_table> | + | * //lowerValue// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:Double |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //lowerGeoSolidBrush// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetRequiredColumnNames()|GetRequiredColumnNames]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //upperValue// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:Double |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //upperGeoSolidBrush// |
| - | **{{wiki:PublicMethod.gif|}}[[#SaveStyle(String)|SaveStyle]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
| - | * **Parameters**:String | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //noDataValue// |
| - | **{{wiki:PublicMethod.gif|}}[[#SaveStyle(Stream)|SaveStyle]]** | + | * Type:Double |
| - | * **Parameters**:Stream | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //noDataSolidBrush// |
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Protected Methods === | + | <div newline></div> |
| - | <div class_table> | + | ==== Protected Constructors ==== |
| - | **{{wiki:ProtectedMethod.gif|}}[[#CloneDeepCore()|CloneDeepCore]]** | + | ==== Public Methods ==== |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| - | * **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:[[ThinkGeo.MapSuite.Core.Style|Style]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //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> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * Type:Void |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Public Properties === | + | == Parameters == |
| - | **{{wiki:PublicProperty.gif|}}[[#ColumnName|ColumnName]]** | + | * //features// |
| - | * **Return**:String | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | * **Summary**:This property gets and sets the column name used in the style. | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#Filters|Filters]]** | + | * //canvas// |
| - | * **Return**:Collection<String> | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#IsActive|IsActive]]** | + | * //labelsInThisLayer// |
| - | * **Return**:Boolean | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#LowerGeoSolidBrush|LowerGeoSolidBrush]]** | + | * //labelsInAllLayers// |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Summary**:This property gets and sets the solid brush that is used for the style's lower value. | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#LowerValue|LowerValue]]** | + | <div newline></div> |
| - | * **Return**:Double | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | * **Summary**:This property gets and sets the lower value used in the style. | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#Name|Name]]** | + | * //N/A// |
| - | * **Return**:String | + | == Remarks == |
| - | * **Summary**:N/A | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#NoDataSolidBrush|NoDataSolidBrush]]** | + | == Return Value == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * Type:Void |
| - | * **Summary**:This property gets and sets the solid brush that is used for the style's NoDataValue. | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#NoDataValue|NoDataValue]]** | + | == Parameters == |
| - | * **Return**:Double | + | * //shapes// |
| - | * **Summary**:This property gets and sets the no data value used in the style. | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> |
| + | * Description:N/A | ||
| - | **{{wiki:PublicProperty.gif|}}[[#RequiredColumnNames|RequiredColumnNames]]** | + | * //canvas// |
| - | * **Return**:Collection<String> | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#UpperGeoSolidBrush|UpperGeoSolidBrush]]** | + | * //labelsInThisLayer// |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Summary**:This property gets and sets the solid brush that is used for the style's upper value. | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#UpperValue|UpperValue]]** | + | * //labelsInAllLayers// |
| - | * **Return**:Double | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Summary**:This property gets and sets the upper value used in the style. | + | * Description:N/A |
| - | === Protected Properties === | + | <div newline></div> |
| - | **{{wiki:ProtectedProperty.gif|}}[[#FiltersCore|FiltersCore]]** | + | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** |
| - | * **Return**:Collection<String> | + | |
| - | * **Summary**:N/A | + | |
| - | === Public Events === | + | * //N/A// |
| - | ===== Public Constructors ===== | + | == Remarks == |
| - | === GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush) === | + | * //N/A// |
| - | This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, and the upperValue and its corresponding SolidBrush. | + | |
| - | ==== Remarks ==== | + | |
| - | In this constructor, the NoDataValue defaults to -9999 and the NoDataBrush color is transparent. | + | |
| - | ==== Parameters ==== | + | |
| - | **columnName** | + | |
| - | * **Type**:String | + | |
| - | * **Description:N/A | + | |
| - | **lowerValue** | + | == Return Value == |
| - | * **Type**:Double | + | * Type:Collection<String> |
| - | * **Description:N/A | + | * Description:N/A |
| - | **lowerGeoSolidBrush** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | <div newline></div> |
| - | * **Description:N/A | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** |
| - | **upperValue** | + | * //N/A// |
| - | * **Type**:Double | + | == Remarks == |
| - | * **Description:N/A | + | * //N/A// |
| - | **upperGeoSolidBrush** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * Type:Void |
| - | * **Description:N/A | + | * Description:N/A |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | === GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush,Double,GeoSolidBrush) === | + | * //canvas// |
| - | This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, the upperValue and its corresponding SolidBrush, and the NoDataValue and its corresponding SolidBrush. | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | ==== Remarks ==== | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Parameters ==== | + | |
| - | **columnName** | + | |
| - | * **Type**:String | + | |
| - | * **Description:N/A | + | |
| - | **lowerValue** | + | * //drawingExtent// |
| - | * **Type**:Double | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
| - | * **Description:N/A | + | * Description:N/A |
| - | **lowerGeoSolidBrush** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** |
| - | * **Description:N/A | + | |
| - | **upperValue** | + | * //N/A// |
| - | * **Type**:Double | + | == Remarks == |
| - | * **Description:N/A | + | * //N/A// |
| - | **upperGeoSolidBrush** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * Type:Void |
| - | * **Description:N/A | + | * Description:N/A |
| - | **noDataValue** | + | == Parameters == |
| - | * **Type**:Double | + | * //canvas// |
| - | * **Description:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| + | * Description:N/A | ||
| - | **noDataSolidBrush** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** |
| - | * **Description:N/A | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ===== Protected Constructors ===== | + | == Remarks == |
| - | ===== Public Methods ===== | + | * //N/A// |
| - | === CloneDeep() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //filePathName// |
| - | === Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | * Type:String |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Void | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **features** | + | == Remarks == |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | **canvas** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | **labelsInThisLayer** | + | == Parameters == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * //stream// |
| - | * **Description**:N/A | + | * Type:Stream |
| + | * Description:N/A | ||
| - | **labelsInAllLayers** | + | <div newline></div> |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | * //N/A// |
| - | === Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | == Remarks == |
| - | N/A | + | * //N/A// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:String |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **shapes** | + | <div newline></div> |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | * **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:Boolean |
| - | * **Description**:N/A | + | * Description:N/A |
| - | **labelsInAllLayers** | + | == Parameters == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * //obj// |
| - | * **Description**:N/A | + | * Type:Object |
| + | * Description:N/A | ||
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === DrawSample(GeoCanvas,DrawingRectangleF) === | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **canvas** | + | * Type:Int32 |
| - | * **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 | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | [[#Public Methods|Go Back]] | + | * //N/A// |
| - | === DrawSample(GeoCanvas) === | + | == Remarks == |
| - | N/A | + | * //N/A// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Type |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **canvas** | + | <div newline></div> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | ==== Protected Methods ==== |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | [[#Public Methods|Go Back]] | + | * //This method draws the features on the canvas you provided.// |
| - | === Equals(Object) === | + | == Remarks == |
| - | N/A | + | * //This virtual 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 virtual 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.// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Boolean | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:None |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **obj** | + | * //features// |
| - | * **Type**:Object | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | * **Description**:N/A | + | * Description:This parameter represents the features you want to draw on the canvas. |
| - | [[#Public Methods|Go Back]] | + | * //canvas// |
| - | === GetHashCode() === | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | N/A | + | * Description:This parameter represents the canvas you want to draw the features on. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //labelsInThisLayer// |
| - | * **Return Type**:Int32 | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Description**:N/A | + | * Description:The labels will be drawn in the current layer only. |
| - | ==== Parameters ==== | + | * //labelsInAllLayers// |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | === GetRequiredColumnNames() === | + | * Description:The labels will be drawn in all layers. |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Collection<String> | + | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //This method returns the column data for each feature that is required for the style to properly draw.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetType() === | + | * //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.// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Type | + | * Type:Collection<String> |
| - | * **Description**:N/A | + | * Description:This method returns a collection of column names that the style needs. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === SaveStyle(String) === | + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **filePathName** | + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] |
| - | * **Type**:String | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === SaveStyle(Stream) === | + | <div newline></div> |
| - | N/A | + | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **stream** | + | * Type:Void |
| - | * **Type**:Stream | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === ToString() === | + | * //canvas// |
| - | N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | ==== Remarks ==== | + | * Description:N/A |
| - | N/A | + | |
| - | **Return Value** | + | * //drawingExtent// |
| - | * **Return Type**:String | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | ===== Protected Methods ===== | + | |
| - | === CloneDeepCore() === | + | |
| - | 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 == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | === DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | * Description:N/A |
| - | This method draws the features on the canvas you provided. | + | |
| - | ==== Remarks ==== | + | |
| - | This virtual 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 virtual 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** | + | == Parameters == |
| - | * **Return Type**:Void | + | <div newline></div> |
| - | * **Description**:None | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **features** | + | == Remarks == |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * //N/A// |
| - | * **Description**:This parameter represents the features you want to draw on the canvas. | + | |
| - | **canvas** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:Object |
| - | * **Description**:This parameter represents the canvas you want to draw the features on. | + | * Description:N/A |
| - | **labelsInThisLayer** | + | == Parameters == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | <div newline></div> |
| - | * **Description**:The labels will be drawn in the current layer only. | + | ==== Public Properties ==== |
| + | ** {{wiki:PublicProperty.gif|}} ColumnName ** | ||
| - | **labelsInAllLayers** | + | This property gets and sets the column name used in the style. |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | == Remarks == |
| - | * **Description**:The labels will be drawn in all layers. | + | None. |
| + | == Return Value == | ||
| + | * Type:String | ||
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} LowerValue ** |
| - | === DrawSampleCore(GeoCanvas,DrawingRectangleF) === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | This property gets and sets the lower value used in the style. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | None. |
| + | == Return Value == | ||
| + | * Type:Double | ||
| - | ==== Parameters ==== | + | ** {{wiki:PublicProperty.gif|}} LowerGeoSolidBrush ** |
| - | **canvas** | + | |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | |
| - | * **Description**:N/A | + | |
| - | **drawingExtent** | + | This property gets and sets the solid brush that is used for the style's lower value. |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | == Remarks == |
| - | * **Description**:N/A | + | None. |
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} UpperValue ** |
| - | === Finalize() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | This property gets and sets the upper value used in the style. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | None. |
| + | == Return Value == | ||
| + | * Type:Double | ||
| - | ==== Parameters ==== | + | ** {{wiki:PublicProperty.gif|}} UpperGeoSolidBrush ** |
| - | [[#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** | + | This property gets and sets the solid brush that is used for the style's upper value. |
| - | * **Return Type**:Collection<String> | + | == Remarks == |
| - | * **Description**:This method returns a collection of column names that the style needs. | + | None. |
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| - | ==== Parameters ==== | + | ** {{wiki:PublicProperty.gif|}} NoDataValue ** |
| - | [[#Protected Methods|Go Back]] | + | |
| - | === MemberwiseClone() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | This property gets and sets the no data value used in the style. |
| - | * **Return Type**:Object | + | == Remarks == |
| - | * **Description**:N/A | + | None. |
| + | == Return Value == | ||
| + | * Type:Double | ||
| - | ==== Parameters ==== | + | ** {{wiki:PublicProperty.gif|}} NoDataSolidBrush ** |
| - | [[#Protected Methods|Go Back]] | + | |
| - | ===== Public Properties ===== | + | This property gets and sets the solid brush that is used for the style's NoDataValue. |
| - | === ColumnName === | + | == Remarks == |
| - | This property gets and sets the column name used in the style. | + | |
| - | ==== Remarks ==== | + | |
| None. | None. | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:String | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === Filters === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Collection<String> | + | * Type:String |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsActive ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === IsActive === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Boolean |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** |
| - | === LowerGeoSolidBrush === | + | |
| - | This property gets and sets the solid brush that is used for the style's lower value. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | |
| - | + | ||
| - | [[#Public Properties|Go Back]] | + | |
| - | === LowerValue === | + | |
| - | This property gets and sets the lower value used in the style. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Double | + | |
| - | [[#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> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} Filters ** |
| - | === NoDataSolidBrush === | + | |
| - | This property gets and sets the solid brush that is used for the style's NoDataValue. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | |
| - | + | ||
| - | [[#Public Properties|Go Back]] | + | |
| - | === NoDataValue === | + | |
| - | This property gets and sets the no data value used in the style. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Double | + | |
| - | [[#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 ==== |
| - | === UpperGeoSolidBrush === | + | ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** |
| - | This property gets and sets the solid brush that is used for the style's upper value. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | |
| - | + | ||
| - | [[#Public Properties|Go Back]] | + | |
| - | === UpperValue === | + | |
| - | This property gets and sets the upper value used in the style. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Double | + | |
| - | [[#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 ===== | + | |