dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

AggregateField Class

Defines the aggregate fields used in a layer visualized with
FeatureReductionBinning or
FeatureReductionCluster.
ArcGIS Maps SDK for JavaScript

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

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 AggregateField

Constructors

AggregateField() Constructor

Parameterless constructor for use as a Razor Component.

public AggregateField();

AggregateField(string, Nullable, string, SupportExpressionInfo, string, Nullable) Constructor

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

public AggregateField(string? alias=null, System.Nullable<bool> isAutoGenerated=null, string? name=null, dymaptic.GeoBlazor.Core.Components.SupportExpressionInfo? onStatisticExpression=null, string? onStatisticField=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.AggregateStatisticType> statisticType=null);

Parameters

alias System.String

The display name that describes the aggregate field in the Legend,
Popup, and other UI elements.
default null
ArcGIS Maps SDK for JavaScript

isAutoGenerated System.Nullable<System.Boolean>

Indicates whether the field was created internally by the JS API’s rendering engine for
default FeatureReductionCluster visualizations.
default false
ArcGIS Maps SDK for JavaScript

name System.String

The name of the aggregate field.
ArcGIS Maps SDK for JavaScript

onStatisticExpression SupportExpressionInfo

An object containing an Arcade expression, which evaluates for each child feature represented
by the aggregate graphic.
ArcGIS Maps SDK for JavaScript

onStatisticField System.String

The name of the layer field to summarize with the given statisticType.
ArcGIS Maps SDK for JavaScript

statisticType System.Nullable<AggregateStatisticType>

Defines the type of statistic used to aggregate data returned from onStatisticField
or onStatisticExpression.
ArcGIS Maps SDK for JavaScript

Properties

AggregateField.Alias Property

The display name that describes the aggregate field in the Legend, Popup, and other UI elements.
Default Value: null

public string? Alias { get; set; }

Property Value

System.String

AggregateField.IsAutoGenerated Property

Indicates whether the field was created internally by the JS API’s rendering engine for default FeatureReductionCluster visualizations. You should avoid setting or changing this value. If true, then all other properties of the AggregateField are read-only.
Default Value:false

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

Property Value

System.Nullable<System.Boolean>

AggregateField.Name Property

The name of the aggregate field. This should describe the layer’s field and aggregation method used. For example, if creating a field that contains the total population for a set of features with a population field, then you could name this field total_population or popuplation_sum. This field name must start with a letter, and may only contain alphanumeric characters and underscore.

public string? Name { get; set; }

Property Value

System.String

AggregateField.OnStatisticExpression Property

An object containing an Arcade expression, which evaluates for each child feature represented
by the aggregate graphic.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.SupportExpressionInfo? OnStatisticExpression { get; set; }

Property Value

SupportExpressionInfo

AggregateField.OnStatisticField Property

The name of the layer field to summarize with the given StatisticType.

public string? OnStatisticField { get; set; }

Property Value

System.String

AggregateField.StatisticType Property

Defines the type of statistic used to aggregate data returned from OnStatisticField or OnStatisticExpression.

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.AggregateStatisticType> StatisticType { get; set; }

Property Value

System.Nullable<AggregateStatisticType>

Methods

AggregateField.GetAlias() Method

Asynchronously retrieve the current value of the Alias property.

public System.Threading.Tasks.Task<string?> GetAlias();

Returns

System.Threading.Tasks.Task<System.String>

AggregateField.GetIsAutoGenerated() Method

Asynchronously retrieve the current value of the IsAutoGenerated property.

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

Returns

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

AggregateField.GetName() Method

Asynchronously retrieve the current value of the Name property.

public System.Threading.Tasks.Task<string?> GetName();

Returns

System.Threading.Tasks.Task<System.String>

AggregateField.GetOnStatisticExpression() Method

Asynchronously retrieve the current value of the OnStatisticExpression property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SupportExpressionInfo?> GetOnStatisticExpression();

Returns

System.Threading.Tasks.Task<SupportExpressionInfo>

AggregateField.GetOnStatisticField() Method

Asynchronously retrieve the current value of the OnStatisticField property.

public System.Threading.Tasks.Task<string?> GetOnStatisticField();

Returns

System.Threading.Tasks.Task<System.String>

AggregateField.GetStatisticType() Method

Asynchronously retrieve the current value of the StatisticType property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.AggregateStatisticType>> GetStatisticType();

Returns

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

AggregateField.SetAlias(string) Method

Asynchronously set the value of the Alias property after render.

public System.Threading.Tasks.Task SetAlias(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

AggregateField.SetIsAutoGenerated(Nullable) Method

Asynchronously set the value of the IsAutoGenerated property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

AggregateField.SetName(string) Method

Asynchronously set the value of the Name property after render.

public System.Threading.Tasks.Task SetName(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

AggregateField.SetOnStatisticExpression(SupportExpressionInfo) Method

Asynchronously set the value of the OnStatisticExpression property after render.

public System.Threading.Tasks.Task SetOnStatisticExpression(dymaptic.GeoBlazor.Core.Components.SupportExpressionInfo? value);

Parameters

value SupportExpressionInfo

The value to set.

Returns

System.Threading.Tasks.Task

AggregateField.SetOnStatisticField(string) Method

Asynchronously set the value of the OnStatisticField property after render.

public System.Threading.Tasks.Task SetOnStatisticField(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

AggregateField.SetStatisticType(Nullable) Method

Asynchronously set the value of the StatisticType property after render.

public System.Threading.Tasks.Task SetStatisticType(System.Nullable<dymaptic.GeoBlazor.Core.Enums.AggregateStatisticType> value);

Parameters

value System.Nullable<AggregateStatisticType>

The value to set.

Returns

System.Threading.Tasks.Task

AggregateField.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()