Method CreateDefaultExportTileCacheParametersAsync
CreateDefaultExportTileCacheParametersAsync(Geometry, Double, Double)
Creates and returns new ExportTileCacheParameters instance.
Declaration
public Task<ExportTileCacheParameters> CreateDefaultExportTileCacheParametersAsync(Geometry areaOfInterest, double minScale, double maxScale)
Parameters
Type | Name | Description |
---|---|---|
Geometry | areaOfInterest | A geometry specifying the area to be exported. |
System.Double | minScale | The map scale '1:minScale' which determines how far out to take offline. Can be 0 for the furthest out. |
System.Double | maxScale | The map scale '1:maxScale' which determines how far in to take offline. Can be 0 for the closest in the service allows. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExportTileCacheParameters> | A task that represents the asynchronous create export tile cache parameters operation. The value of the task result is the ExportTileCacheParameters. |
Remarks
This function is asynchronous because it makes use of the service metadata to build a ExportTileCacheParameters object. Calling the function will trigger load of the ExportTileCacheTask, unless it's already loaded.
The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference. Where a Polygon is supplied, tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting tile package. Note that the filtered set of tiles may vary, depending on the underlying service.
The value of minScale
must be larger than the value of
maxScale
, unless they are 0.
A minScale
value of 0 will result in this method choosing the service's
smallest level number, typically level 0.
Similarly, a maxScale
of 0 will result in the service's largest level number
being used, representing the closest in view being visible when taken offline. If
minScale
is between the scales of tile levels the previous smallest level
is used.
If maxScale
is between tile levels the next level is taken to ensure it is
displayed. For example a simple service has 4 levels: level 0 scale 2000000: level 1 scale
1000000; level 2 scale 500000; level 3 scale 250000.
A minScale
of 0 and maxScale
of 0 selects all levels
0,1,2,3.
A minScale
of 750000 (between levels 1 and 2) and a
maxScale
of 25000 (at level 3) will select levels 1,2,3.
A minScale
of 0 and a maxScale
750000 (between 1 and 2)
will select levels 0,1,2.
A minScale
of 1000000 and a maxScale
of 0 will select
all levels from 1 onwards 1,2,3.
Be careful when combining a large extent or a wide range of scales, this can result in the export failing due to exceeding the services maximum export tile count.
Applies to
Platforms and versions
Target | Versions |
---|---|
.NET Standard 2.0 | 100.3 - 200.5 |
.NET | 100.13 - 200.5 |
.NET Windows | 100.13 - 200.5 |
.NET Android | 200.0 - 200.5 |
.NET iOS | 200.0 - 200.5 |
.NET Framework | 100.0 - 200.5 |
Xamarin.Android | 100.0 - 100.15 |
Xamarin.iOS | 100.0 - 100.15 |
UWP | 100.0 - 200.5 |