dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
PortalBasemapsSource Class
The PortalBasemapsSource class is a Portal-driven Basemapsource in the BasemapGalleryViewModel or BasemapGallery widget.
ArcGIS Maps SDK for JavaScript
public class PortalBasemapsSource : dymaptic.GeoBlazor.Core.Components.LocalBasemapsSource,
dymaptic.GeoBlazor.Core.Interfaces.IBasemapGalleryWidgetSource,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 LocalBasemapsSource 🡒 PortalBasemapsSource
Implements IBasemapGalleryWidgetSource, IMapComponent
Constructors
PortalBasemapsSource() Constructor
Parameterless constructor for use as a Razor Component.
public PortalBasemapsSource();
PortalBasemapsSource(IReadOnlyList, BasemapFilter, Portal, string, UpdateBasemapsCallback) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public PortalBasemapsSource(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Basemap>? basemaps=null, dymaptic.GeoBlazor.Core.Functions.BasemapFilter? filterFunction=null, dymaptic.GeoBlazor.Core.Components.Portal? portal=null, string? query=null, dymaptic.GeoBlazor.Core.Functions.UpdateBasemapsCallback? updateBasemapsCallback=null);
Parameters
basemaps System.Collections.Generic.IReadOnlyList<Basemap>
A collection of Basemaps.
ArcGIS Maps SDK for JavaScript
filterFunction BasemapFilter(Basemap, int, IReadOnlyCollection<Basemap>)
Function used to filter basemaps after being fetched from the Portal.
ArcGIS Maps SDK for JavaScript
portal Portal
The Portal from which to fetch basemaps.
ArcGIS Maps SDK for JavaScript
query System.String
An object with key-value pairs used to create a custom basemap gallery group query.
ArcGIS Maps SDK for JavaScript
updateBasemapsCallback UpdateBasemapsCallback(IReadOnlyCollection<Basemap>)
Callback for updating basemaps after being fetched and filtered.
ArcGIS Maps SDK for JavaScript
Properties
PortalBasemapsSource.FilterFunction Property
Function used to filter basemaps after being fetched from the Portal.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.BasemapFilter? FilterFunction { get; set; }
Property Value
BasemapFilter(Basemap, int, IReadOnlyCollection<Basemap>)
PortalBasemapsSource.HasFilterFunction Property
A convenience property that signifies whether a custom FilterFunction function was registered.
public bool HasFilterFunction { get; }
Property Value
PortalBasemapsSource.HasUpdateBasemapsCallback Property
A convenience property that signifies whether a custom UpdateBasemapsCallback function was registered.
public bool HasUpdateBasemapsCallback { get; }
Property Value
PortalBasemapsSource.Portal Property
The Portal from which to fetch basemaps.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Portal? Portal { get; set; }
Property Value
PortalBasemapsSource.Query Property
An object with key-value pairs used to create a custom basemap gallery group query.
ArcGIS Maps SDK for JavaScript
public string? Query { get; set; }
Property Value
PortalBasemapsSource.QueryParams Property
An object with key-value pairs used to create a custom basemap gallery group query.
public System.Collections.Generic.Dictionary<string,string>? QueryParams { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String,System.String>
Remarks
User either QueryString or QueryParams
PortalBasemapsSource.QueryString Property
An query string used to create a custom basemap gallery group query.
public string? QueryString { get; set; }
Property Value
Remarks
User either QueryString or QueryParams
PortalBasemapsSource.UpdateBasemapsCallback Property
Callback for updating basemaps after being fetched and filtered.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.UpdateBasemapsCallback? UpdateBasemapsCallback { get; set; }
Property Value
UpdateBasemapsCallback(IReadOnlyCollection<Basemap>)
Methods
PortalBasemapsSource.GetPortal() Method
Asynchronously retrieve the current value of the Portal property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Portal?> GetPortal();
Returns
System.Threading.Tasks.Task<Portal>
PortalBasemapsSource.GetQuery() Method
Asynchronously retrieve the current value of the Query property.
public System.Threading.Tasks.Task<string?> GetQuery();
Returns
System.Threading.Tasks.Task<System.String>
PortalBasemapsSource.OnJsFilterFunction(Basemap, int, IReadOnlyCollection) Method
JS-invokable method that triggers the FilterFunction function.
Should not be called by consuming code.
public System.Threading.Tasks.Task<System.Nullable<bool>> OnJsFilterFunction(dymaptic.GeoBlazor.Core.Components.Basemap item, int index, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Basemap> array);
Parameters
item Basemap
index System.Int32
array System.Collections.Generic.IReadOnlyCollection<Basemap>
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
PortalBasemapsSource.OnJsUpdateBasemapsCallback(IReadOnlyCollection) Method
JS-invokable method that triggers the UpdateBasemapsCallback function.
Should not be called by consuming code.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Basemap[]?> OnJsUpdateBasemapsCallback(System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Basemap> items);
Parameters
items System.Collections.Generic.IReadOnlyCollection<Basemap>
Returns
System.Threading.Tasks.Task<Basemap[]>
PortalBasemapsSource.Refresh() Method
Refreshes basemaps by fetching them from the Portal.
ArcGIS Maps SDK for JavaScript
public override System.Threading.Tasks.ValueTask Refresh();
Returns
System.Threading.Tasks.ValueTask
PortalBasemapsSource.SetPortal(Portal) Method
Asynchronously set the value of the Portal property after render.
public System.Threading.Tasks.Task SetPortal(dymaptic.GeoBlazor.Core.Components.Portal? value);
Parameters
value Portal
The value to set.
Returns
PortalBasemapsSource.SetQuery(string) Method
Asynchronously set the value of the Query property after render.
public System.Threading.Tasks.Task SetQuery(string? value);
Parameters
value System.String
The value to set.
Returns
PortalBasemapsSource.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()