dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
KMLLayer Class
The KMLLayer class is used to create a layer based on a KML file (.kml, .kmz).
ArcGIS Maps SDK for JavaScript
public class KMLLayer : 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.IPortalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IScaleRangeLayer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 KMLLayer
Implements IBlendLayer, IMapComponent, IOperationalLayer, IPortalLayer, IScaleRangeLayer
Constructors
KMLLayer() Constructor
Parameterless constructor for use as a Razor Component.
public KMLLayer();
KMLLayer(string, PortalItem, string, Nullable, Effect, Extent, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, IReadOnlyList, 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 KMLLayer(string? url=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, string? arcGISLayerId=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=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, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.KMLSublayer>? sublayers=null, string? title=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null, System.Nullable<bool> visible=null);
Parameters
url System.String
The publicly accessible URL for a .kml or .kmz file.
ArcGIS Maps SDK for JavaScript
portalItem PortalItem
The portal item from which the layer is loaded.
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
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
sublayers System.Collections.Generic.IReadOnlyList<KMLSublayer>
A collection of KMLSublayers.
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
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
KMLLayer.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
KMLLayer.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
KMLLayer.MaxScale Property
The maximum scale (most zoomed in) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MaxScale { get; set; }
Implements MaxScale
Property Value
System.Nullable<System.Double>
KMLLayer.MinScale Property
The minimum scale (most zoomed out) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MinScale { get; set; }
Implements MinScale
Property Value
System.Nullable<System.Double>
KMLLayer.PortalItem Property
The portal item from which the layer is loaded.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.PortalItem? PortalItem { get; set; }
Implements PortalItem
Property Value
KMLLayer.Sublayers Property
A collection of KMLSublayers.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.KMLSublayer>? Sublayers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<KMLSublayer>
KMLLayer.Type Property
Used internally to identify the sub type of Layer
public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }
Property Value
KMLLayer.Url Property
The publicly accessible URL for a .kml or .kmz file.
ArcGIS Maps SDK for JavaScript
public string? Url { get; set; }
Property Value
Methods
KMLLayer.AddToSublayers(KMLSublayer[]) Method
Asynchronously adds elements to the Sublayers property.
public System.Threading.Tasks.Task AddToSublayers(params dymaptic.GeoBlazor.Core.Components.KMLSublayer[] values);
Parameters
values KMLSublayer[]
The elements to add.
Returns
KMLLayer.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>>
KMLLayer.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>
KMLLayer.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>>
KMLLayer.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>>
KMLLayer.GetPortalItem() Method
Asynchronously retrieve the current value of the PortalItem property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> GetPortalItem();
Implements GetPortalItem()
Returns
System.Threading.Tasks.Task<PortalItem>
KMLLayer.GetSublayers() Method
Asynchronously retrieve the current value of the Sublayers property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.KMLSublayer>?> GetSublayers();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<KMLSublayer>>
KMLLayer.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>
KMLLayer.RemoveFromSublayers(KMLSublayer[]) Method
Asynchronously remove an element from the Sublayers property.
public System.Threading.Tasks.Task RemoveFromSublayers(params dymaptic.GeoBlazor.Core.Components.KMLSublayer[] values);
Parameters
values KMLSublayer[]
The elements to remove.
Returns
KMLLayer.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
KMLLayer.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
KMLLayer.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
KMLLayer.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
KMLLayer.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
KMLLayer.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.
Implements SetPortalItem(PortalItem)
Returns
KMLLayer.SetSublayers(IReadOnlyList) Method
Asynchronously set the value of the Sublayers property after render.
public System.Threading.Tasks.Task SetSublayers(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.KMLSublayer>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<KMLSublayer>
The value to set.
Returns
KMLLayer.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
KMLLayer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()