Overlay &para;

IsBase¶

public bool IsBase { get; set; }

Property Value¶

MapArguments¶

Gets or sets current map information which will be used for calculating mechanism.

public IMapArguments MapArguments { get; set; }

Property Value¶

IMapArguments

OverlayCanvas¶

Gets or sets the actual canvas which maintains all the visual elements on the overlay.

public Canvas OverlayCanvas { get; }

Property Value¶

Canvas

DrawingExceptionMode¶

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

ThrowingExceptionMode¶

public ThrowingExceptionMode ThrowingExceptionMode { get; set; }

Property Value¶

ThrowingExceptionMode

IsVisible¶

Gets or sets if this overlay is visible.

public bool IsVisible { get; set; }

Property Value¶

Attribution¶

public string Attribution { get; set; }

Property Value¶

String

IsEmpty¶

This property gets if this overlay is empty or not.

public bool IsEmpty { get; }

Property Value¶

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.

AutoRefreshInterval¶

public TimeSpan AutoRefreshInterval { get; set; }

Property Value¶

TimeSpan

Background¶

public Brush Background { get; set; }

Property Value¶

Brush

Children¶

public UIElementCollection Children { get; }

Property Value¶

UIElementCollection

IsItemsHost¶

public bool IsItemsHost { get; set; }

Property Value¶

LogicalOrientationPublic¶

public Orientation LogicalOrientationPublic { get; }

Property Value¶

Orientation

HasLogicalOrientationPublic¶

public bool HasLogicalOrientationPublic { get; }

Property Value¶

Style¶

public Style Style { get; set; }

Property Value¶

Style

OverridesDefaultStyle¶

public bool OverridesDefaultStyle { get; set; }

Property Value¶

UseLayoutRounding¶

public bool UseLayoutRounding { get; set; }

Property Value¶

Triggers¶

public TriggerCollection Triggers { get; }

Property Value¶

TriggerCollection

TemplatedParent¶

public DependencyObject TemplatedParent { get; }

Property Value¶

DependencyObject

Resources¶

public ResourceDictionary Resources { get; set; }

Property Value¶

ResourceDictionary

DataContext¶

public object DataContext { get; set; }

Property Value¶

Object

BindingGroup¶

public BindingGroup BindingGroup { get; set; }

Property Value¶

BindingGroup

Language¶

public XmlLanguage Language { get; set; }

Property Value¶

XmlLanguage

Tag¶

public object Tag { get; set; }

Property Value¶

Object

InputScope¶

public InputScope InputScope { get; set; }

Property Value¶

InputScope

ActualWidth¶

public double ActualWidth { get; }

Property Value¶

ActualHeight¶

public double ActualHeight { get; }

Property Value¶

LayoutTransform¶

public Transform LayoutTransform { get; set; }

Property Value¶

Transform

Width¶

public double Width { get; set; }

Property Value¶

MinWidth¶

public double MinWidth { get; set; }

Property Value¶

MaxWidth¶

public double MaxWidth { get; set; }

Property Value¶

Height¶

public double Height { get; set; }

Property Value¶

MinHeight¶

public double MinHeight { get; set; }

Property Value¶

MaxHeight¶

public double MaxHeight { get; set; }

Property Value¶

FlowDirection¶

public FlowDirection FlowDirection { get; set; }

Property Value¶

FlowDirection

Margin¶

public Thickness Margin { get; set; }

Property Value¶

Thickness

HorizontalAlignment¶

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value¶

HorizontalAlignment

VerticalAlignment¶

public VerticalAlignment VerticalAlignment { get; set; }

Property Value¶

VerticalAlignment

FocusVisualStyle¶

public Style FocusVisualStyle { get; set; }

Property Value¶

Style

Cursor¶

public Cursor Cursor { get; set; }

Property Value¶

Cursor

ForceCursor¶

public bool ForceCursor { get; set; }

Property Value¶

IsInitialized¶

public bool IsInitialized { get; }

Property Value¶

IsLoaded¶

public bool IsLoaded { get; }

Property Value¶

public object ToolTip { get; set; }

Property Value¶

Object

ContextMenu¶

public ContextMenu ContextMenu { get; set; }

Property Value¶

ContextMenu

Parent¶

public DependencyObject Parent { get; }

Property Value¶

DependencyObject

HasAnimatedProperties¶

public bool HasAnimatedProperties { get; }

Property Value¶

InputBindings¶

public InputBindingCollection InputBindings { get; }

Property Value¶

InputBindingCollection

CommandBindings¶

public CommandBindingCollection CommandBindings { get; }

Property Value¶

CommandBindingCollection

AllowDrop¶

public bool AllowDrop { get; set; }

