GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components

SupportingWidgetDefaults Class

Set this to customize any supporting Editor widget’s default behavior.
ArcGIS Maps SDK for JavaScript

public class SupportingWidgetDefaults : dymaptic.GeoBlazor.Core.Components.MapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 SupportingWidgetDefaults

Constructors

SupportingWidgetDefaults() Constructor

Parameterless constructor for use as a Razor Component.

public SupportingWidgetDefaults();

SupportingWidgetDefaults(SupportingWidgetAttachments, SupportingWidgetFeatureForm, SupportingWidgetFeatureTemplates, SupportingWidgetSketch) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public SupportingWidgetDefaults(dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetAttachments? attachments=null, dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureForm? featureForm=null, dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureTemplates? featureTemplates=null, dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetSketch? sketch=null);

Parameters

attachments SupportingWidgetAttachments

An object containing properties specific for customizing the Attachments widget.
ArcGIS Maps SDK for JavaScript

featureForm SupportingWidgetFeatureForm

An object containing properties specific for customizing the FeatureForm widget.
ArcGIS Maps SDK for JavaScript

featureTemplates SupportingWidgetFeatureTemplates

An object containing properties specific for customizing the FeatureTemplates widget.
ArcGIS Maps SDK for JavaScript

sketch SupportingWidgetSketch

An object containing properties specific for customizing the Sketch widget.
ArcGIS Maps SDK for JavaScript

Properties

SupportingWidgetDefaults.Attachments Property

An object containing properties specific for customizing the Attachments widget.

public dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetAttachments? Attachments { get; set; }

Property Value

SupportingWidgetAttachments

SupportingWidgetDefaults.FeatureForm Property

An object containing properties specific for customizing the FeatureForm widget.

public dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureForm? FeatureForm { get; set; }

Property Value

SupportingWidgetFeatureForm

SupportingWidgetDefaults.FeatureTemplates Property

An object containing properties specific for customizing the FeatureTemplates widget.

public dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureTemplates? FeatureTemplates { get; set; }

Property Value

SupportingWidgetFeatureTemplates

SupportingWidgetDefaults.Sketch Property

An object containing properties specific for customizing the FeatureTemplates widget.

public dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetSketch? Sketch { get; set; }

Property Value

SupportingWidgetSketch

Methods

SupportingWidgetDefaults.GetAttachments() Method

Asynchronously retrieve the current value of the Attachments property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetAttachments?> GetAttachments();

Returns

System.Threading.Tasks.Task<SupportingWidgetAttachments>

SupportingWidgetDefaults.GetFeatureForm() Method

Asynchronously retrieve the current value of the FeatureForm property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureForm?> GetFeatureForm();

Returns

System.Threading.Tasks.Task<SupportingWidgetFeatureForm>

SupportingWidgetDefaults.GetFeatureTemplates() Method

Asynchronously retrieve the current value of the FeatureTemplates property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureTemplates?> GetFeatureTemplates();

Returns

System.Threading.Tasks.Task<SupportingWidgetFeatureTemplates>

SupportingWidgetDefaults.GetSketch() Method

Asynchronously retrieve the current value of the Sketch property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetSketch?> GetSketch();

Returns

System.Threading.Tasks.Task<SupportingWidgetSketch>

SupportingWidgetDefaults.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 dymaptic.GeoBlazor.Core.Components.MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

Exceptions

dymaptic.GeoBlazor.Core.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.

SupportingWidgetDefaults.SetAttachments(SupportingWidgetAttachments) Method

Asynchronously set the value of the Attachments property after render.

public System.Threading.Tasks.Task SetAttachments(dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetAttachments? value);

Parameters

value SupportingWidgetAttachments

The value to set.

Returns

System.Threading.Tasks.Task

SupportingWidgetDefaults.SetFeatureForm(SupportingWidgetFeatureForm) Method

Asynchronously set the value of the FeatureForm property after render.

public System.Threading.Tasks.Task SetFeatureForm(dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureForm? value);

Parameters

value SupportingWidgetFeatureForm

The value to set.

Returns

System.Threading.Tasks.Task

SupportingWidgetDefaults.SetFeatureTemplates(SupportingWidgetFeatureTemplates) Method

Asynchronously set the value of the FeatureTemplates property after render.

public System.Threading.Tasks.Task SetFeatureTemplates(dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetFeatureTemplates? value);

Parameters

value SupportingWidgetFeatureTemplates

The value to set.

Returns

System.Threading.Tasks.Task

SupportingWidgetDefaults.SetSketch(SupportingWidgetSketch) Method

Asynchronously set the value of the Sketch property after render.

public System.Threading.Tasks.Task SetSketch(dymaptic.GeoBlazor.Pro.Components.Widgets.SupportingWidgetSketch? value);

Parameters

value SupportingWidgetSketch

The value to set.

Returns

System.Threading.Tasks.Task

SupportingWidgetDefaults.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 dymaptic.GeoBlazor.Core.Components.MapComponent

The child to unregister

Returns

System.Threading.Tasks.Task

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.

SupportingWidgetDefaults.ValidateRequiredChildren() Method

When a dymaptic.GeoBlazor.Core.Components.Views.MapView is prepared to render, this will check to make sure that all properties with the dymaptic.GeoBlazor.Core.Attributes.RequiredPropertyAttribute are provided.

public override void ValidateRequiredChildren();

Implements ValidateRequiredChildren()

Exceptions

dymaptic.GeoBlazor.Core.Exceptions.MissingRequiredChildElementException
The consumer needs to provide the missing child component

dymaptic.GeoBlazor.Core.Exceptions.MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components