dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
VectorTileLayer Class
VectorTileLayer accesses cached tiles of data and renders it in vector format.
ArcGIS Maps SDK for JavaScript
public class VectorTileLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer,
dymaptic.GeoBlazor.Core.Interfaces.IBlendLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IOperationalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IScaleRangeLayer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 VectorTileLayer
Implements IBlendLayer, IMapComponent, IOperationalLayer, IScaleRangeLayer
Constructors
VectorTileLayer() Constructor
Parameterless constructor for use as a Razor Component.
public VectorTileLayer();
VectorTileLayer(string, string, Nullable, Dictionary<string,object>, Effect, Extent, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, PortalItem, Nullable, string, string, string, TimeExtent, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public VectorTileLayer(string? apiKey=null, string? arcGISLayerId=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=null, System.Collections.Generic.Dictionary<string,object>? customParameters=null, dymaptic.GeoBlazor.Core.Model.Effect? effect=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? fullExtent=null, System.Nullable<bool> isBasemapReferenceLayer=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> listMode=null, System.Nullable<double> maxScale=null, System.Nullable<double> minScale=null, System.Nullable<double> opacity=null, System.Nullable<bool> persistenceEnabled=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, System.Nullable<double> refreshInterval=null, string? style=null, string? title=null, string? url=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null, System.Nullable<bool> visible=null);
Parameters
apiKey System.String
An authorization string used to access a resource or service.
ArcGIS Maps SDK for JavaScript
arcGISLayerId System.String
The unique ID assigned to the layer.
ArcGIS Maps SDK for JavaScript
blendMode System.Nullable<BlendMode>
Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.
default normal
ArcGIS Maps SDK for JavaScript
customParameters System.Collections.Generic.Dictionary<System.String,System.Object>
A list of custom parameters appended to the URL of all resources fetched by the layer.
ArcGIS Maps SDK for JavaScript
effect Effect
Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to
how image filters work.
default null
ArcGIS Maps SDK for JavaScript
fullExtent Extent
The full extent of the layer.
ArcGIS Maps SDK for JavaScript
isBasemapReferenceLayer System.Nullable<System.Boolean>
Indicates whether the layer is a basemap reference layer. Default value: false.
listMode System.Nullable<ListMode>
Indicates how the layer should display in the LayerList widget.
default “show”
ArcGIS Maps SDK for JavaScript
maxScale System.Nullable<System.Double>
The maximum scale (most zoomed in) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
minScale System.Nullable<System.Double>
The minimum scale (most zoomed out) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
opacity System.Nullable<System.Double>
The opacity of the layer.
default 1
ArcGIS Maps SDK for JavaScript
persistenceEnabled System.Nullable<System.Boolean>
Enable persistence of the layer in a WebMap or WebScene.
default true
ArcGIS Maps SDK for JavaScript
portalItem PortalItem
The portal item from which the layer is loaded.
ArcGIS Maps SDK for JavaScript
refreshInterval System.Nullable<System.Double>
Refresh interval of the layer in minutes.
default 0
ArcGIS Maps SDK for JavaScript
style System.String
A style JSON object of vector tiles that will be used to render the layer.
ArcGIS Maps SDK for JavaScript
title System.String
The title of the layer used to identify it in places such as the LayerList widget.
ArcGIS Maps SDK for JavaScript
url System.String
The URL to the vector tile service, or the URL to the style resource of vector tiles that
will be used to render the layer.
ArcGIS Maps SDK for JavaScript
visibilityTimeExtent TimeExtent
Specifies a fixed time extent during which a layer should be visible.
default null
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates if the layer is visible in the View.
default true
ArcGIS Maps SDK for JavaScript
Properties
VectorTileLayer.ApiKey Property
An authorization string used to access a resource or service.
ArcGIS Maps SDK for JavaScript
public string? ApiKey { get; set; }
Property Value
VectorTileLayer.AttributionDataUrl Property
The URL that points to the location of the layer’s attribution data.
ArcGIS Maps SDK for JavaScript
public string? AttributionDataUrl { get; set; }
Property Value
VectorTileLayer.BlendMode Property
Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.
default normal
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> BlendMode { get; set; }
Implements BlendMode
Property Value
VectorTileLayer.Capabilities Property
Indicates the layer’s supported capabilities.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.VectorTileLayerCapabilities? Capabilities { get; set; }
Property Value
VectorTileLayer.CurrentStyleInfo Property
The current style information of the VectorTileLayer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.VectorTileLayerCurrentStyleInfo? CurrentStyleInfo { get; set; }
Property Value
VectorTileLayerCurrentStyleInfo
VectorTileLayer.CustomParameters Property
A list of custom parameters appended to the URL of all resources fetched by the layer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.Dictionary<string,object>? CustomParameters { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String,System.Object>
VectorTileLayer.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.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.Effect? Effect { get; set; }
Implements Effect
Property Value
VectorTileLayer.HasRefreshListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasRefreshListener { get; }
Property Value
VectorTileLayer.InitialExtent Property
The initial extent of the layer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Extent? InitialExtent { get; set; }
Property Value
VectorTileLayer.MaxScale Property
The maximum scale of the layer.
public System.Nullable<double> MaxScale { get; set; }
Implements MaxScale
Property Value
System.Nullable<System.Double>
VectorTileLayer.MinScale Property
The minimum scale of the layer.
public System.Nullable<double> MinScale { get; set; }
Implements MinScale
Property Value
System.Nullable<System.Double>
VectorTileLayer.OnRefresh Property
Fires if the layer has the refreshInterval set or when refresh() is called.
The event payload indicates if the layer’s data has changed.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.RefreshEvent> OnRefresh { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<RefreshEvent>
VectorTileLayer.PortalItem Property
The portal item of the layer.
public dymaptic.GeoBlazor.Core.Components.PortalItem? PortalItem { get; set; }
Property Value
VectorTileLayer.RefreshInterval Property
Refresh interval of the layer in minutes.
default 0
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> RefreshInterval { get; set; }
Property Value
System.Nullable<System.Double>
VectorTileLayer.SpatialReference Property
The spatial reference of the layer.
public dymaptic.GeoBlazor.Core.Components.SpatialReference? SpatialReference { get; set; }
Property Value
VectorTileLayer.Style Property
A style JSON object of vector tiles that will be used to render the layer.
ArcGIS Maps SDK for JavaScript
public string? Style { get; set; }
Property Value
VectorTileLayer.TileInfo Property
The tiling scheme information for the layer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.TileInfo? TileInfo { get; set; }
Property Value
VectorTileLayer.Type Property
Used internally to identify the sub type of Layer
public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }
Property Value
VectorTileLayer.Url Property
The URL to the vector tile service.
public string? Url { get; set; }
Property Value
Methods
VectorTileLayer.GetApiKey() Method
Asynchronously retrieve the current value of the ApiKey property.
public System.Threading.Tasks.Task<string?> GetApiKey();
Returns
System.Threading.Tasks.Task<System.String>
VectorTileLayer.GetAttributionDataUrl() Method
Asynchronously retrieve the current value of the AttributionDataUrl property.
public System.Threading.Tasks.Task<string?> GetAttributionDataUrl();
Returns
System.Threading.Tasks.Task<System.String>
VectorTileLayer.GetBlendMode() Method
Asynchronously retrieve the current value of the BlendMode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode>> GetBlendMode();
Implements GetBlendMode()
Returns
System.Threading.Tasks.Task<System.Nullable<BlendMode>>
VectorTileLayer.GetCapabilities() Method
Asynchronously retrieve the current value of the Capabilities property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.VectorTileLayerCapabilities?> GetCapabilities();
Returns
System.Threading.Tasks.Task<VectorTileLayerCapabilities>
VectorTileLayer.GetCurrentStyleInfo() Method
Asynchronously retrieve the current value of the CurrentStyleInfo property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.VectorTileLayerCurrentStyleInfo?> GetCurrentStyleInfo();
Returns
System.Threading.Tasks.Task<VectorTileLayerCurrentStyleInfo>
VectorTileLayer.GetCustomParameters() Method
Asynchronously retrieve the current value of the CustomParameters property.
public System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,object>?> GetCustomParameters();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String,System.Object>>
VectorTileLayer.GetEffect() Method
Asynchronously retrieve the current value of the Effect property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Effect?> GetEffect();
Implements GetEffect()
Returns
System.Threading.Tasks.Task<Effect>
VectorTileLayer.GetInitialExtent() Method
Asynchronously retrieve the current value of the InitialExtent property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Extent?> GetInitialExtent();
Returns
System.Threading.Tasks.Task<Extent>
VectorTileLayer.GetMaxScale() Method
Asynchronously retrieve the current value of the MaxScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxScale();
Implements GetMaxScale()
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
VectorTileLayer.GetMinScale() Method
Asynchronously retrieve the current value of the MinScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinScale();
Implements GetMinScale()
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
VectorTileLayer.GetPortalItem() Method
Asynchronously retrieve the current value of the PortalItem property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> GetPortalItem();
Returns
System.Threading.Tasks.Task<PortalItem>
VectorTileLayer.GetRefreshInterval() Method
Asynchronously retrieve the current value of the RefreshInterval property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetRefreshInterval();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
VectorTileLayer.GetSpatialReference() Method
Asynchronously retrieve the current value of the SpatialReference property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SpatialReference?> GetSpatialReference();
Returns
System.Threading.Tasks.Task<SpatialReference>
VectorTileLayer.GetStyle() Method
Asynchronously retrieve the current value of the Style property.
public System.Threading.Tasks.Task<string?> GetStyle();
Returns
System.Threading.Tasks.Task<System.String>
VectorTileLayer.GetTileInfo() Method
Asynchronously retrieve the current value of the TileInfo property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TileInfo?> GetTileInfo();
Returns
System.Threading.Tasks.Task<TileInfo>
VectorTileLayer.GetUrl() Method
Asynchronously retrieve the current value of the Url property.
public System.Threading.Tasks.Task<string?> GetUrl();
Returns
System.Threading.Tasks.Task<System.String>
VectorTileLayer.OnJsRefresh(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsRefresh(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
VectorTileLayer.Refresh() Method
Fetches all the data for the layer.
ArcGIS Maps SDK for JavaScript
public override System.Threading.Tasks.ValueTask Refresh();
Returns
System.Threading.Tasks.ValueTask
VectorTileLayer.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its 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.
VectorTileLayer.SetApiKey(string) Method
Asynchronously set the value of the ApiKey property after render.
public System.Threading.Tasks.Task SetApiKey(string? value);
Parameters
value System.String
The value to set.
Returns
VectorTileLayer.SetBlendMode(Nullable) Method
Asynchronously set the value of the BlendMode property after render.
public System.Threading.Tasks.Task SetBlendMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> value);
Parameters
value System.Nullable<BlendMode>
The value to set.
Implements SetBlendMode(Nullable<BlendMode>)
Returns
VectorTileLayer.SetCustomParameters(Dictionary<string,object>) Method
Asynchronously set the value of the CustomParameters property after render.
public System.Threading.Tasks.Task SetCustomParameters(System.Collections.Generic.Dictionary<string,object>? value);
Parameters
value System.Collections.Generic.Dictionary<System.String,System.Object>
The value to set.
Returns
VectorTileLayer.SetEffect(Effect) Method
Asynchronously set the value of the Effect property after render.
public System.Threading.Tasks.Task SetEffect(dymaptic.GeoBlazor.Core.Model.Effect? value);
Parameters
value Effect
The value to set.
Implements SetEffect(Effect)
Returns
VectorTileLayer.SetMaxScale(Nullable) Method
Asynchronously set the value of the MaxScale property after render.
public System.Threading.Tasks.Task SetMaxScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Implements SetMaxScale(Nullable<double>)
Returns
VectorTileLayer.SetMinScale(Nullable) Method
Asynchronously set the value of the MinScale property after render.
public System.Threading.Tasks.Task SetMinScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Implements SetMinScale(Nullable<double>)
Returns
VectorTileLayer.SetPersistenceEnabled(Nullable) Method
Asynchronously set the value of the PersistenceEnabled property after render.
public System.Threading.Tasks.Task SetPersistenceEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Implements SetPersistenceEnabled(Nullable<bool>)
Returns
VectorTileLayer.SetPortalItem(PortalItem) Method
Asynchronously set the value of the PortalItem property after render.
public System.Threading.Tasks.Task SetPortalItem(dymaptic.GeoBlazor.Core.Components.PortalItem? value);
Parameters
value PortalItem
The value to set.
Returns
VectorTileLayer.SetRefreshInterval(Nullable) Method
Asynchronously set the value of the RefreshInterval property after render.
public System.Threading.Tasks.Task SetRefreshInterval(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
VectorTileLayer.SetStyle(string) Method
Asynchronously set the value of the Style property after render.
public System.Threading.Tasks.Task SetStyle(string? value);
Parameters
value System.String
The value to set.
Returns
VectorTileLayer.SetUrl(string) Method
Asynchronously set the value of the Url property after render.
public System.Threading.Tasks.Task SetUrl(string? value);
Parameters
value System.String
The value to set.
Returns
VectorTileLayer.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.
VectorTileLayer.ValidateRequiredChildren() Method
When a MapView is prepared to render, this will check to make sure that all properties with the RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Implements ValidateRequiredChildren()
Exceptions
MissingRequiredChildElementException
The consumer needs to provide the missing child component
MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components
VectorTileLayer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()