dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

VisualVariable Class

The visual variable base class.
ArcGIS Maps SDK for JavaScript

public abstract class VisualVariable : dymaptic.GeoBlazor.Core.Components.MapComponent

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

Derived
↳ ColorVariable
↳ OpacityVariable
↳ RotationVariable
↳ SizeVariable

Properties

VisualVariable.Field Property

The name of the numeric attribute field that contains the data
values used to determine the color/opacity/size/rotation of each feature.
ArcGIS Maps SDK for JavaScript

public string Field { get; set; }

Property Value

System.String

VisualVariable.LegendOptions Property

An object providing options for displaying the visual variable in
the Legend.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.VisualVariableLegendOptions? LegendOptions { get; set; }

Property Value

VisualVariableLegendOptions

VisualVariable.Type Property

The visual variable type.

public abstract dymaptic.GeoBlazor.Core.Enums.VisualVariableType Type { get; }

Property Value

VisualVariableType

VisualVariable.ValueExpression Property

An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions in visual variables may reference field values using the $feature profile variable and must return a number.
The values returned from this expression are the data used to drive the visualization as defined in the stops. This takes precedence over field. Therefore, this property is typically used as an alternative to field in visual variables.

public string? ValueExpression { get; set; }

Property Value

System.String

VisualVariable.ValueExpressionTitle Property

The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the title of the corresponding visual variable in the Legend in the absence of a provided title in the legendOptions property.

public string? ValueExpressionTitle { get; set; }

Property Value

System.String

Methods

VisualVariable.GetField() Method

Asynchronously retrieve the current value of the Field property.

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

Returns

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

VisualVariable.GetLegendOptions() Method

Asynchronously retrieve the current value of the LegendOptions property.

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

Returns

System.Threading.Tasks.Task<VisualVariableLegendOptions>

VisualVariable.GetValueExpression() Method

Asynchronously retrieve the current value of the ValueExpression property.

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

Returns

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

VisualVariable.GetValueExpressionTitle() Method

Asynchronously retrieve the current value of the ValueExpressionTitle property.

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

Returns

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

VisualVariable.SetField(string) Method

Asynchronously set the value of the Field property after render.

public System.Threading.Tasks.Task SetField(string value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

VisualVariable.SetLegendOptions(VisualVariableLegendOptions) Method

Asynchronously set the value of the LegendOptions property after render.

public System.Threading.Tasks.Task SetLegendOptions(dymaptic.GeoBlazor.Core.Components.VisualVariableLegendOptions? value);

Parameters

value VisualVariableLegendOptions

The value to set.

Returns

System.Threading.Tasks.Task

VisualVariable.SetValueExpression(string) Method

Asynchronously set the value of the ValueExpression property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

VisualVariable.SetValueExpressionTitle(string) Method

Asynchronously set the value of the ValueExpressionTitle property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

VisualVariable.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()