Property Value¶

DesiredSize¶

public Size DesiredSize { get; }

Property Value¶

Size

IsMeasureValid¶

public bool IsMeasureValid { get; }

Property Value¶

IsArrangeValid¶

public bool IsArrangeValid { get; }

Property Value¶

RenderSize¶

public Size RenderSize { get; set; }

Property Value¶

Size

RenderTransform¶

public Transform RenderTransform { get; set; }

Property Value¶

Transform

RenderTransformOrigin¶

public Point RenderTransformOrigin { get; set; }

Property Value¶

Point

IsMouseDirectlyOver¶

public bool IsMouseDirectlyOver { get; }

Property Value¶

IsMouseOver¶

public bool IsMouseOver { get; }

Property Value¶

IsStylusOver¶

public bool IsStylusOver { get; }

Property Value¶

IsKeyboardFocusWithin¶

public bool IsKeyboardFocusWithin { get; }

Property Value¶

IsMouseCaptured¶

public bool IsMouseCaptured { get; }

Property Value¶

IsMouseCaptureWithin¶

public bool IsMouseCaptureWithin { get; }

Property Value¶

IsStylusDirectlyOver¶

public bool IsStylusDirectlyOver { get; }

Property Value¶

IsStylusCaptured¶

public bool IsStylusCaptured { get; }

Property Value¶

IsStylusCaptureWithin¶

public bool IsStylusCaptureWithin { get; }

Property Value¶

IsKeyboardFocused¶

public bool IsKeyboardFocused { get; }

Property Value¶

IsInputMethodEnabled¶

public bool IsInputMethodEnabled { get; }

Property Value¶

Opacity¶

public double Opacity { get; set; }

Property Value¶

OpacityMask¶

public Brush OpacityMask { get; set; }

Property Value¶

Brush

BitmapEffect¶

public BitmapEffect BitmapEffect { get; set; }

Property Value¶

BitmapEffect

Effect¶

public Effect Effect { get; set; }

Property Value¶

Effect

BitmapEffectInput¶

public BitmapEffectInput BitmapEffectInput { get; set; }

Property Value¶

BitmapEffectInput

CacheMode¶

public CacheMode CacheMode { get; set; }

Property Value¶

CacheMode

Uid¶

public string Uid { get; set; }

Property Value¶

String

Visibility¶

public Visibility Visibility { get; set; }

Property Value¶

Visibility

ClipToBounds¶

public bool ClipToBounds { get; set; }

Property Value¶

Clip¶

public Geometry Clip { get; set; }

Property Value¶

Geometry

SnapsToDevicePixels¶

public bool SnapsToDevicePixels { get; set; }

Property Value¶

IsFocused¶

public bool IsFocused { get; }

Property Value¶

IsEnabled¶

public bool IsEnabled { get; set; }

Property Value¶

IsHitTestVisible¶

public bool IsHitTestVisible { get; set; }

Property Value¶

Focusable¶

public bool Focusable { get; set; }

Property Value¶

PersistId¶

public int PersistId { get; }

Property Value¶

Int32

IsManipulationEnabled¶

public bool IsManipulationEnabled { get; set; }

Property Value¶

AreAnyTouchesOver¶

public bool AreAnyTouchesOver { get; }

Property Value¶

AreAnyTouchesDirectlyOver¶

public bool AreAnyTouchesDirectlyOver { get; }

Property Value¶

AreAnyTouchesCapturedWithin¶

public bool AreAnyTouchesCapturedWithin { get; }

Property Value¶

AreAnyTouchesCaptured¶

public bool AreAnyTouchesCaptured { get; }

Property Value¶

TouchesCaptured¶

public IEnumerable<TouchDevice> TouchesCaptured { get; }

Property Value¶

TouchesCapturedWithin¶

public IEnumerable<TouchDevice> TouchesCapturedWithin { get; }

Property Value¶

TouchesOver¶

public IEnumerable<TouchDevice> TouchesOver { get; }

Property Value¶

TouchesDirectlyOver¶

public IEnumerable<TouchDevice> TouchesDirectlyOver { get; }

Property Value¶

DependencyObjectType¶

public DependencyObjectType DependencyObjectType { get; }

Property Value¶

DependencyObjectType

IsSealed¶

public bool IsSealed { get; }

Property Value¶

Dispatcher¶

public Dispatcher Dispatcher { get; }

Property Value¶

Dispatcher

Methods¶

CreateDefaultGeoCanvas()¶

protected GeoCanvas CreateDefaultGeoCanvas()

Returns¶

GeoCanvas

CreateDefaultGeoCanvasCore()¶

protected GeoCanvas CreateDefaultGeoCanvasCore()

