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/21 01:00] admin |
thinkgeo.mapsuite.core.areastyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.AreaStyle ====== | ====== ThinkGeo.MapSuite.Core.AreaStyle ====== | ||
| + | |||
| + | {{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 11: | Line 14: | ||
| ** {{wiki:PublicMethod.gif|}} AreaStyle() ** | ** {{wiki:PublicMethod.gif|}} AreaStyle() ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | If you use this constructor, you will need to set the properties of the fill brush and outline pen manually. | + | * //If you use this constructor, you will need to set the properties of the fill brush and outline pen manually.// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoSolidBrush) ** | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoSolidBrush) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | This constructor allows you to specify just a fill brush. In this way, the area you draw will not have an outline. | + | * //This constructor allows you to specify just a fill brush. In this way, the area you draw will not have an outline.// |
| == Parameters == | == Parameters == | ||
| * //fillSolidBrush// | * //fillSolidBrush// | ||
| Line 29: | Line 32: | ||
| ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen) ** | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == 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). | + | * //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 == | == Parameters == | ||
| * //outlinePen// | * //outlinePen// | ||
| Line 40: | Line 43: | ||
| ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen,GeoSolidBrush) ** | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen,GeoSolidBrush) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | This constructor allows you to specify a fill brush and an outline pen. | + | * //This constructor allows you to specify a fill brush and an outline pen.// |
| == Parameters == | == Parameters == | ||
| * //outlinePen// | * //outlinePen// | ||
| Line 55: | Line 58: | ||
| ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen,GeoSolidBrush,PenBrushDrawingOrder) ** | ** {{wiki:PublicMethod.gif|}} AreaStyle(GeoPen,GeoSolidBrush,PenBrushDrawingOrder) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == 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. | + | * //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 == | == Parameters == | ||
| * //outlinePen// | * //outlinePen// | ||
| Line 76: | Line 79: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 88: | Line 91: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 116: | Line 119: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 144: | Line 147: | ||
| ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 156: | Line 159: | ||
| ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 176: | Line 179: | ||
| ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 187: | Line 190: | ||
| * //canvas// | * //canvas// | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * 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 | * Description:N/A | ||
| Line 192: | Line 227: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 204: | Line 239: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 220: | Line 255: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 232: | Line 267: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 245: | Line 280: | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method draws the features on the canvas you provided. | + | * //This method draws the features on the canvas you provided.// |
| == Remarks == | == 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. | + | * //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 == | == Return Value == | ||
| Line 273: | Line 308: | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ||
| - | This method draws a sample feature on the canvas you provided. | + | * //This method draws a sample feature on the canvas you provided.// |
| == Remarks == | == 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. | + | * //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 == | == Return Value == | ||
| Line 293: | Line 328: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 305: | Line 340: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 317: | Line 352: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 329: | Line 364: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 437: | Line 472: | ||
| ==== Protected Properties ==== | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} e2U= ** | + | ** {{wiki:ProtectedProperty.gif|}} IsDefault ** |
| N/A | N/A | ||
thinkgeo.mapsuite.core.areastyle.1442797258.txt.gz ยท Last modified: 2015/09/21 01:00 by admin