This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.qualityfamilyareastyle [2015/09/17 10:37] admin |
thinkgeo.mapsuite.core.qualityfamilyareastyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.QualityFamilyAreaStyle ====== | ====== ThinkGeo.MapSuite.Core.QualityFamilyAreaStyle ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class is used to draw area features. | This class is used to draw area features. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 7: | Line 10: | ||
| ***ThinkGeo.MapSuite.Core.QualityFamilyAreaStyle** | ***ThinkGeo.MapSuite.Core.QualityFamilyAreaStyle** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} QualityFamilyAreaStyle() ** |
| - | **{{wiki:PublicMethod.gif|}}[[#QualityFamilyAreaStyle()|QualityFamilyAreaStyle]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually.// |
| - | **{{wiki:PublicMethod.gif|}}[[#QualityFamilyAreaStyle(GeoPen,GeoColor,Int32)|QualityFamilyAreaStyle]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]],[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32 | + | * //None// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is the constructor the for the class. | + | <div newline></div> |
| - | </div> | + | ** {{wiki:PublicMethod.gif|}} QualityFamilyAreaStyle(GeoPen,GeoColor,Int32) ** |
| - | <div class_table> | + | * //This is the constructor the for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#QualityFamilyAreaStyle(GeoPen,GeoColor,Int32,PenBrushDrawingOrder)|QualityFamilyAreaStyle]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]],[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32,[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | + | * //None.// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is the constructor the for the class. | + | * //outlinePen// |
| - | </div> | + | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] |
| + | * Description:This parameter represents the outline pen that will be used on the style. | ||
| - | === Protected Constructors === | + | * //baseColor// |
| - | === Public Methods === | + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] |
| - | <div class_table> | + | * Description:This parameter represents the base color that will be used in the class. |
| - | **{{wiki:PublicMethod.gif|}}[[#ClearCache()|ClearCache]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method clears the cached style in the cache. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //numberOfColors// |
| - | **{{wiki:PublicMethod.gif|}}[[#CloneDeep()|CloneDeep]]** | + | * Type:Int32 |
| - | * **Parameters**:N/A | + | * Description:This prameter represents how many colors will be used in the style, based on the base color. |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)|Draw]]** | + | ** {{wiki:PublicMethod.gif|}} QualityFamilyAreaStyle(GeoPen,GeoColor,Int32,PenBrushDrawingOrder) ** |
| - | * **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> | + | * //This is the constructor the for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)|Draw]]** | + | == Remarks == |
| - | * **Parameters**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>,[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * //None.// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | == Parameters == |
| - | * **Summary**:N/A | + | * //outlinePen// |
| - | </div> | + | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] |
| + | * Description:This parameter represents the outline pen that will be used on the style. | ||
| - | <div class_table> | + | * //baseColor// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawSample(GeoCanvas,DrawingRectangleF)|DrawSample]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | * Description:This parameter represents the base color that will be used in the class. |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //numberOfColors// |
| - | **{{wiki:PublicMethod.gif|}}[[#DrawSample(GeoCanvas)|DrawSample]]** | + | * Type:Int32 |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Description:This prameter represents how many colors will be used in the style, based on the base color. |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //penBrushDrawingOrder// |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | * Type:[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] |
| - | * **Parameters**:Object | + | * Description:This parameter describes the PenBrushDrawingOrder that will be used when drawing the area type feature. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | ==== Protected Constructors ==== |
| - | * **Parameters**:N/A | + | ==== Public Methods ==== |
| - | * **DeclaringType**:Object | + | ** {{wiki:PublicMethod.gif|}} ClearCache() ** |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This method clears the cached style in the cache.// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetRequiredColumnNames()|GetRequiredColumnNames]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //This method clears the cached style in the cache.// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:Void |
| - | * **Parameters**:N/A | + | * Description:None. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#SaveStyle(String)|SaveStyle]]** | + | <div newline></div> |
| - | * **Parameters**:String | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#SaveStyle(Stream)|SaveStyle]]** | + | == Remarks == |
| - | * **Parameters**:Stream | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Protected Methods === | + | == Parameters == |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:ProtectedMethod.gif|}}[[#CloneDeepCore()|CloneDeepCore]]** | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | * **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**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * //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:ProtectedMethod.gif|}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]]** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | |
| - | * **Summary**:N/A | + | |
| - | </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|}}[[#Advanced|Advanced]]** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.AreaStyleAdvanced|AreaStyleAdvanced]] | + | * Description:N/A |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#BaseColor|BaseColor]]** | + | <div newline></div> |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | * **Summary**:This gets or sets the base color of the style. | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#Cache|Cache]]** | + | * //N/A// |
| - | * **Return**:Dictionary<String,[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | + | == Remarks == |
| - | * **Summary**:This gets the cached style in the class. | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#CustomAreaStyles|CustomAreaStyles]]** | + | == Return Value == |
| - | * **Return**:Collection<[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | + | * Type:Void |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#DrawingLevel|DrawingLevel]]** | + | == Parameters == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] | + | * //shapes// |
| - | * **Summary**:N/A | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> |
| + | * Description:N/A | ||
| - | **{{wiki:PublicProperty.gif|}}[[#FillSolidBrush|FillSolidBrush]]** | + | * //canvas// |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#Filters|Filters]]** | + | * //labelsInThisLayer// |
| - | * **Return**:Collection<String> | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#IsActive|IsActive]]** | + | * //labelsInAllLayers// |
| - | * **Return**:Boolean | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#Name|Name]]** | + | <div newline></div> |
| - | * **Return**:String | + | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#NumberOfColors|NumberOfColors]]** | + | * //N/A// |
| - | * **Return**:Int32 | + | == Remarks == |
| - | * **Summary**:This gets or sets the number of colors in the style. | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#OutlinePen|OutlinePen]]** | + | == Return Value == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | + | * Type:Collection<String> |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#PenBrushDrawingOrder|PenBrushDrawingOrder]]** | + | == Parameters == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | + | <div newline></div> |
| - | * **Summary**:N/A | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** |
| - | **{{wiki:PublicProperty.gif|}}[[#RequiredColumnNames|RequiredColumnNames]]** | + | * //N/A// |
| - | * **Return**:Collection<String> | + | == Remarks == |
| - | * **Summary**:N/A | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#XOffsetInPixel|XOffsetInPixel]]** | + | == Return Value == |
| - | * **Return**:Single | + | * Type:Void |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#YOffsetInPixel|YOffsetInPixel]]** | + | == Parameters == |
| - | * **Return**:Single | + | * //canvas// |
| - | * **Summary**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| + | * Description:N/A | ||
| - | === Protected Properties === | + | * //drawingExtent// |
| - | **{{wiki:ProtectedProperty.gif|}}[[#FiltersCore|FiltersCore]]** | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
| - | * **Return**:Collection<String> | + | * Description:N/A |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:ProtectedProperty.gif|}}[[#uBs=|uBs=]]** | + | <div newline></div> |
| - | * **Return**:Boolean | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** |
| - | * **Summary**:N/A | + | |
| - | === Public Events === | + | * //N/A// |
| - | ===== Public Constructors ===== | + | == Remarks == |
| - | === QualityFamilyAreaStyle() === | + | * //N/A// |
| - | This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | ==== Parameters ==== | + | |
| - | [[#Public Constructors|Go Back]] | + | |
| - | === QualityFamilyAreaStyle(GeoPen,GeoColor,Int32) === | + | |
| - | This is the constructor the for the class. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Parameters ==== | + | |
| - | **outlinePen** | + | |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | + | |
| - | * **Description:This parameter represents the outline pen that will be used on the style. | + | |
| - | **baseColor** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | + | * Type:Void |
| - | * **Description:This parameter represents the base color that will be used in the class. | + | * Description:N/A |
| - | **numberOfColors** | + | == Parameters == |
| - | * **Type**:Int32 | + | * //canvas// |
| - | * **Description:This prameter represents how many colors will be used in the style, based on the base color. | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| + | * Description:N/A | ||
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | === QualityFamilyAreaStyle(GeoPen,GeoColor,Int32,PenBrushDrawingOrder) === | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** |
| - | This is the constructor the for the class. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Parameters ==== | + | |
| - | **outlinePen** | + | |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | + | |
| - | * **Description:This parameter represents the outline pen that will be used on the style. | + | |
| - | **baseColor** | + | * //N/A// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | + | == Remarks == |
| - | * **Description:This parameter represents the base color that will be used in the class. | + | * //N/A// |
| - | **numberOfColors** | + | == Return Value == |
| - | * **Type**:Int32 | + | * Type:Void |
| - | * **Description:This prameter represents how many colors will be used in the style, based on the base color. | + | * Description:N/A |
| - | **penBrushDrawingOrder** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | + | * //filePathName// |
| - | * **Description:This parameter describes the PenBrushDrawingOrder that will be used when drawing the area type feature. | + | * Type:String |
| + | * Description:N/A | ||
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** |
| - | ===== Public Methods ===== | + | |
| - | === ClearCache() === | + | |
| - | This method clears the cached style in the cache. | + | |
| - | ==== Remarks ==== | + | |
| - | This method clears the cached style in the cache. | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None. | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | === CloneDeep() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | * //stream// |
| - | * **Description**:N/A | + | * Type:Stream |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | === Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **features** | + | * Type:String |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | **canvas** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | **labelsInThisLayer** | + | * //N/A// |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | **labelsInAllLayers** | + | == Return Value == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * Type:Boolean |
| - | * **Description**:N/A | + | * Description:N/A |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | * //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// |
| - | **shapes** | + | == Remarks == |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | **canvas** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:Int32 |
| - | * **Description**:N/A | + | * Description:N/A |
| - | **labelsInThisLayer** | + | == Parameters == |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | **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:Type |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | <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.// |
| - | **canvas** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * //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.// |
| - | * **Description**:N/A | + | |
| - | **drawingExtent** | + | == Return Value == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:None |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === DrawSample(GeoCanvas) === | + | * //features// |
| - | N/A | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== Remarks ==== | + | * Description:This parameter represents the features you want to draw on the canvas. |
| - | N/A | + | |
| - | **Return Value** | + | * //canvas// |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | * **Description**:N/A | + | * Description:This parameter represents the canvas you want to draw the features on. |
| - | ==== Parameters ==== | + | * //labelsInThisLayer// |
| - | **canvas** | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Description:The labels will be drawn in the current layer only. |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | * //labelsInAllLayers// |
| - | === Equals(Object) === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | N/A | + | * Description:The labels will be drawn in all layers. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Boolean | + | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **obj** | + | == Remarks == |
| - | * **Type**:Object | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === GetHashCode() === | + | * Type:Void |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Int32 | + | * //canvas// |
| - | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | * //drawingExtent// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
| - | === GetRequiredColumnNames() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Collection<String> | + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetType() === | + | * //N/A// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Type | + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === SaveStyle(String) === | + | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **filePathName** | + | * Type:Collection<String> |
| - | * **Type**:String | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === SaveStyle(Stream) === | + | <div newline></div> |
| - | N/A | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | ==== 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() === | + | <div newline></div> |
| - | N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:String | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Object |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | === CloneDeepCore() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.Style|Style]] | + | <div newline></div> |
| - | * **Description**:N/A | + | ==== Public Properties ==== |
| + | ** {{wiki:PublicProperty.gif|}} NumberOfColors ** | ||
| - | ==== Parameters ==== | + | This gets or sets the number of colors in the style. |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | === DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === | + | None. |
| - | This method draws the features on the canvas you provided. | + | == Return Value == |
| - | ==== Remarks ==== | + | * Type:Int32 |
| - | 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** | + | ** {{wiki:PublicProperty.gif|}} Cache ** |
| - | * **Return Type**:Void | + | |
| - | * **Description**:None | + | |
| - | ==== Parameters ==== | + | This gets the cached style in the class. |
| - | **features** | + | == Remarks == |
| - | * **Type**:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | + | This gets the cached style in the class. The key of the style in the cache is feature.Id & feature.GetHashCode(). |
| - | * **Description**:This parameter represents the features you want to draw on the canvas. | + | == Return Value == |
| + | * Type:Dictionary<String,[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | ||
| - | **canvas** | + | ** {{wiki:PublicProperty.gif|}} BaseColor ** |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | |
| - | * **Description**:This parameter represents the canvas you want to draw the features on. | + | |
| - | **labelsInThisLayer** | + | This gets or sets the base color of the style. |
| - | * **Type**:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | == Remarks == |
| - | * **Description**:The labels will be drawn in the current layer only. | + | None. |
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | ||
| - | **labelsInAllLayers** | + | ** {{wiki:PublicProperty.gif|}} XOffsetInPixel ** |
| - | * **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 | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} YOffsetInPixel ** |
| - | * **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 | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} FillSolidBrush ** |
| - | * **Return Type**:Void | + | |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === GetRequiredColumnNamesCore() === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} CustomAreaStyles ** |
| - | * **Return Type**:Collection<String> | + | |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === MemberwiseClone() === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | ||
| - | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} OutlinePen ** |
| - | * **Return Type**:Object | + | |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | === Advanced === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.AreaStyleAdvanced|AreaStyleAdvanced]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} PenBrushDrawingOrder ** |
| - | === BaseColor === | + | |
| - | This gets or sets the base color of the style. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === Cache === | ||
| - | This gets the cached style in the class. | ||
| - | ==== Remarks ==== | ||
| - | This gets the cached style in the class. The key of the style in the cache is feature.Id & feature.GetHashCode(). | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Dictionary<String,[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === CustomAreaStyles === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | + | * Type:[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} Advanced ** |
| - | === DrawingLevel === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === FillSolidBrush === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | + | * Type:[[ThinkGeo.MapSuite.Core.AreaStyleAdvanced|AreaStyleAdvanced]] |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} DrawingLevel ** |
| - | === Filters === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Collection<String> | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === IsActive === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === Name === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:String | + | * Type:String |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} IsActive ** |
| - | === NumberOfColors === | + | |
| - | This gets or sets the number of colors in the style. | + | |
| - | ==== Remarks ==== | + | |
| - | None. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Int32 | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === OutlinePen === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | + | * Type:Boolean |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** |
| - | === PenBrushDrawingOrder === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | + | |
| - | [[#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> |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Filters ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === XOffsetInPixel === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:Collection<String> |
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ** {{wiki:ProtectedProperty.gif|}} IsDefault ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === YOffsetInPixel === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:Boolean |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** |
| - | ===== Protected Properties ===== | + | |
| - | === FiltersCore === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Collection<String> | + | |
| - | [[#Protected Properties|Go Back]] | ||
| - | === uBs= === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Collection<String> |
| - | [[#Protected Properties|Go Back]] | + | ==== Public Events ==== |
| - | ===== Public Events ===== | + | |