dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

ActionToggle Class

A customizable toggle used in the LayerList widget that performs a specific action(s) which can be toggled on/off.
ArcGIS Maps SDK for JavaScript

public class ActionToggle : dymaptic.GeoBlazor.Core.Components.ActionBase

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 ActionBase 🡒 ActionToggle

Constructors

ActionToggle() Constructor

Parameterless constructor for use as a Razor Component.

public ActionToggle();

ActionToggle(string, string, Func, Nullable, Nullable, Nullable, Nullable, string, string) Constructor

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

public ActionToggle(string? title=null, string? actionId=null, System.Func<System.Threading.Tasks.Task>? callbackFunction=null, System.Nullable<bool> value=null, System.Nullable<bool> active=null, System.Nullable<bool> disabled=null, System.Nullable<bool> visible=null, string? className=null, string? icon=null);

Parameters

title System.String

The title of the action.
ArcGIS Maps SDK for JavaScript

actionId System.String

The name of the ID assigned to this action.

callbackFunction System.Func<System.Threading.Tasks.Task>

The action function to perform on click.

value System.Nullable<System.Boolean>

Indicates the value of whether the action is toggled on/off.
default false
ArcGIS Maps SDK for JavaScript

active System.Nullable<System.Boolean>

Set this property to true to display a spinner icon.
default false
ArcGIS Maps SDK for JavaScript

disabled System.Nullable<System.Boolean>

Indicates whether this action is disabled.
default false
ArcGIS Maps SDK for JavaScript

visible System.Nullable<System.Boolean>

Indicates if the action is visible.

className System.String

This adds a CSS class to the ActionButton’s node.
ArcGIS Maps SDK for JavaScript

icon System.String

Calcite icon used for the action.
default null
ArcGIS Maps SDK for JavaScript

Properties

ActionToggle.Type Property

Specifies the type of action. Choose between “button” or “toggle”.

public override string Type { get; }

Property Value

System.String

ActionToggle.Value Property

Indicates the value of whether the action is toggled on/off.

public System.Nullable<bool> Value { get; set; }

Property Value

System.Nullable<System.Boolean>

Methods

ActionToggle.GetValue() Method

Asynchronously retrieve the current value of the Value property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetValue();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

ActionToggle.SetValue(bool) Method

Asynchronously set the value of the Value property after render.

public System.Threading.Tasks.Task SetValue(bool value);

Parameters

value System.Boolean

The value to set.

Returns

System.Threading.Tasks.Task