ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.core.yahoomapslayer
Table of Contents
ThinkGeo.MapSuite.Core.YahooMapsLayer
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –> Represents an object that encapsulates a Yahoo Map layer.
Remarks
This class uses Yahoo Static Maps API to implement url request.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.Core.Layer *ThinkGeo.MapSuite.Core.YahooMapsLayer
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 YahooMapsLayer | This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | ||
| YahooMapsLayer | String | This is the constructor the for the class. | |
| YahooMapsLayer | String, WebProxy |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| CloneDeep | Layer | Create a copy of Layer using the deep clone process. | |
| Close | Layer | This method closes the Layer and releases any resources it was using. | |
| Dispose | |||
| Draw | GeoCanvas, Collection<SimpleCandidate> | Layer | This method draws the Layer. |
| Equals | Object | Object | |
| GetBoundingBox | Layer | This method returns the bounding box of the Layer. | |
| GetHashCode | Object | ||
| GetType | Object | ||
| Open | Layer | This method opens the Layer so that it is initialized and ready to use. | |
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 CloneDeepCore | Layer | Create a copy of Layer using the deep clone process. The default implemenation uses serialization. | |
| CloseCore | Layer(overriden) | This method closes the Layer and releases any resources it was using. | |
| Dispose | Boolean | ||
| DrawCore | GeoCanvas, Collection<SimpleCandidate> | Layer(overriden) | This method draws the Layer. |
| DrawException | GeoCanvas, Exception | Layer | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. |
| DrawExceptionCore | GeoCanvas, Exception | Layer | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. |
| Finalize | Object | ||
| GetBoundingBoxCore | Layer | This method returns the bounding box of the Layer. | |
| MemberwiseClone | Object | ||
| OnDrawingProgressChanged | DrawingProgressChangedEventArgs | Layer | |
| OpenCore | Layer(overriden) | This method opens the Layer so that it is initialized and ready to use. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 DrawingExceptionMode | DrawingExceptionMode | Layer | Gets or sets the DrawExcpetionMode when exception happens. |
| DrawingTime | TimeSpan | Layer | This property gets the last drawing time for the layer. |
| HasBoundingBox | Boolean | Layer | This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. |
| IsOpen | Boolean | Layer | This property returns true if the Layer is open and false if it is not. |
| IsVisible | Boolean | Layer | This property gets and set the visible state of the layer. |
| LicenseKey | String | Gets or sets a value represents the license key for YahooMaps API. | |
| Name | String | Layer | This property gets and sets the name for the layer. |
| PictureFormat | YahooMapsPictureFormat | Gets or sets a value represents the image format of the image. | |
| WebProxy | WebProxy | This property gets or sets the proxy used for requesting a Web Response. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 IsOpenCore | Boolean | Layer | This property returns true if the Layer is open and false if it is not. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 DrawingProgressChanged | DrawingProgressChangedEventArgs | Layer |
Public Constructors
YahooMapsLayer()
This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually.
Overloads
This is the default constructor.
Parameters
| Name | Type | Description |
|---|
YahooMapsLayer(String)
This is the constructor the for the class.
Remarks
This constructor initializes a new layer and assgin a license key.
Parameters
| Name | Type | Description |
|---|---|---|
| licenseKey | String<!– System.String –> | license key of the Yahoo Static Maps API. |
YahooMapsLayer(String, WebProxy)
Parameters
| Name | Type | Description |
|---|---|---|
| licenseKey | String<!– System.String –> | |
| webProxy | WebProxy<!– System.Net.WebProxy –> |
Protected Constructors
Public Methods
CloneDeep()
Create a copy of Layer using the deep clone process.
Remarks
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Value
| Return Type | Description |
|---|---|
| Layer<!– ThinkGeo.MapSuite.Core.Layer –> | A cloned Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Close()
This method closes the Layer and releases any resources it was using.
Remarks
This method is the concrete wrapper for the abstract method CloseCore. 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 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.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Dispose()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.YahooMapsLayer –> Go Back
Draw(GeoCanvas, Collection<SimpleCandidate>)
This method draws the Layer.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object or a GeoImage to draw on. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | This parameter represents the labels used for collision detection and duplication checking. |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetBoundingBox()
This method returns the bounding box of the Layer.
Remarks
This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box of the Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Open()
This method opens the Layer so that it is initialized and ready to use.
Remarks
This method is the concrete wrapper for the abstract method OpenCore. 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, the layer will be opened 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.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
CloneDeepCore()
Create a copy of Layer using the deep clone process. The default implemenation uses serialization.
Remarks
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Value
| Return Type | Description |
|---|---|
| Layer<!– ThinkGeo.MapSuite.Core.Layer –> | A cloned Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
CloseCore()
This method closes the Layer and releases any resources it was using.
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 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 Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
Dispose(Boolean)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| disposing | Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.YahooMapsLayer –> Go Back
DrawCore(GeoCanvas, Collection<SimpleCandidate>)
This method draws the Layer.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. 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 that 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 Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object or a GeoImage to draw on. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | This parameter represents the labels used for collision detection and duplication checking. |
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
DrawException(GeoCanvas, Exception)
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Remarks
This method can be overriden its logic by rewrite the DrawExceptionCore.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | The target canvas to draw the layer. |
| e | Exception<!– System.Exception –> | The exception thrown when layer.Draw(). |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawExceptionCore(GeoCanvas, Exception)
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | The target canvas to draw the layer. |
| e | Exception<!– System.Exception –> | The exception thrown when layer.Draw(). |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetBoundingBoxCore()
This method returns the bounding box of the Layer.
Remarks
This method returns the bounding box of the Layer.
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box of the Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
OpenCore()
This method opens the Layer so that it is initialized and ready to use.
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, the layer will be opened 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 Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Layer(overriden) –> Go Back
Public Properties
DrawingExceptionMode
Gets or sets the DrawExcpetionMode when exception happens.
Return Value
| Return Type |
|---|
| DrawingExceptionMode<!– ThinkGeo.MapSuite.Core.DrawingExceptionMode –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
DrawingTime
This property gets the last drawing time for the layer.
Remarks
We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
HasBoundingBox
This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.
Remarks
The default value is false.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
IsOpen
This property returns true if the Layer is open and false if it is not.
Remarks
This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
IsVisible
This property gets and set the visible state of the layer.
Remarks
If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
LicenseKey
Gets or sets a value represents the license key for YahooMaps API.
Remarks
The Yahoo Maps API lets you embed Yahoo Maps in your own application. A single Maps API key is valid for a single “directory” or domain. If the license type is premier, it repesents client id, eg “gme-yourclientid”.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.YahooMapsLayer –> Go Back
Name
This property gets and sets the name for the layer.
Remarks
The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
PictureFormat
Gets or sets a value represents the image format of the image.
Return Value
| Return Type |
|---|
| YahooMapsPictureFormat<!– ThinkGeo.MapSuite.Core.YahooMapsPictureFormat –> |
<!– ThinkGeo.MapSuite.Core.YahooMapsLayer –> Go Back
WebProxy
This property gets or sets the proxy used for requesting a Web Response.
Return Value
| Return Type |
|---|
| WebProxy<!– System.Net.WebProxy –> |
<!– ThinkGeo.MapSuite.Core.YahooMapsLayer –> Go Back
Protected Properties
IsOpenCore
This property returns true if the Layer is open and false if it is not.
Remarks
Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
Public Events
DrawingProgressChanged
Event Arguments
| Event Arguments |
|---|
| DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.Core.Layer –> Go Back
NOTOC MapSuiteCore ThinkGeo.MapSuite.Core UpdateDocumentation
thinkgeo.mapsuite.core.yahoomapslayer.txt · Last modified: 2017/03/16 21:59 (external edit)