This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.silverlightcore.grouplayer [2015/09/21 03:21] admin |
thinkgeo.mapsuite.silverlightcore.grouplayer [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.SilverlightCore.GroupLayer ====== | ====== ThinkGeo.MapSuite.SilverlightCore.GroupLayer ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This class represents a Layer backed by a group of layers. | This class represents a Layer backed by a group of layers. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 9: | Line 12: | ||
** {{wiki:PublicMethod.gif|}} GroupLayer() ** | ** {{wiki:PublicMethod.gif|}} GroupLayer() ** | ||
- | This is the default constructor for the class. | + | * //This is the default constructor for the class.// |
== Remarks == | == Remarks == | ||
- | This is the default constructor. If you use this constructor, then you need to set the required properties manually. | + | * //This is the default constructor. If you use this constructor, then you need to set the required properties manually.// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} GroupLayer(IEnumerable<Layer>) ** | ** {{wiki:PublicMethod.gif|}} GroupLayer(IEnumerable<Layer>) ** | ||
- | This is a constructor for the class. | + | * //This is a constructor for the class.// |
== Remarks == | == Remarks == | ||
- | This constructor gets the layer ready to use. | + | * //This constructor gets the layer ready to use.// |
== Parameters == | == Parameters == | ||
* //layers// | * //layers// | ||
Line 29: | Line 32: | ||
** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 41: | Line 44: | ||
** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 53: | Line 56: | ||
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 65: | Line 68: | ||
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 85: | Line 88: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 97: | Line 100: | ||
** {{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 113: | Line 116: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 125: | Line 128: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 138: | Line 141: | ||
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
- | This method opens the Layer so that it is initialized and ready to use. | + | * //This method opens the Layer so that it is initialized and ready to use.// |
== Remarks == | == Remarks == | ||
- | This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, it will open the layer as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer. | + | * //This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, it will open the layer as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.// |
== Return Value == | == Return Value == | ||
Line 150: | Line 153: | ||
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
- | This method closes the FeatureSource and releases any resources it was using. | + | * //This method closes the FeatureSource and releases any resources it was using.// |
== Remarks == | == Remarks == | ||
- | This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override the Core version of this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. | + | * //This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override the Core version of this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.// |
== Return Value == | == Return Value == | ||
Line 162: | Line 165: | ||
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
- | This method returns the bounding box of the Layer. | + | * //This method returns the bounding box of the Layer.// |
== Remarks == | == Remarks == | ||
- | This method returns the bounding box of the Layer. | + | * //This method returns the bounding box of the Layer.// |
== Return Value == | == Return Value == | ||
Line 174: | Line 177: | ||
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ||
- | This method draws the Layer. | + | * //This method draws the Layer.// |
== Remarks == | == Remarks == | ||
- | This abstract method is called from the concrete public method Draw. This method draws the representation of the layer based on the extent you provided. When implementing this abstract 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 abstract method is called from the concrete public method Draw. This method draws the representation of the layer based on the extent you provided. When implementing this abstract 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 194: | Line 197: | ||
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 214: | Line 217: | ||
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 234: | Line 237: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 250: | Line 253: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 262: | Line 265: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == |