InteractiveOverlay¶
Inheritance Hierarchy¶
ObjectOverlayInteractiveOverlayEditInteractiveOverlayExtentInteractiveOverlayTrackInteractiveOverlay
Members Summary¶
Public Constructors Summary¶
| Name | Description |
|---|---|
| N/A | N/A |
Protected Constructors Summary¶
| Name | Description |
|---|---|
InteractiveOverlay() | Default constructor of this abstract class. |
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 |
InteractiveView | TileView | N/A |
IsEmpty | Boolean | N/A |
IsVisible | Boolean | 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 |
|---|---|
| N/A | N/A |
Protected Constructors¶
InteractiveOverlay()¶
Summary
Default constructor of this abstract class.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
| N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
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
InteractiveView¶
Summary
N/A
Remarks
N/A
Return Value
IsEmpty¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsVisible¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
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 |
DoubleTap(InteractionArguments)¶
Summary
N/A
Remarks
This method is the concrete wrapper for its virtual Core method. 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
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
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 |
LongPress(InteractionArguments)¶
Summary
N/A
Remarks
This method is the concrete wrapper for its virtual Core method. 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
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
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 |
SingleTap(InteractionArguments)¶
Summary
N/A
Remarks
This method is the concrete wrapper for its virtual Core method. 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
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
ToString()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
TouchDown(InteractionArguments)¶
Summary
N/A
Remarks
This method is the concrete wrapper for its virtual Core method. 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
| Type | Description |
|---|---|
InteractiveResult |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
TouchMove(InteractionArguments)¶
Summary
N/A
Remarks
This method is the concrete wrapper for its virtual Core method. 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
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
TouchPointerDown(InteractionArguments)¶
Summary
N/A
Remarks
This method is the concrete wrapper for its virtual Core method. 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
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
TouchRotate(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | N/A |
TouchUp(InteractionArguments)¶
Summary
N/A
Remarks
This method is the concrete wrapper for its virtual Core method. 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
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
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 | N/A |
DoubleTapCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
DrawCore(MapArguments,OverlayRefreshType)¶
Summary
N/A
Remarks
This method draws the representation of the overlay 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
| Type | Description |
|---|---|
Void | none |
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
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments | This parameter maintains current map information for calculating mechanism. |
LongPressCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
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 | This parameter maintains the transfrom information for calculating transform. |
| mapArguments | MapArguments | This parameter maintains current map information for calculating mechanism. |
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 |
SingleTapCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
TouchDownCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
TouchMoveCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
TouchPointerDownCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
TouchRotateCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | N/A |
TouchUpCore(InteractionArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
InteractiveResult | Interaction results of this method. |
Parameters
| Name | Type | Description |
|---|---|---|
| e | InteractionArguments | This parameter is the interaction auguments for the method. |
Public Events¶
DrawingException¶
N/A
Remarks
N/A
Event Arguments
DrawingExceptionOverlayEventArgs
DrawnException¶
N/A
Remarks
N/A
Event Arguments