AdornmentOverlay¶
Inheritance Hierarchy¶
ObjectOverlayAdornmentOverlay
Members Summary¶
Public Constructors Summary¶
| Name | Description |
|---|---|
AdornmentOverlay() | Initializes a new instance of the class. |
Protected Constructors Summary¶
| Name | Description |
|---|---|
| N/A | N/A |
Public Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
Attribution | String | N/A |
AutoRefreshInterval | TimeSpan | N/A |
CanRefreshRegion | Boolean | N/A |
DrawingExceptionMode | DrawingExceptionMode | N/A |
DrawingQuality | DrawingQuality | N/A |
IsEmpty | Boolean | N/A |
IsVisible | Boolean | N/A |
Layers | GeoCollection<AdornmentLayer> | N/A |
MapArguments | MapArguments | N/A |
Name | String | N/A |
Opacity | Double | N/A |
OverlayView | MapLayout | N/A |
Protected Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
| Name | Event Arguments | Description |
|---|---|---|
DrawingException | DrawingExceptionOverlayEventArgs | N/A |
DrawnException | DrawnExceptionOverlayEventArgs | N/A |
Members Detail¶
Public Constructors¶
| Name | Description |
|---|---|
AdornmentOverlay() | Initializes a new instance of the class. |
Protected Constructors¶
Public Properties¶
Attribution¶
Summary
N/A
Remarks
N/A
Return Value
String
AutoRefreshInterval¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
CanRefreshRegion¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
DrawingExceptionMode¶
Summary
N/A
Remarks
N/A
Return Value
DrawingQuality¶
Summary
N/A
Remarks
N/A
Return Value
IsEmpty¶
Summary
N/A
Remarks
This property enhances the performance of the overlay while drawing. If is true, we will skip drawing this overlay and continue drawing the next overlay.
Return Value
Boolean
IsVisible¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
Layers¶
Summary
N/A
Remarks
N/A
Return Value
GeoCollection<AdornmentLayer>
MapArguments¶
Summary
N/A
Remarks
N/A
Return Value
Name¶
Summary
N/A
Remarks
N/A
Return Value
String
Opacity¶
Summary
N/A
Remarks
N/A
Return Value
Double
OverlayView¶
Summary
N/A
Remarks
N/A
Return Value
Protected Properties¶
Public Methods¶
Close()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Dispose()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Draw(MapArguments,OverlayRefreshType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments | N/A |
| refreshType | OverlayRefreshType | N/A |
Equals(Object)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | N/A |
GetBoundingBox()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetHashCode()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Int32 | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetType()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Type | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Initialize(MapArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments | N/A |
Open()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
PostTransform(TransformArguments,MapArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| transformInfo | TransformArguments | N/A |
| mapArguments | MapArguments | N/A |
Refresh()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Refresh(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extent | RectangleShape | N/A |
Refresh(IEnumerable<RectangleShape>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
Refresh(TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan | N/A |
Refresh(TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
Refresh(RectangleShape,TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape | N/A |
| bufferTime | TimeSpan | N/A |
Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape | N/A |
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
Refresh(IEnumerable<RectangleShape>,TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
| bufferTime | TimeSpan | N/A |
Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
ToString()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Protected Methods¶
CloseCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Dispose(Boolean)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| disposing | Boolean | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
DrawCore(MapArguments,OverlayRefreshType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments | This parameter maintains current map information for calculating mechanism. |
| refreshType | OverlayRefreshType | This parameter indicates whether the elements of this overlay needs to be refreshed. For example, TileOverlay is formed by tiles. When panning the map around, the existing tile doesn't need to be redraw, the only thing we need to do is modifying the position of these tiles. On another hand, when click to change the style of the overlay, we need to redraw the tile images to change the appearance. So we need refresh mode. |
DrawException(GeoCanvas,Exception)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| geoCanvas | GeoCanvas | N/A |
| exception | Exception | N/A |
DrawExceptionCore(GeoCanvas,Exception)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| geoCanvas | GeoCanvas | N/A |
| ex | Exception | N/A |
Finalize()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetBoundingBoxCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
InitializeCore(MapArguments)¶
Summary
N/A
Remarks
When implementing this method, consider initializing the overlay canvas such as setting its z-index, setting current map reference to the CurrentMap property.
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments | This parameter maintains current map information for calculating mechanism. |
MemberwiseClone()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Object | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
OnDrawingException(DrawingExceptionOverlayEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawingExceptionOverlayEventArgs | N/A |
OnDrawnException(DrawnExceptionOverlayEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawnExceptionOverlayEventArgs | N/A |
OpenCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
PostTransformCore(TransformArguments,MapArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| transformInfo | TransformArguments | N/A |
| mapArguments | MapArguments | N/A |
RefreshCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
RefreshCore(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extent | RectangleShape | N/A |
Public Events¶
DrawingException¶
N/A
Remarks
N/A
Event Arguments
DrawingExceptionOverlayEventArgs
DrawnException¶
N/A
Remarks
N/A
Event Arguments