dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
Sublayer Class
Represents a sublayer in a MapImageLayer or a TileLayer.
ArcGIS Maps SDK for JavaScript
public class Sublayer : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IPopupTemplateLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Sublayer
Implements IPopupTemplateLayer, IMapComponent
Constructors
Sublayer() Constructor
Parameterless constructor for use as a Razor Component.
public Sublayer();
Sublayer(Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, string, Nullable, string, LayerFloorInfo, IReadOnlyList
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public Sublayer(System.Nullable<long> sublayerId=null, System.Nullable<bool> labelsVisible=null, System.Nullable<bool> legendEnabled=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> popupEnabled=null, string? title=null, System.Nullable<bool> visible=null, string? definitionExpression=null, dymaptic.GeoBlazor.Core.Components.LayerFloorInfo? floorInfo=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label>? labelingInfo=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? popupTemplate=null, dymaptic.GeoBlazor.Core.Components.Renderers.Renderer? renderer=null, dymaptic.GeoBlazor.Core.Components.DynamicLayer? source=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? sublayers=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.OrderByInfo>? orderBy=null, string? url=null);
Parameters
sublayerId System.Nullable<System.Int64>
The sublayer’s layer ID.
ArcGIS Maps SDK for JavaScript
labelsVisible System.Nullable<System.Boolean>
Indicates if labels for the sublayer will be visible in the view.
default true
ArcGIS Maps SDK for JavaScript
legendEnabled System.Nullable<System.Boolean>
Indicates whether the layer will be included in the legend.
default true
ArcGIS Maps SDK for JavaScript
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.
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.
ArcGIS Maps SDK for JavaScript
opacity System.Nullable<System.Double>
The level of opacity to set on the sublayer on a scale
from 0.0 - 1.0 where 0 is fully transparent and 1.0 is fully opaque.
ArcGIS Maps SDK for JavaScript
popupEnabled System.Nullable<System.Boolean>
Indicates whether to display popups when features in the layer are clicked.
default true
ArcGIS Maps SDK for JavaScript
title System.String
The title of the sublayer used to identify it in places such as the
LayerList and Legend widgets.
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates if the layer is visible in the view.
ArcGIS Maps SDK for JavaScript
definitionExpression System.String
A SQL where clause used to filter features in the image.
ArcGIS Maps SDK for JavaScript
floorInfo LayerFloorInfo
If a map image layer contains a sublayer which is meant to be floor-aware, then that sublayer
must have a floorInfo property, containing a LayerFloorInfo object
which has a string property to represent the floorField.
ArcGIS Maps SDK for JavaScript
labelingInfo System.Collections.Generic.IReadOnlyList<Label>
The label definition for this layer,
specified as an array of LabelClass objects.
ArcGIS Maps SDK for JavaScript
popupTemplate PopupTemplate
The popup template for the sublayer.
ArcGIS Maps SDK for JavaScript
renderer Renderer
The renderer to apply to the sublayer.
ArcGIS Maps SDK for JavaScript
source DynamicLayer
An object that allows you to create a dynamic layer with data
either from the map service sublayers or data from a registered workspace.
ArcGIS Maps SDK for JavaScript
sublayers System.Collections.Generic.IReadOnlyList<Sublayer>
If a sublayer contains sublayers, this
property is a Collection of Sublayer
objects belonging to the given sublayer with sublayers.
ArcGIS Maps SDK for JavaScript
orderBy System.Collections.Generic.IReadOnlyList<OrderByInfo>
Determines the order in which features are drawn in the view.
default null
ArcGIS Maps SDK for JavaScript
url System.String
The URL to the REST endpoint of the sublayer.
ArcGIS Maps SDK for JavaScript
Properties
Sublayer.Capabilities Property
Describes the layer’s supported capabilities.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.SublayerCapabilities? Capabilities { get; set; }
Property Value
Sublayer.DefinitionExpression Property
A SQL where clause used to filter features in the image. Only the features that satisfy the definition expression are displayed in the View. Definition expressions may be set when a Sublayer is constructed prior to it loading in the view or after it has been added to the MapImageLayer. To see if you can use this property, check the supportsSublayerDefinitionExpression property of MapImageLayer.capabilities.
public string? DefinitionExpression { get; set; }
Property Value
Sublayer.Fields Property
An array of fields in the Sublayer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Field>? Fields { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Field>
Sublayer.FieldsIndex Property
A convenient property that can be used to make case-insensitive lookups for a field by name.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.FieldsIndex? FieldsIndex { get; set; }
Property Value
Sublayer.FloorInfo Property
If a map image layer contains a sublayer which is meant to be floor-aware, then that sublayer must have a floorInfo property, containing a LayerFloorInfo object which has a string property to represent the floorField.
public dymaptic.GeoBlazor.Core.Components.LayerFloorInfo? FloorInfo { get; set; }
Property Value
Sublayer.FullExtent Property
The full extent of the Sublayer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Extent? FullExtent { get; set; }
Property Value
Sublayer.IsTable Property
Returns true if the sublayer is a non-spatial table in a map service.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IsTable { get; set; }
Property Value
System.Nullable<System.Boolean>
Sublayer.LabelingInfo Property
The label definition for this layer,
specified as an array of LabelClass objects.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label>? LabelingInfo { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Label>
Sublayer.LabelsVisible Property
Indicates if labels for the sublayer will be visible in the view.
Default Value: true
public System.Nullable<bool> LabelsVisible { get; set; }
Property Value
System.Nullable<System.Boolean>
Sublayer.LegendEnabled Property
Indicates whether the layer will be included in the legend. When false, the layer will be excluded from the legend.
Default Value: true
public System.Nullable<bool> LegendEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Sublayer.ListMode Property
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> ListMode { get; set; }
Property Value
Sublayer.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>
Sublayer.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 less than or equal to the service specification.
public System.Nullable<double> MinScale { get; set; }
Property Value
System.Nullable<System.Double>
Sublayer.ObjectIdField Property
The name of an oid field containing a unique value or identifier for each
feature in the Sublayer.
ArcGIS Maps SDK for JavaScript
public string? ObjectIdField { get; set; }
Property Value
Sublayer.Opacity Property
The level of opacity to set on the sublayer on a scale from 0.0 - 1.0 where 0 is fully transparent and 1.0 is fully opaque. If the MapImageLayer.opacity is set, the actual opacity value of the sublayer will be the value of MapImageLayer.opacity multiplied by the sublayer’s opacity.
public System.Nullable<double> Opacity { get; set; }
Property Value
System.Nullable<System.Double>
Sublayer.OrderBy Property
Determines the order in which features are drawn in the view.
default null
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.OrderByInfo>? OrderBy { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<OrderByInfo>
Sublayer.PopupEnabled Property
Indicates whether to display popups when features in the layer are clicked. The layer needs to have a popupTemplate to define what information should be displayed in the popup. Alternatively, a default popup template may be automatically used if Popup.defaultPopupTemplateEnabled is set to true.
Default Value: true
public System.Nullable<bool> PopupEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Sublayer.PopupTemplate Property
The popup template for the sublayer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? PopupTemplate { get; set; }
Implements PopupTemplate
Property Value
Sublayer.Relationships Property
An array of relationships associated with the sublayer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Relationship>? Relationships { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Relationship>
Sublayer.Renderer Property
The renderer to apply to the sublayer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Renderers.Renderer? Renderer { get; set; }
Property Value
Sublayer.Source Property
An object that allows you to create a dynamic layer with data
either from the map service sublayers or data from a registered workspace.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.DynamicLayer? Source { get; set; }
Property Value
Sublayer.SourceJSON Property
The map service’s metadata JSON
exposed by the ArcGIS REST API.
ArcGIS Maps SDK for JavaScript
public string? SourceJSON { get; set; }
Property Value
Sublayer.SpatialReference Property
The spatial reference of the sublayer as defined by the service.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SpatialReference? SpatialReference { get; set; }
Property Value
Sublayer.SublayerId Property
The sublayer’s layer ID.
ArcGIS Maps SDK for JavaScript
public System.Nullable<long> SublayerId { get; set; }
Property Value
Sublayer.Sublayers Property
If a sublayer contains sublayers, this
property is a Collection of Sublayer
objects belonging to the given sublayer with sublayers.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? Sublayers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Sublayer>
Sublayer.Title Property
The title of the sublayer used to identify it in places such as the LayerList and Legend widgets. This value can be defined in the map service or programmatically by the developer. It can also be useful for finding a specific sublayer.
public string? Title { get; set; }
Property Value
Sublayer.TypeIdField Property
The name of the field holding the type ID or subtypes for the features.
ArcGIS Maps SDK for JavaScript
public string? TypeIdField { get; set; }
Property Value
Sublayer.Types Property
An array of types defined in the feature service exposed by ArcGIS REST API.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.FeatureType>? Types { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<FeatureType>
Sublayer.Url Property
The URL to the REST endpoint of the sublayer.
ArcGIS Maps SDK for JavaScript
public string? Url { get; set; }
Property Value
Methods
Sublayer.AddToLabelingInfo(Label[]) Method
Asynchronously adds elements to the LabelingInfo property.
public System.Threading.Tasks.Task AddToLabelingInfo(params dymaptic.GeoBlazor.Core.Components.Label[] values);
Parameters
The elements to add.
Returns
Sublayer.AddToOrderBy(OrderByInfo[]) Method
Asynchronously adds elements to the OrderBy property.
public System.Threading.Tasks.Task AddToOrderBy(params dymaptic.GeoBlazor.Core.Components.OrderByInfo[] values);
Parameters
values OrderByInfo[]
The elements to add.
Returns
Sublayer.CancelLoad() Method
Cancels a load() operation if it is already in progress.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task CancelLoad();
Returns
Sublayer.CreateFeatureLayer() Method
A convenient method for creating a FeatureLayer instance
based on the Sublayer’s configuration, including
dynamic sources.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.FeatureLayer?> CreateFeatureLayer();
Returns
System.Threading.Tasks.Task<FeatureLayer>
Sublayer.CreatePopupTemplate(CreatePopupTemplateOptions) Method
Creates a popup template for the sublayer, populated with all the fields of the sublayer.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate?> CreatePopupTemplate(dymaptic.GeoBlazor.Core.Options.CreatePopupTemplateOptions options);
Parameters
options CreatePopupTemplateOptions
Options for creating the popup template.
Returns
System.Threading.Tasks.Task<PopupTemplate>
Sublayer.CreateQuery() Method
Creates a Query object with
default values representing the layer’s state, including filters (definition
expression) on the layer’s features.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Query?> CreateQuery();
Returns
System.Threading.Tasks.Task<Query>
Sublayer.GetAllSublayers() Method
Returns a flattened list of sublayers
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? GetAllSublayers();
Returns
System.Collections.Generic.IReadOnlyList<Sublayer>
Sublayer.GetCapabilities() Method
Asynchronously retrieve the current value of the Capabilities property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SublayerCapabilities?> GetCapabilities();
Returns
System.Threading.Tasks.Task<SublayerCapabilities>
Sublayer.GetDefinitionExpression() Method
Asynchronously retrieve the current value of the DefinitionExpression property.
public System.Threading.Tasks.Task<string?> GetDefinitionExpression();
Returns
System.Threading.Tasks.Task<System.String>
Sublayer.GetFeatureType(Graphic) Method
Returns a FeatureType describing the feature’s type.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureType?> GetFeatureType(dymaptic.GeoBlazor.Core.Components.Graphic feature);
Parameters
feature Graphic
A feature from this Sublayer.
Returns
System.Threading.Tasks.Task<FeatureType>
Sublayer.GetFieldDomain(string, SublayerGetFieldDomainOptions) Method
Returns the Domain associated with the given field name.
param options An object specifying additional options. See the object specification table below for the required properties of this object.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Domain?> GetFieldDomain(string fieldName, dymaptic.GeoBlazor.Core.Options.SublayerGetFieldDomainOptions options);
Parameters
fieldName System.String
Name of the field.
options SublayerGetFieldDomainOptions
- options.feature: The feature to which the Domain is assigned.
Returns
System.Threading.Tasks.Task<Domain>
Sublayer.GetFields() Method
Asynchronously retrieve the current value of the Fields property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Field>?> GetFields();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Field>>
Sublayer.GetFieldsIndex() Method
Asynchronously retrieve the current value of the FieldsIndex property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FieldsIndex?> GetFieldsIndex();
Returns
System.Threading.Tasks.Task<FieldsIndex>
Sublayer.GetFloorInfo() Method
Asynchronously retrieve the current value of the FloorInfo property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.LayerFloorInfo?> GetFloorInfo();
Returns
System.Threading.Tasks.Task<LayerFloorInfo>
Sublayer.GetFullExtent() Method
Asynchronously retrieve the current value of the FullExtent property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Extent?> GetFullExtent();
Returns
System.Threading.Tasks.Task<Extent>
Sublayer.GetIsTable() Method
Asynchronously retrieve the current value of the IsTable property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIsTable();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
Sublayer.GetLabelingInfo() Method
Asynchronously retrieve the current value of the LabelingInfo property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label>?> GetLabelingInfo();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Label>>
Sublayer.GetLabelsVisible() Method
Asynchronously retrieve the current value of the LabelsVisible property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetLabelsVisible();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
Sublayer.GetLegendEnabled() Method
Asynchronously retrieve the current value of the LegendEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetLegendEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
Sublayer.GetListMode() Method
Asynchronously retrieve the current value of the ListMode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode>> GetListMode();
Returns
System.Threading.Tasks.Task<System.Nullable<ListMode>>
Sublayer.GetMaxScale() Method
Asynchronously retrieve the current value of the MaxScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxScale();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
Sublayer.GetMinScale() Method
Asynchronously retrieve the current value of the MinScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinScale();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
Sublayer.GetObjectIdField() Method
Asynchronously retrieve the current value of the ObjectIdField property.
public System.Threading.Tasks.Task<string?> GetObjectIdField();
Returns
System.Threading.Tasks.Task<System.String>
Sublayer.GetOpacity() Method
Asynchronously retrieve the current value of the Opacity property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetOpacity();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
Sublayer.GetOrderBy() Method
Asynchronously retrieve the current value of the OrderBy property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.OrderByInfo>?> GetOrderBy();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<OrderByInfo>>
Sublayer.GetPopupEnabled() Method
Asynchronously retrieve the current value of the PopupEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetPopupEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
Sublayer.GetPopupTemplate() Method
Asynchronously retrieve the current value of the PopupTemplate property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate?> GetPopupTemplate();
Returns
System.Threading.Tasks.Task<PopupTemplate>
Sublayer.GetRelationships() Method
Asynchronously retrieve the current value of the Relationships property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Relationship>?> GetRelationships();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Relationship>>
Sublayer.GetRenderer() Method
Asynchronously retrieve the current value of the Renderer property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Renderers.Renderer?> GetRenderer();
Returns
System.Threading.Tasks.Task<Renderer>
Sublayer.GetSource() Method
Asynchronously retrieve the current value of the Source property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.DynamicLayer?> GetSource();
Returns
System.Threading.Tasks.Task<DynamicLayer>
Sublayer.GetSourceJSON() Method
Asynchronously retrieve the current value of the SourceJSON property.
public System.Threading.Tasks.Task<string?> GetSourceJSON();
Returns
System.Threading.Tasks.Task<System.String>
Sublayer.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>
Sublayer.GetSublayerId() Method
Asynchronously retrieve the current value of the SublayerId property.
public System.Threading.Tasks.Task<System.Nullable<long>> GetSublayerId();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int64>>
Sublayer.GetTitle() Method
Asynchronously retrieve the current value of the Title property.
public System.Threading.Tasks.Task<string?> GetTitle();
Returns
System.Threading.Tasks.Task<System.String>
Sublayer.GetTypeIdField() Method
Asynchronously retrieve the current value of the TypeIdField property.
public System.Threading.Tasks.Task<string?> GetTypeIdField();
Returns
System.Threading.Tasks.Task<System.String>
Sublayer.GetTypes() Method
Asynchronously retrieve the current value of the Types property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.FeatureType>?> GetTypes();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<FeatureType>>
Sublayer.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>
Sublayer.IsFulfilled() Method
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<bool>> IsFulfilled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
Sublayer.IsRejected() Method
isRejected() may be used to verify if creating an instance of the class is rejected.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<bool>> IsRejected();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
Sublayer.IsResolved() Method
isResolved() may be used to verify if creating an instance of the class is resolved.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<bool>> IsResolved();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
Sublayer.Load(CancellationToken) Method
Loads the resources referenced by this class.
param options.signal Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> Load(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.String>
Sublayer.QueryAttachments(AttachmentQuery, CancellationToken) Method
Query information about attachments associated with features.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.AttachmentsQueryResult?> QueryAttachments(dymaptic.GeoBlazor.Core.Model.AttachmentQuery attachmentQuery, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
attachmentQuery AttachmentQuery
Specifies the attachment parameters for query.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<AttachmentsQueryResult>
Sublayer.QueryFeatureCount(Query, CancellationToken) Method
Executes a Query against the sublayer and returns the number of features that
satisfy the query.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<System.Nullable<int>> QueryFeatureCount(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer’s configuration/filters is returned.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
Sublayer.QueryFeatures(Query, CancellationToken) Method
Executes a query against features in the sublayer.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.FeatureSet?> QueryFeatures(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer’s configuration/filters are returned.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<FeatureSet>
Sublayer.QueryObjectIds(Query, CancellationToken) Method
Executes a Query against the sublayer and returns an array of Object IDs for
features that satisfy the input query.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.ObjectId[]?> QueryObjectIds(dymaptic.GeoBlazor.Core.Model.Query query, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
query Query
Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer’s configuration/filters are returned.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<ObjectId[]>
Sublayer.QueryRelatedFeatures(RelationshipQuery, CancellationToken) Method
Executes a RelationshipQuery against the sublayer and returns
FeatureSets grouped by source layer or table objectIds.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.RelatedFeaturesQueryResult?> QueryRelatedFeatures(dymaptic.GeoBlazor.Core.Model.RelationshipQuery relationshipQuery, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
relationshipQuery RelationshipQuery
Specifies relationship parameters for querying related features or records from a layer or a table.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<RelatedFeaturesQueryResult>
Sublayer.QueryRelatedFeaturesCount(RelationshipQuery, CancellationToken) Method
Executes a RelationshipQuery against the sublayer and when resolved, it returns
an object containing key value pairs.
param options An object with the following properties.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.RelatedFeaturesCountQueryResult?> QueryRelatedFeaturesCount(dymaptic.GeoBlazor.Core.Model.RelationshipQuery relationshipQuery, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
relationshipQuery RelationshipQuery
Specifies relationship parameters for querying related features or records from a layer or a table.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<RelatedFeaturesCountQueryResult>
Sublayer.Refresh() Method
Provides a way to externally call StateHasChanged on the component.
public override System.Threading.Tasks.ValueTask Refresh();
Returns
System.Threading.Tasks.ValueTask
Sublayer.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.
Sublayer.RemoveFromLabelingInfo(Label[]) Method
Asynchronously remove an element from the LabelingInfo property.
public System.Threading.Tasks.Task RemoveFromLabelingInfo(params dymaptic.GeoBlazor.Core.Components.Label[] values);
Parameters
The elements to remove.
Returns
Sublayer.RemoveFromOrderBy(OrderByInfo[]) Method
Asynchronously remove an element from the OrderBy property.
public System.Threading.Tasks.Task RemoveFromOrderBy(params dymaptic.GeoBlazor.Core.Components.OrderByInfo[] values);
Parameters
values OrderByInfo[]
The elements to remove.
Returns
Sublayer.SetDefinitionExpression(string) Method
Asynchronously set the value of the DefinitionExpression property after render.
public System.Threading.Tasks.Task SetDefinitionExpression(string? value);
Parameters
value System.String
The value to set.
Returns
Sublayer.SetFloorInfo(LayerFloorInfo) Method
Asynchronously set the value of the FloorInfo property after render.
public System.Threading.Tasks.Task SetFloorInfo(dymaptic.GeoBlazor.Core.Components.LayerFloorInfo? value);
Parameters
value LayerFloorInfo
The value to set.
Returns
Sublayer.SetLabelingInfo(IReadOnlyList
Asynchronously set the value of the LabelingInfo property after render.
public System.Threading.Tasks.Task SetLabelingInfo(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<Label>
The value to set.
Returns
Sublayer.SetLabelsVisible(Nullable) Method
Asynchronously set the value of the LabelsVisible property after render.
public System.Threading.Tasks.Task SetLabelsVisible(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
Sublayer.SetLegendEnabled(Nullable) Method
Asynchronously set the value of the LegendEnabled property after render.
public System.Threading.Tasks.Task SetLegendEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
Sublayer.SetListMode(Nullable) Method
Asynchronously set the value of the ListMode property after render.
public System.Threading.Tasks.Task SetListMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> value);
Parameters
value System.Nullable<ListMode>
The value to set.
Returns
Sublayer.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.
Returns
Sublayer.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.
Returns
Sublayer.SetOpacity(Nullable) Method
Asynchronously set the value of the Opacity property after render.
public System.Threading.Tasks.Task SetOpacity(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
Sublayer.SetOrderBy(IReadOnlyList) Method
Asynchronously set the value of the OrderBy property after render.
public System.Threading.Tasks.Task SetOrderBy(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.OrderByInfo>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<OrderByInfo>
The value to set.
Returns
Sublayer.SetPopupEnabled(Nullable) Method
Asynchronously set the value of the PopupEnabled property after render.
public System.Threading.Tasks.Task SetPopupEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
Sublayer.SetPopupTemplate(PopupTemplate) Method
Asynchronously set the value of the PopupTemplate property after render.
public System.Threading.Tasks.Task SetPopupTemplate(dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? value);
Parameters
value PopupTemplate
The value to set.
Returns
Sublayer.SetRenderer(Renderer) Method
Asynchronously set the value of the Renderer property after render.
public System.Threading.Tasks.Task SetRenderer(dymaptic.GeoBlazor.Core.Components.Renderers.Renderer? value);
Parameters
value Renderer
The value to set.
Returns
Sublayer.SetSource(DynamicLayer) Method
Asynchronously set the value of the Source property after render.
public System.Threading.Tasks.Task SetSource(dymaptic.GeoBlazor.Core.Components.DynamicLayer? value);
Parameters
value DynamicLayer
The value to set.
Returns
Sublayer.SetSublayerId(Nullable) Method
Asynchronously set the value of the SublayerId property after render.
public System.Threading.Tasks.Task SetSublayerId(System.Nullable<long> value);
Parameters
value System.Nullable<System.Int64>
The value to set.
Returns
Sublayer.SetTitle(string) Method
Asynchronously set the value of the Title property after render.
public System.Threading.Tasks.Task SetTitle(string? value);
Parameters
value System.String
The value to set.
Returns
Sublayer.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
Sublayer.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.
Sublayer.UpdateFromJavaScript(Sublayer) Method
Copies values when returning from ArcGIS JavaScript. For internal use only.
public System.Threading.Tasks.Task UpdateFromJavaScript(dymaptic.GeoBlazor.Core.Components.Layers.Sublayer renderedSublayer);
Parameters
renderedSublayer Sublayer
Returns
Sublayer.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
Sublayer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()
Sublayer.When(Func, Func) Method
when() may be leveraged once an instance of the class is created.
param errback The function to execute when the promise fails.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> When(System.Func<System.Threading.Tasks.Task> callback, System.Func<System.Threading.Tasks.Task> errback);
Parameters
callback System.Func<System.Threading.Tasks.Task>
The function to call when the promise resolves.
errback System.Func<System.Threading.Tasks.Task>
The function to execute when the promise fails.