Returns¶

GeoCanvas

Initialize(IMapArguments)¶

This method initializes overlay object.

public void Initialize(IMapArguments mapArguments)

Parameters¶

mapArguments IMapArguments
This parameter maintains current map information for calculating mechanism.

Remarks:

This is a wrapper method for the virtual method InitializeCore.

InitializeCore(IMapArguments)¶

This method initializes overlay object.

protected void InitializeCore(IMapArguments mapArguments)

Parameters¶

mapArguments IMapArguments
This parameter maintains current map information for calculating mechanism.

Remarks:

When implementing this method, consider initializing the overlay canvas such as setting its z-index, setting current map reference to the CurrentMap property.

RefreshAsync(RectangleShape, CancellationToken)¶

public Task RefreshAsync(RectangleShape extent, CancellationToken cancellationToken)

Parameters¶

extent RectangleShape

cancellationToken CancellationToken

Returns¶

RefreshAsyncCore(RectangleShape, CancellationToken)¶

protected Task RefreshAsyncCore(RectangleShape extent, CancellationToken cancellationToken)

Parameters¶

extent RectangleShape

cancellationToken CancellationToken

Returns¶

RefreshAsync(CancellationToken)¶

This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

public Task RefreshAsync(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken

Returns¶

Remarks:

The difference from Draw() method is that Refresh() method refreshes all the elements while Draw() does not.

RefreshAsyncCore(CancellationToken)¶

This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

protected Task RefreshAsyncCore(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken

Returns¶

Remarks:

The difference from DrawAsync() method is that RefreshAsync() method refreshes all the elements while DrawAsync() does not.

CloseAsync()¶

public Task CloseAsync()

Returns¶

CloseAsyncCore()¶

protected Task CloseAsyncCore()

Returns¶

OpenAsync()¶

public Task OpenAsync()

Returns¶

OpenAsyncCore()¶

protected Task OpenAsyncCore()

Returns¶

DrawAsync(RectangleShape)¶

This method draws the overlay with the provided extent in world coordinate.

public Task DrawAsync(RectangleShape targetExtent)

Parameters¶

targetExtent RectangleShape
This parameter indicates an extent in world coordinate for drawing the overlay.

Returns¶

DrawAsync(RectangleShape, OverlayRefreshType, CancellationToken)¶

This method draws the overlay with the provided extent in world coordinate.

public Task DrawAsync(RectangleShape targetExtent, OverlayRefreshType refreshType, CancellationToken cancellationToken)

Parameters¶

targetExtent RectangleShape
This parameter indicates an extent in world coordinate for drawing the overlay.

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.

cancellationToken CancellationToken

Returns¶

Transform(RectangleShape)¶

public void Transform(RectangleShape targetExtent)

Parameters¶

targetExtent RectangleShape

TransformCore(RectangleShape)¶

protected void TransformCore(RectangleShape targetExtent)

Parameters¶

targetExtent RectangleShape

DrawAsyncCore(RectangleShape, OverlayRefreshType, CancellationToken)¶

This method draws the overlay with the provided extent in world coordinate.

protected Task DrawAsyncCore(RectangleShape targetExtent, OverlayRefreshType overlayRefreshType, CancellationToken cancellationToken)

Parameters¶

targetExtent RectangleShape
This parameter indicates an extent in world coordinate for drawing the overlay.

overlayRefreshType OverlayRefreshType

         This parameter indicates whether the elements of this overlay needs to be refreshed.

         For example, TileOverlay is formed by tiles.
         When panning or zooming the map, the existing tile doesn't need to be redraw,
         because the styles are the same as the previous states.
         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.

cancellationToken CancellationToken

Returns¶

DrawAttribution(GeoCanvas)¶

internal void DrawAttribution(GeoCanvas canvas)

Parameters¶

canvas GeoCanvas

DrawAttributionCore(GeoCanvas)¶

protected void DrawAttributionCore(GeoCanvas canvas)

Parameters¶

canvas GeoCanvas

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)¶

protected void OnDrawingAttribution(DrawingAttributionOverlayEventArgs args)

Parameters¶

args DrawingAttributionOverlayEventArgs

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)¶

protected void OnDrawnAttribution(DrawnAttributionOverlayEventArgs args)

Parameters¶

args DrawnAttributionOverlayEventArgs

PanTo(RectangleShape)¶

This method pans the overlay to the provided world extent.

public void PanTo(RectangleShape targetExtent)

Parameters¶

targetExtent RectangleShape
This parameter is the target world extent for panning.

Remarks:

Some overlay doesn't need to continuously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

PanToCore(RectangleShape)¶

