layout: default title: TileLayer parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
TileLayer Class
The TileLayer allows you work with a cached map service exposed by the ArcGIS Server REST API and add it to a Map
as a tile layer. A cached service accesses tiles from a cache instead of dynamically rendering images. Because they
are cached, tiled layers render faster than MapImageLayers. To create an instance of TileLayer, you must reference
the URL of the cached map service.
ArcGIS Maps SDK for JavaScript
public class TileLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 TileLayer
Derived
↳ VectorTileLayer
Properties
TileLayer.AllSublayers Property
A flat Collection of all the sublayers in the MapImageLayer including the sublayers of its sublayers. All sublayers are referenced in the order in which they are drawn in the view (bottom to top).
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? AllSublayers { get; }
Property Value
System.Collections.Generic.IReadOnlyList<Sublayer>
TileLayer.ApiKey Property
An authorization string used to access a resource or service. API keys are generated and managed in the ArcGIS Developer dashboard. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.
public string? ApiKey { get; set; }
Property Value
TileLayer.Capabilities Property
Indicates the layer’s supported capabilities.
public dymaptic.GeoBlazor.Core.Components.Layers.MapImageLayerCapabilities? Capabilities { get; set; }
Property Value
TileLayer.Copyright Property
The copyright text as defined by the service.
public string? Copyright { get; set; }
Property Value
TileLayer.Effect Property
Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. This powerful capability allows you to apply css filter-like functions to layers to create custom visual effects to enhance the cartographic quality of your maps. This is done by applying the desired effect to the layer’s effect property as a string or an array of objects to set scale dependent effects.
public dymaptic.GeoBlazor.Core.Components.Layers.Effect? Effect { get; set; }
Property Value
TileLayer.LayerType Property
Used internally to identify the sub type of Layer
public override string LayerType { get; }
Property Value
TileLayer.LegendEnabled Property
Indicates whether the layer will be included in the legend.
Default Value: true
public System.Nullable<bool> LegendEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
TileLayer.MaxScale Property
The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.
public System.Nullable<double> MaxScale { get; set; }
Property Value
System.Nullable<System.Double>
TileLayer.MinScale Property
The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.
public System.Nullable<double> MinScale { get; set; }
Property Value
System.Nullable<System.Double>
TileLayer.PortalItem Property
The PortalItem from which the layer is loaded.
public dymaptic.GeoBlazor.Core.Components.PortalItem? PortalItem { get; set; }
Property Value
TileLayer.RefreshInterval Property
Refresh interval of the layer in minutes. Value of 0 indicates no refresh.
Default Value: 0
public System.Nullable<double> RefreshInterval { get; set; }
Property Value
System.Nullable<System.Double>
TileLayer.SourceJSON Property
The map service’s metadata JSON exposed by the ArcGIS REST API. While most commonly used properties are exposed on the MapImageLayer class directly, this property gives access to all information returned by the map service. This property is useful if working in an application built using an older version of the API which requires access to map service properties from a more recent version.
public string? SourceJSON { get; set; }
Property Value
TileLayer.SpatialReference Property
The spatial reference of the layer as defined by the service.
public dymaptic.GeoBlazor.Core.Components.Geometries.SpatialReference? SpatialReference { get; set; }
Property Value
TileLayer.Sublayers Property
A Collection of Sublayer objects. All sublayers are referenced in the order in which they are drawn in the view (bottom to top). Sublayer properties on TileLayer are read-only, with the following exceptions: LegendEnabled, PopupEnabled, PopupTemplate
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? Sublayers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Sublayer>
TileLayer.TileInfo Property
The tiling scheme information for the layer.
public dymaptic.GeoBlazor.Core.Components.Layers.TileInfo? TileInfo { get; set; }
Property Value
TileLayer.TileServers Property
An array of tile servers used for changing map tiles.
public System.Collections.Generic.IReadOnlyList<string>? TileServers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
TileLayer.Url Property
The URL of the REST endpoint of the layer.
public string? Url { get; set; }
Property Value
Methods
TileLayer.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
TileLayer.UnregisterChildComponent(MapComponent) Method
Undoes the “Registration” of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.