WmtsOverlay¶

Namespace: ThinkGeo.UI.Maui

public class WmtsOverlay : WebBasedTileOverlay`1, System.ComponentModel.INotifyPropertyChanged, Microsoft.Maui.Controls.Internals.IDynamicResourceHandler, Microsoft.Maui.Controls.IElementDefinition, Microsoft.Maui.Controls.Internals.INameScope, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.IVisualTreeElement, Microsoft.Maui.IElement, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.IToolTipElement, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.Controls.IControlsElement, Microsoft.Maui.Controls.StyleSheets.IStyleSelectable, Microsoft.Maui.Controls.Internals.INavigationProxy, Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.Controls.IResourcesProvider, Microsoft.Maui.Controls.IStyleElement, Microsoft.Maui.Controls.IFlowDirectionController, Microsoft.Maui.Controls.IPropertyPropagationController, Microsoft.Maui.Controls.IVisualController, Microsoft.Maui.Controls.IWindowController, Microsoft.Maui.IView, Microsoft.Maui.ITransform, Microsoft.Maui.Controls.IControlsVisualElement, Microsoft.Maui.Controls.StyleSheets.IStylable, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.Controls.IControlsView, Microsoft.Maui.ILayout, Microsoft.Maui.IContainer, System.Collections.Generic.IList`1[[Microsoft.Maui.IView, Microsoft.Maui, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.ICollection`1[[Microsoft.Maui.IView, Microsoft.Maui, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.IEnumerable`1[[Microsoft.Maui.IView, Microsoft.Maui, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEnumerable, Microsoft.Maui.ISafeAreaView, Microsoft.Maui.IPadding, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.Controls.IBindableLayout, Microsoft.Maui.Controls.IPaddingElement, Microsoft.Maui.Controls.IInputTransparentContainerElement, Microsoft.Maui.IAbsoluteLayout, System.IDisposable

Inheritance Object → BindableObject → Element → NavigableElement → VisualElement → View → Layout → AbsoluteLayout → Overlay → TileOverlay → WebBasedTileOverlay<WmtsAsyncLayer> → WmtsOverlay
Implements INotifyPropertyChanged, IDynamicResourceHandler, IElementDefinition, INameScope, IElementController, IVisualTreeElement, IElement, IEffectControlProvider, IToolTipElement, IContextFlyoutElement, IControlsElement, IStyleSelectable, INavigationProxy, IAnimatable, IVisualElementController, IResourcesProvider, IStyleElement, IFlowDirectionController, IPropertyPropagationController, IVisualController, IWindowController, IView, ITransform, IControlsVisualElement, IStylable, IViewController, IGestureController, IGestureRecognizers, IPropertyMapperView, IHotReloadableView, IReplaceableView, IControlsView, ILayout, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IBindableLayout, IPaddingElement, IInputTransparentContainerElement, IAbsoluteLayout, IDisposable

Properties¶

ServerUris¶

The WMTS Server Uris

public Collection<Uri> ServerUris { get; }

Property Value¶

Collection<Uri>

ServerUri¶

The WMTS Server Uri

public Uri ServerUri { get; set; }

Property Value¶

Uri

TileCache¶

public RasterTileCache TileCache { get; set; }

Property Value¶

RasterTileCache

CapabilitiesCacheTimeout¶

The timeout for Capabilities Cache, its 10 minutes by default

public TimeSpan CapabilitiesCacheTimeout { get; set; }

Property Value¶

TimeSpan

ActiveLayerName¶

public string ActiveLayerName { get; set; }

Property Value¶

String

WmtsSeverEncodingType¶

WmtsSeverEncoding, KVP or RESTful

public WmtsServerEncodingType WmtsSeverEncodingType { get; set; }

Property Value¶

WmtsServerEncodingType

WmtsServerLayers¶

This method returns all layers at the server side.

public Collection<WmtsServerLayer> WmtsServerLayers { get; }

Property Value¶

Collection<WmtsServerLayer>

Remarks:

None.

ActiveStyleName¶

This property represents the available styles that can be requested from the client and shown on the map.

public string ActiveStyleName { get; set; }

Property Value¶

String

Remarks:

When requesting a map, a client may specify the styles to be shown on the map.

Parameters¶

Gets a dictionary whose items will be passed to the WMTS server as parameters.

public Dictionary<string, string> Parameters { get; }

Property Value¶

Dictionary<String, String>
A dictionary whose items will be passed to the WMS server as parameters.

OutputFormat¶

This property gets or sets the desired output format for the map requested from the WMTS.

public string OutputFormat { get; set; }

Property Value¶

String

Remarks:

When requesting a map, a client may specify the output format in which to show the map. Format are specified as MIME types such as "image/gif" or "image/png".

Credentials¶

This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication.

public ICredentials Credentials { get; set; }

Property Value¶

ICredentials

LowerScale¶

public double LowerScale { get; set; }

Property Value¶

Double

UpperScale¶

public double UpperScale { get; set; }

Property Value¶

Double

TileMatrixSetName¶

public string TileMatrixSetName { get; set; }

Property Value¶

String

AxisOrder¶

This property specifies the order in which the coordinate axes are arranged when making requests to a Web Map Service (WMS) server. It is used to define the spatial reference system for the layer.

public WmtsAxisOrder AxisOrder { get; set; }

Property Value¶

WmtsAxisOrder

ProjectionConverter¶

public ProjectionConverter ProjectionConverter { get; set; }

Property Value¶

ProjectionConverter

ProjectedTileCache¶

public RasterTileCache ProjectedTileCache { get; set; }

Property Value¶

RasterTileCache

TileMatrixSets¶

The tile matrix sets of this WmtsTiledOverlay in Dictionary.

public Dictionary<string, WmtsTileMatrixSet> TileMatrixSets { get; }

Property Value¶

Dictionary<String, WmtsTileMatrixSet>

WebBasedLayer¶

public WmtsAsyncLayer WebBasedLayer { get; set; }

Property Value¶

WmtsAsyncLayer

WebProxy¶

Gets or sets the Web Proxy for web service.

public IWebProxy WebProxy { get; set; }

Property Value¶

IWebProxy

TimeoutInSeconds¶

Gets or sets the length of time, in seconds, before the request times out.

public int TimeoutInSeconds { get; set; }

Property Value¶

Int32

TileWidth¶

Gets or sets the width of the tile.

public int TileWidth { get; }

Property Value¶

Int32
The width of the tile.

TileHeight¶

Gets or sets the height of the tile.

public int TileHeight { get; }

Property Value¶

Int32
The height of the tile.

IsCacheOnly¶

Gets or sets a value indicating whether this instance is cache only.

public bool IsCacheOnly { get; set; }

Property Value¶

Boolean
true if this instance is cache only; otherwise, false.

TileType¶

Gets and sets the overlay is formed by multiple tiles or single tile.

public TileType TileType { get; set; }

Property Value¶

TileType
The type of the tile.

TileSnappingMode¶

Gets or sets the tile snapping mode.

public TileSnappingMode TileSnappingMode { get; set; }

Property Value¶

TileSnappingMode
The tile snapping mode. By default it's Snapping

Remarks:

TileSnappingMode.Snapping is the default value, and it's always recommended as it brings in better performance (less rendering, take good advantage of caching, etc.)

TransitionEffect¶

Gets or sets the tile transition effect.

public TransitionEffect TransitionEffect { get; set; }

Property Value¶

TransitionEffect
The tile snapping mode.

ZoomLevelSet¶

Gets or sets the ZoomLevelSet for the TileOverlay. By default, this will snap to the scales defined in the ZoomLevelSet to fetch the internal data. To disable snapping, set TileSnappingMode to NoSnapping (not recommended).

public ZoomLevelSet ZoomLevelSet { get; set; }

Property Value¶

ZoomLevelSet

Remarks:

Ensure that the ZoomLevelSet scales align with those of the tile provider, especially when using third-party data.

Name¶

Gets or sets the name of this overlay.

public string Name { get; set; }

Property Value¶

String

DrawingExceptionMode¶

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

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode
The drawing exception mode.

IsEmpty¶

This property gets if this overlay is empty or not.

public bool IsEmpty { get; }

Property Value¶

Boolean

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.

Children¶

public IList<IView> Children { get; }

Property Value¶

IList<IView>

Count¶

public int Count { get; }

Property Value¶

Int32

IsReadOnly¶

public bool IsReadOnly { get; }

Property Value¶

Boolean

Item¶

public IView Item { get; set; }

Property Value¶

IView

IsClippedToBounds¶

public bool IsClippedToBounds { get; set; }

Property Value¶

Boolean

Padding¶

public Thickness Padding { get; set; }

Property Value¶

Thickness

IgnoreSafeArea¶

public bool IgnoreSafeArea { get; set; }

Property Value¶

Boolean

CascadeInputTransparent¶

public bool CascadeInputTransparent { get; set; }

Property Value¶

Boolean

GestureRecognizers¶

public IList<IGestureRecognizer> GestureRecognizers { get; }

Property Value¶

IList<IGestureRecognizer>

HorizontalOptions¶

public LayoutOptions HorizontalOptions { get; set; }

Property Value¶

LayoutOptions

Margin¶

public Thickness Margin { get; set; }

Property Value¶

Thickness

VerticalOptions¶

public LayoutOptions VerticalOptions { get; set; }

Property Value¶

LayoutOptions

Visual¶

public IVisual Visual { get; set; }

Property Value¶

IVisual

FlowDirection¶

public FlowDirection FlowDirection { get; set; }

Property Value¶

FlowDirection

Window¶

public Window Window { get; }

Property Value¶

Window

AnchorX¶

public double AnchorX { get; set; }

Property Value¶

Double

AnchorY¶

public double AnchorY { get; set; }

Property Value¶

Double

BackgroundColor¶

public Color BackgroundColor { get; set; }

Property Value¶

Color

Background¶

public Brush Background { get; set; }

Property Value¶

Brush

Behaviors¶

public IList<Behavior> Behaviors { get; }

Property Value¶

IList<Behavior>

Bounds¶

public Rect Bounds { get; }

Property Value¶

Rect

Height¶

public double Height { get; }

Property Value¶

Double

HeightRequest¶

public double HeightRequest { get; set; }

Property Value¶

Double

InputTransparent¶

public bool InputTransparent { get; set; }

Property Value¶

Boolean

IsEnabled¶

public bool IsEnabled { get; set; }

Property Value¶

Boolean

IsFocused¶

public bool IsFocused { get; }

Property Value¶

Boolean

IsVisible¶

public bool IsVisible { get; set; }

Property Value¶

Boolean

MinimumHeightRequest¶

public double MinimumHeightRequest { get; set; }

Property Value¶

Double

MinimumWidthRequest¶

public double MinimumWidthRequest { get; set; }

Property Value¶

Double

MaximumHeightRequest¶

public double MaximumHeightRequest { get; set; }

Property Value¶

Double

MaximumWidthRequest¶

public double MaximumWidthRequest { get; set; }

Property Value¶

Double

Opacity¶

public double Opacity { get; set; }

Property Value¶

Double

Rotation¶

public double Rotation { get; set; }

Property Value¶

Double

RotationX¶

public double RotationX { get; set; }

Property Value¶

Double

RotationY¶

public double RotationY { get; set; }

Property Value¶

Double

Scale¶

public double Scale { get; set; }

Property Value¶

Double

ScaleX¶

public double ScaleX { get; set; }

Property Value¶

Double

ScaleY¶

public double ScaleY { get; set; }

Property Value¶

Double

TranslationX¶

public double TranslationX { get; set; }

Property Value¶

Double

TranslationY¶

public double TranslationY { get; set; }

Property Value¶

Double

Triggers¶

public IList<TriggerBase> Triggers { get; }

Property Value¶

IList<TriggerBase>

Width¶

public double Width { get; }

Property Value¶

Double

WidthRequest¶

public double WidthRequest { get; set; }

Property Value¶

Double

X¶

public double X { get; }

Property Value¶

Double

Y¶

public double Y { get; }

Property Value¶

Double

Clip¶

public Geometry Clip { get; set; }

Property Value¶

Geometry

Batched¶

public bool Batched { get; }

Property Value¶

Boolean

DisableLayout¶

public bool DisableLayout { get; set; }

Property Value¶

Boolean

IsInPlatformLayout¶

public bool IsInPlatformLayout { get; set; }

Property Value¶

Boolean

IsPlatformStateConsistent¶

public bool IsPlatformStateConsistent { get; set; }

Property Value¶

Boolean

IsPlatformEnabled¶

public bool IsPlatformEnabled { get; set; }

Property Value¶

Boolean

Resources¶

public ResourceDictionary Resources { get; set; }

Property Value¶

ResourceDictionary

Frame¶

public Rect Frame { get; set; }

Property Value¶

Rect

Handler¶

public IViewHandler Handler { get; set; }

Property Value¶

IViewHandler

Shadow¶

public Shadow Shadow { get; set; }

Property Value¶

Shadow

ZIndex¶

public int ZIndex { get; set; }

Property Value¶

Int32

DesiredSize¶

public Size DesiredSize { get; protected set; }

Property Value¶

Size

IsLoaded¶

public bool IsLoaded { get; }

Property Value¶

Boolean

Navigation¶

public INavigation Navigation { get; internal set; }

Property Value¶

INavigation

Style¶

public Style Style { get; set; }

Property Value¶

Style

StyleClass¶

public IList<string> StyleClass { get; set; }

Property Value¶

IList<String>

class¶

public IList<string> class { get; set; }

Property Value¶

IList<String>

NavigationProxy¶

public NavigationProxy NavigationProxy { get; }

Property Value¶

NavigationProxy

AutomationId¶

public string AutomationId { get; set; }

Property Value¶

String

ClassId¶

public string ClassId { get; set; }

Property Value¶

String

Effects¶

public IList<Effect> Effects { get; }

Property Value¶

IList<Effect>

Id¶

public Guid Id { get; }

Property Value¶

Guid

StyleId¶

public string StyleId { get; set; }

Property Value¶

String

LogicalChildren¶

public ReadOnlyCollection<Element> LogicalChildren { get; }

Property Value¶

ReadOnlyCollection<Element>

RealParent¶

public Element RealParent { get; }

Property Value¶

Element

Parent¶

public Element Parent { get; set; }

Property Value¶

Element

EffectControlProvider¶

public IEffectControlProvider EffectControlProvider { get; set; }

Property Value¶

IEffectControlProvider

Handler¶

public IElementHandler Handler { get; set; }

Property Value¶

IElementHandler

Dispatcher¶

public IDispatcher Dispatcher { get; }

Property Value¶

IDispatcher

BindingContext¶

public object BindingContext { get; set; }

Property Value¶

Object

Constructors¶

WmtsOverlay()¶

Constructor of WmsOverlay class.

public WmtsOverlay()

WmtsOverlay(IEnumerable<Uri>)¶

Constructor of WmsOverlay class.

public WmtsOverlay(IEnumerable<Uri> serverUris)

Parameters¶

serverUris IEnumerable<Uri>
This parameter indicates the uris for the Wms server.

WmtsOverlay(IEnumerable<Uri>, IWebProxy)¶

Constructor of WmsOverlay class.

public WmtsOverlay(IEnumerable<Uri> serverUris, IWebProxy webProxy)

Parameters¶

serverUris IEnumerable<Uri>
This parameter indicates the uris for the Wms server.

webProxy IWebProxy
This parameter indicates the web proxy of the request

WmtsOverlay(IEnumerable<Uri>, WmtsServerEncodingType)¶

Constructor of WmsOverlay class.

public WmtsOverlay(IEnumerable<Uri> serverUris, WmtsServerEncodingType wmtsServerEncodingType)

Parameters¶

serverUris IEnumerable<Uri>
This parameter indicates the uris for the Wms server.

wmtsServerEncodingType WmtsServerEncodingType
Kvp or Restful

WmtsOverlay(IEnumerable<Uri>, IWebProxy, WmtsServerEncodingType)¶

Constructor of WmsOverlay class.

public WmtsOverlay(IEnumerable<Uri> serverUris, IWebProxy webProxy, WmtsServerEncodingType wmtsServerEncodingType)

Parameters¶

serverUris IEnumerable<Uri>
This parameter indicates the uris for the Wms server.

webProxy IWebProxy
This parameter indicates the web proxy of the request

wmtsServerEncodingType WmtsServerEncodingType
Kvp or Restful

WmtsOverlay(Uri)¶

Constructor of WmsOverlay class.

public WmtsOverlay(Uri serverUri)

Parameters¶

serverUri Uri
This parameter indicates the uri for the Wms server.

WmtsOverlay(Uri, IWebProxy)¶

Constructor of WmsOverlay class.

public WmtsOverlay(Uri serverUri, IWebProxy webProxy)

Parameters¶

serverUri Uri
This parameter indicates the uri for the Wms server.

webProxy IWebProxy
This parameter indicates the web proxy of the request

WmtsOverlay(Uri, WmtsServerEncodingType)¶

Constructor of WmsOverlay class.

public WmtsOverlay(Uri serverUri, WmtsServerEncodingType wmtsServerEncodingType)

Parameters¶

serverUri Uri
This parameter indicates the uri for the Wms server.

wmtsServerEncodingType WmtsServerEncodingType
Kvp or Restful

WmtsOverlay(Uri, IWebProxy, WmtsServerEncodingType)¶

Constructor of WmsOverlay class.

public WmtsOverlay(Uri serverUri, IWebProxy webProxy, WmtsServerEncodingType wmtsServerEncodingType)

Parameters¶

serverUri Uri
This parameter indicates the uri for the Wms server.

webProxy IWebProxy
This parameter indicates the web proxy of the request

wmtsServerEncodingType WmtsServerEncodingType
Kvp or Restful

Methods¶

GetRequestUris(RectangleShape, Int32, Int32)¶

public Collection<Uri> GetRequestUris(RectangleShape requestExtent, int canvasWidth, int canvasHeight)

Parameters¶

requestExtent RectangleShape

canvasWidth Int32

canvasHeight Int32

Returns¶

Collection<Uri>

GetServerCapabilitiesXml()¶

public string GetServerCapabilitiesXml()

Returns¶

String

GetServerLayerNames()¶

public Collection<string> GetServerLayerNames()

Returns¶

Collection<String>

GetServerLayerStyles()¶

public Collection<string> GetServerLayerStyles()

Returns¶

Collection<String>

GetServerTileMatrixSetNames()¶

public Collection<string> GetServerTileMatrixSetNames()

Returns¶

Collection<String>

GetLayerOutputFormats(String)¶

public Collection<string> GetLayerOutputFormats(string layerName)

Parameters¶

layerName String

Returns¶

Collection<String>

RemoveCachedCapability()¶

public bool RemoveCachedCapability()

Returns¶

Boolean

GetTileCore()¶

protected TileView GetTileCore()

Returns¶

TileView

OpenAsyncCore(IMapView, CancellationToken)¶

protected Task OpenAsyncCore(IMapView mapView, CancellationToken cancellationToken)

Parameters¶

mapView IMapView

cancellationToken CancellationToken

Returns¶

Task

CloseAsyncCore(CancellationToken)¶

protected Task CloseAsyncCore(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken

Returns¶

Task

GetZoomLevelSet(String)¶

public ZoomLevelSet GetZoomLevelSet(string tileMatrixSetName)

Parameters¶

tileMatrixSetName String

Returns¶

ZoomLevelSet

GetTileMatrixCore(Double, Int32, Int32, GeographyUnit)¶

protected TileMatrix GetTileMatrixCore(double scale, int tileWidth, int tileHeight, GeographyUnit boundingBoxUnit)

Parameters¶

scale Double

tileWidth Int32

tileHeight Int32

boundingBoxUnit GeographyUnit

Returns¶

TileMatrix

Events¶

SendingHttpRequest¶

public event EventHandler<SendingHttpRequestMessageEventArgs> SendingHttpRequest;

ReceivedHttpResponse¶

public event EventHandler<ReceivedHttpResponseMessageEventArgs> ReceivedHttpResponse;

DrawingTile¶

The event raised before Drawing a tile

public event EventHandler<DrawingTileTileOverlayEventArgs> DrawingTile;

PostedTile¶

The event raised after Posted a tile

public event EventHandler<PostedTileTileOverlayEventArgs> PostedTile;

Drawing¶

This event raises before the overlay is drawing.

public event EventHandler<DrawingOverlayEventArgs> Drawing;

Drawn¶

This event raises after the overlay is drawn.

public event EventHandler<DrawnOverlayEventArgs> Drawn;

ChildrenReordered¶

public event EventHandler ChildrenReordered;

Focused¶

public event EventHandler<FocusEventArgs> Focused;

MeasureInvalidated¶

public event EventHandler MeasureInvalidated;

SizeChanged¶

public event EventHandler SizeChanged;

Unfocused¶

public event EventHandler<FocusEventArgs> Unfocused;

BatchCommitted¶

public event EventHandler<EventArg<VisualElement>> BatchCommitted;

FocusChangeRequested¶

public event EventHandler<FocusRequestArgs> FocusChangeRequested;

Loaded¶

public event EventHandler Loaded;

Unloaded¶

public event EventHandler Unloaded;

ChildAdded¶

public event EventHandler<ElementEventArgs> ChildAdded;

ChildRemoved¶

public event EventHandler<ElementEventArgs> ChildRemoved;

DescendantAdded¶

public event EventHandler<ElementEventArgs> DescendantAdded;

DescendantRemoved¶

public event EventHandler<ElementEventArgs> DescendantRemoved;

ParentChanging¶

public event EventHandler<ParentChangingEventArgs> ParentChanging;

ParentChanged¶

public event EventHandler ParentChanged;

HandlerChanging¶

public event EventHandler<HandlerChangingEventArgs> HandlerChanging;

HandlerChanged¶

public event EventHandler HandlerChanged;

PropertyChanged¶

public event PropertyChangedEventHandler PropertyChanged;

PropertyChanging¶

public event PropertyChangingEventHandler PropertyChanging;

BindingContextChanged¶

public event EventHandler BindingContextChanged;