This method pans the overlay to the provided world extent.

protected void PanToCore(RectangleShape targetExtent)

Parameters¶

targetExtent RectangleShape
This parameter is the target world extent for panning.

Remarks:

Some overlay doesn't need to continuously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

OnDrawing(DrawingOverlayEventArgs)¶

This method raises before the overlay is drawing.

protected void OnDrawing(DrawingOverlayEventArgs e)

Parameters¶

e DrawingOverlayEventArgs
This parameter is the event argument for Drawing event.

OnDrawn(DrawnOverlayEventArgs)¶

This method raises after the overlay is drawn.

protected void OnDrawn(DrawnOverlayEventArgs e)

Parameters¶

e DrawnOverlayEventArgs
This parameter is the event argument for Drawn event.

GetBoundingBox()¶

This method gets a bounding box of the Overlay.

public RectangleShape GetBoundingBox()

Returns¶

RectangleShape
A RectangleShape indicating the bounding box of this overlay

Remarks:

This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the Overlay.

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.

GetBoundingBoxCore()¶

This method returns the bounding box of the Overlay.

protected RectangleShape GetBoundingBoxCore()

Returns¶

RectangleShape
This method returns the bounding box of the Overlay.

Remarks:

This method returns the bounding box of the Overlay.

SaveState()¶

This method saves overlay state to a byte array.

public Byte[] SaveState()

Returns¶

Byte[]
A byte array indicates current overlay state.

SaveStateCore()¶

This method saves overlay state to a byte array.

protected Byte[] SaveStateCore()

Returns¶

Byte[]
A byte array indicates current overlay state.

LoadState(Byte[])¶

This method restore the overlay state back from the specified state.

public void LoadState(Byte[] state)

Parameters¶

state Byte[]
This parameter indicates the state for restore the overlay.

LoadStateCore(Byte[])¶

This method restore the overlay state back from the specified state.

protected void LoadStateCore(Byte[] state)

Parameters¶

state Byte[]
This parameter indicates the state for restore the overlay.

Finalize()¶

Finalizer of this Overlay object.

protected void Finalize()

Dispose()¶

This method dispose unmanaged resource used in this class.

public void Dispose()

Dispose(Boolean)¶

This method dispose unmanaged resource used in this class.

protected void Dispose(bool disposing)

Parameters¶

disposing Boolean

OnDrawingExceptionModeChanged()¶

internal void OnDrawingExceptionModeChanged()

OnThrowingException(ThrowingExceptionOverlayEventArgs)¶

protected void OnThrowingException(ThrowingExceptionOverlayEventArgs e)

Parameters¶

e ThrowingExceptionOverlayEventArgs

RefreshAsync(IEnumerable<RectangleShape>)¶

public Task RefreshAsync(IEnumerable<RectangleShape> extentsToRefresh)

Parameters¶

extentsToRefresh IEnumerable<RectangleShape>

Returns¶

RefreshAsync(TimeSpan)¶

public Task RefreshAsync(TimeSpan bufferTime)

Parameters¶

bufferTime TimeSpan

Returns¶

RefreshAsync(TimeSpan, RequestDrawingBufferTimeType)¶

public Task RefreshAsync(TimeSpan bufferTime, RequestDrawingBufferTimeType bufferTimeType)

Parameters¶

bufferTime TimeSpan

bufferTimeType RequestDrawingBufferTimeType

Returns¶

RefreshAsync(RectangleShape, TimeSpan)¶

public Task RefreshAsync(RectangleShape extentToRefresh, TimeSpan bufferTime)

Parameters¶

extentToRefresh RectangleShape

bufferTime TimeSpan

Returns¶

RefreshAsync(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)¶

public Task RefreshAsync(RectangleShape extentToRefresh, TimeSpan bufferTime, RequestDrawingBufferTimeType bufferTimeType)

Parameters¶

extentToRefresh RectangleShape

bufferTime TimeSpan

bufferTimeType RequestDrawingBufferTimeType

Returns¶

RefreshAsync(IEnumerable<RectangleShape>, TimeSpan)¶

public Task RefreshAsync(IEnumerable<RectangleShape> extentsToRefresh, TimeSpan bufferTime)

Parameters¶

extentsToRefresh IEnumerable<RectangleShape>

bufferTime TimeSpan

Returns¶

RefreshAsync(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)¶

public Task RefreshAsync(IEnumerable<RectangleShape> extentsToRefresh, TimeSpan bufferTime, RequestDrawingBufferTimeType bufferTimeType)

Parameters¶

extentsToRefresh IEnumerable<RectangleShape>

bufferTime TimeSpan

bufferTimeType RequestDrawingBufferTimeType

Returns¶