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