thinkgeo.mapsuite.core.areastyle
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.areastyle [2015/09/18 05:38] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.AreaStyle ====== | ||
| - | This class is used to draw area features. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | *ThinkGeo.MapSuite.Core.Style | ||
| - | ***ThinkGeo.MapSuite.Core.AreaStyle** | ||
| - | *[[ThinkGeo.MapSuite.Core.HueFamilyAreaStyle]] | ||
| - | *[[ThinkGeo.MapSuite.Core.QualityFamilyAreaStyle]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} AreaStyle() ** | ||
| - | |||
| - | This is the constructor for the class. | ||
| - | == Remarks == | ||
| - | If you use this constructor, you will need to set the properties of the fill brush and outline pen manually. | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoSolidBrush) ** | ||
| - | |||
| - | This is the constructor for the class. | ||
| - | == Remarks == | ||
| - | This constructor allows you to specify just a fill brush. In this way, the area you draw will not have an outline. | ||
| - | == Parameters == | ||
| - | * //fillSolidBrush// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| - | * Description:This parameter is the solid brush you want to fill the area with. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen) ** | ||
| - | |||
| - | This is the constructor for the class. | ||
| - | == Remarks == | ||
| - | This constructor allows you to specify just an outline pen. In this way, the area you draw will have an outline, but a transparent interior (no fill). | ||
| - | == Parameters == | ||
| - | * //outlinePen// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | ||
| - | * Description:This parameter is the outline pen you want to use to outline the area. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen,GeoSolidBrush) ** | ||
| - | |||
| - | This is the constructor for the class. | ||
| - | == Remarks == | ||
| - | This constructor allows you to specify a fill brush and an outline pen. | ||
| - | == Parameters == | ||
| - | * //outlinePen// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | ||
| - | * Description:This parameter is the outline pen you want to use to outline the area. | ||
| - | |||
| - | * //fillSolidBrush// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| - | * Description:This parameter is the solid brush you wish to fill the area with. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen,GeoSolidBrush,PenBrushDrawingOrder) ** | ||
| - | |||
| - | This is the constructor for the class. | ||
| - | == Remarks == | ||
| - | This constructor allows you to specify a fill brush and an outline pen. It also allows you to specify which is drawn first. If the pen is drawn first, the outline will be thinner than if the pen is drawn last. The effect is subtle but noticeable. | ||
| - | == Parameters == | ||
| - | * //outlinePen// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | ||
| - | * Description:This parameter is the outline pen you want to use to outline the area. | ||
| - | |||
| - | * //fillSolidBrush// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| - | * Description:This parameter is the solid brush you wish to fill the area with. | ||
| - | |||
| - | * //penBrushDrawingOrder// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | ||
| - | * Description:This parameter allows you to choose whether the outline pen or the fill brush is drawn first. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{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) ** | ||
| - | |||
| - | This method draws a sample feature on the canvas you provided. | ||
| - | == Remarks == | ||
| - | This virtual method is called from the concrete public method Draw. In this method, we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area. When implementing this virtual method, consider the canvas size and draw the sample image appropriately. You should keep in mind that the sample typically shows up on a legend. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:This parameter represents the canvas you want to draw the features on. | ||
| - | |||
| - | * //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|}} XOffsetInPixel ** | ||
| - | |||
| - | This property gets and sets the X pixel offset for drawing each feature. | ||
| - | == Remarks == | ||
| - | This property allows you to specify an X offset. When combined with a Y offset, it enables you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to align it with raster satellite data. | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} YOffsetInPixel ** | ||
| - | |||
| - | This property gets and sets the Y pixel offset for drawing each feature. | ||
| - | == Remarks == | ||
| - | This property allows you to specify a Y offset. When combined with an X offset, it enables you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to align it with raster satellite data. | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} FillSolidBrush ** | ||
| - | |||
| - | This property gets and sets the solid brush you want to use to fill in the area features. | ||
| - | == Remarks == | ||
| - | This solid brush is used to fill in the area features that will draw. You can also optionally specify an outline pen to give the area an outline. The default solid brush has a fill color of transparent, which means it will not draw anything. | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CustomAreaStyles ** | ||
| - | |||
| - | This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other. | ||
| - | == Remarks == | ||
| - | Using this collection, you can stack multiple area styles on top of each other. When we draw the features, we will draw them in order that they exist in the collection. You can use these stacks to create drop shadow effects, multiple colored outlines, etc. | ||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} OutlinePen ** | ||
| - | |||
| - | This property gets and sets the outline pen you want to use to outline the features. | ||
| - | == Remarks == | ||
| - | This outline pen is used to outline the features that will draw. You can also optionally specify a fill brush to give the area a solid fill. The default outline pen color is transparent, which means it will not draw anything. | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} PenBrushDrawingOrder ** | ||
| - | |||
| - | This property gets and sets the pen and brush drawing order. | ||
| - | == Remarks == | ||
| - | This property controls whether the outline pen or the fill brush is drawn first. The default is for the fill brush to be drawn first. If you have the outline pen draw first then the thickness of the pen will be smaller, creating a subtle but noticeable effect. | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Advanced ** | ||
| - | |||
| - | This property lets you access the advanced properties of the style. | ||
| - | == Remarks == | ||
| - | This property lets you access the advanced properties of the style. | ||
| - | == 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|}} uBs= ** | ||
| - | |||
| - | 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.areastyle.1442554683.txt.gz ยท Last modified: 2015/09/18 05:38 by admin
