dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
AuthoringInfoVisualVariable Class
Contains authoring properties of visual variables generated from
one of the Smart Mapping methods or sliders.
ArcGIS Maps SDK for JavaScript
public class AuthoringInfoVisualVariable : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 AuthoringInfoVisualVariable
Constructors
AuthoringInfoVisualVariable() Constructor
Parameterless constructor for use as a Razor Component.
public AuthoringInfoVisualVariable();
AuthoringInfoVisualVariable(string, string, Nullable, Nullable, string, Nullable, Nullable, IReadOnlyList, string, Nullable, Nullable, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public AuthoringInfoVisualVariable(string? endTime=null, string? field=null, System.Nullable<double> maxSliderValue=null, System.Nullable<double> minSliderValue=null, string? normalizationField=null, System.Nullable<double> referenceSizeScale=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.ReferenceSizeSymbolStyle> referenceSizeSymbolStyle=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>? sizeStops=null, string? startTime=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableStyle> style=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableTheme> theme=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableUnits> units=null);
Parameters
endTime System.String
If an age or timeline renderer was generated, indicates the end
time of the visualization.
ArcGIS Maps SDK for JavaScript
field System.String
Indicates the field name used for generating the data-driven visualization.
ArcGIS Maps SDK for JavaScript
maxSliderValue System.Nullable<System.Double>
Indicates the value of the upper handle if a slider was used to generate the visual variable.
ArcGIS Maps SDK for JavaScript
minSliderValue System.Nullable<System.Double>
Indicates the value of the lower handle if a slider was used to generate the visual variable.
ArcGIS Maps SDK for JavaScript
normalizationField System.String
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
referenceSizeScale System.Nullable<System.Double>
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
referenceSizeSymbolStyle System.Nullable<ReferenceSizeSymbolStyle>
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
sizeStops System.Collections.Generic.IReadOnlyList<SizeStop>
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
startTime System.String
If an age or timeline renderer was generated, indicates the start
time of the visualization.
ArcGIS Maps SDK for JavaScript
style System.Nullable<AuthoringInfoVisualVariableStyle>
If the UI offers the option to display values based on a ratio or
percentage, this indicates which selection was made.
ArcGIS Maps SDK for JavaScript
theme System.Nullable<AuthoringInfoVisualVariableTheme>
Indicates the theme selected by the user when generating a renderer
or visual variable with one of the Smart Mapping functions.
ArcGIS Maps SDK for JavaScript
units System.Nullable<AuthoringInfoVisualVariableUnits>
If an age or timeline renderer was generated, indicates the time units used.
ArcGIS Maps SDK for JavaScript
Properties
AuthoringInfoVisualVariable.EndTime Property
If an age or timeline renderer was generated, indicates the end
time of the visualization.
ArcGIS Maps SDK for JavaScript
public string? EndTime { get; set; }
Property Value
AuthoringInfoVisualVariable.Field Property
Indicates the field name used for generating the data-driven visualization.
ArcGIS Maps SDK for JavaScript
public string? Field { get; set; }
Property Value
AuthoringInfoVisualVariable.MaxSliderValue Property
Indicates the value of the upper handle if a slider was used to generate the visual variable.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MaxSliderValue { get; set; }
Property Value
System.Nullable<System.Double>
AuthoringInfoVisualVariable.MinSliderValue Property
Indicates the value of the lower handle if a slider was used to generate the visual variable.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MinSliderValue { get; set; }
Property Value
System.Nullable<System.Double>
AuthoringInfoVisualVariable.NormalizationField Property
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
public string? NormalizationField { get; set; }
Property Value
AuthoringInfoVisualVariable.ReferenceSizeScale Property
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> ReferenceSizeScale { get; set; }
Property Value
System.Nullable<System.Double>
AuthoringInfoVisualVariable.ReferenceSizeSymbolStyle Property
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ReferenceSizeSymbolStyle> ReferenceSizeSymbolStyle { get; set; }
Property Value
System.Nullable<ReferenceSizeSymbolStyle>
AuthoringInfoVisualVariable.SizeStops Property
Only applicable when theme is reference-size.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>? SizeStops { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<SizeStop>
AuthoringInfoVisualVariable.StartTime Property
If an age or timeline renderer was generated, indicates the start
time of the visualization.
ArcGIS Maps SDK for JavaScript
public string? StartTime { get; set; }
Property Value
AuthoringInfoVisualVariable.Style Property
If the UI offers the option to display values based on a ratio or
percentage, this indicates which selection was made.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableStyle> Style { get; set; }
Property Value
System.Nullable<AuthoringInfoVisualVariableStyle>
AuthoringInfoVisualVariable.Theme Property
Indicates the theme selected by the user when generating a renderer
or visual variable with one of the Smart Mapping functions.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableTheme> Theme { get; set; }
Property Value
System.Nullable<AuthoringInfoVisualVariableTheme>
AuthoringInfoVisualVariable.Units Property
If an age or timeline renderer was generated, indicates the time units used.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableUnits> Units { get; set; }
Property Value
System.Nullable<AuthoringInfoVisualVariableUnits>
Methods
AuthoringInfoVisualVariable.AddToSizeStops(SizeStop[]) Method
Asynchronously adds elements to the SizeStops property.
public System.Threading.Tasks.Task AddToSizeStops(params dymaptic.GeoBlazor.Core.Components.SizeStop[] values);
Parameters
The elements to add.
Returns
AuthoringInfoVisualVariable.GetEndTime() Method
Asynchronously retrieve the current value of the EndTime property.
public System.Threading.Tasks.Task<string?> GetEndTime();
Returns
System.Threading.Tasks.Task<System.String>
AuthoringInfoVisualVariable.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>
AuthoringInfoVisualVariable.GetMaxSliderValue() Method
Asynchronously retrieve the current value of the MaxSliderValue property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxSliderValue();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
AuthoringInfoVisualVariable.GetMinSliderValue() Method
Asynchronously retrieve the current value of the MinSliderValue property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinSliderValue();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
AuthoringInfoVisualVariable.GetNormalizationField() Method
Asynchronously retrieve the current value of the NormalizationField property.
public System.Threading.Tasks.Task<string?> GetNormalizationField();
Returns
System.Threading.Tasks.Task<System.String>
AuthoringInfoVisualVariable.GetReferenceSizeScale() Method
Asynchronously retrieve the current value of the ReferenceSizeScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetReferenceSizeScale();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
AuthoringInfoVisualVariable.GetReferenceSizeSymbolStyle() Method
Asynchronously retrieve the current value of the ReferenceSizeSymbolStyle property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ReferenceSizeSymbolStyle>> GetReferenceSizeSymbolStyle();
Returns
System.Threading.Tasks.Task<System.Nullable<ReferenceSizeSymbolStyle>>
AuthoringInfoVisualVariable.GetSizeStops() Method
Asynchronously retrieve the current value of the SizeStops property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>?> GetSizeStops();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SizeStop>>
AuthoringInfoVisualVariable.GetStartTime() Method
Asynchronously retrieve the current value of the StartTime property.
public System.Threading.Tasks.Task<string?> GetStartTime();
Returns
System.Threading.Tasks.Task<System.String>
AuthoringInfoVisualVariable.GetStyle() Method
Asynchronously retrieve the current value of the Style property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableStyle>> GetStyle();
Returns
System.Threading.Tasks.Task<System.Nullable<AuthoringInfoVisualVariableStyle>>
AuthoringInfoVisualVariable.GetTheme() Method
Asynchronously retrieve the current value of the Theme property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableTheme>> GetTheme();
Returns
System.Threading.Tasks.Task<System.Nullable<AuthoringInfoVisualVariableTheme>>
AuthoringInfoVisualVariable.GetUnits() Method
Asynchronously retrieve the current value of the Units property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableUnits>> GetUnits();
Returns
System.Threading.Tasks.Task<System.Nullable<AuthoringInfoVisualVariableUnits>>
AuthoringInfoVisualVariable.RemoveFromSizeStops(SizeStop[]) Method
Asynchronously remove an element from the SizeStops property.
public System.Threading.Tasks.Task RemoveFromSizeStops(params dymaptic.GeoBlazor.Core.Components.SizeStop[] values);
Parameters
The elements to remove.
Returns
AuthoringInfoVisualVariable.SetEndTime(string) Method
Asynchronously set the value of the EndTime property after render.
public System.Threading.Tasks.Task SetEndTime(string? value);
Parameters
value System.String
The value to set.
Returns
AuthoringInfoVisualVariable.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
AuthoringInfoVisualVariable.SetMaxSliderValue(Nullable) Method
Asynchronously set the value of the MaxSliderValue property after render.
public System.Threading.Tasks.Task SetMaxSliderValue(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
AuthoringInfoVisualVariable.SetMinSliderValue(Nullable) Method
Asynchronously set the value of the MinSliderValue property after render.
public System.Threading.Tasks.Task SetMinSliderValue(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
AuthoringInfoVisualVariable.SetNormalizationField(string) Method
Asynchronously set the value of the NormalizationField property after render.
public System.Threading.Tasks.Task SetNormalizationField(string? value);
Parameters
value System.String
The value to set.
Returns
AuthoringInfoVisualVariable.SetReferenceSizeScale(Nullable) Method
Asynchronously set the value of the ReferenceSizeScale property after render.
public System.Threading.Tasks.Task SetReferenceSizeScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
AuthoringInfoVisualVariable.SetReferenceSizeSymbolStyle(Nullable) Method
Asynchronously set the value of the ReferenceSizeSymbolStyle property after render.
public System.Threading.Tasks.Task SetReferenceSizeSymbolStyle(System.Nullable<dymaptic.GeoBlazor.Core.Enums.ReferenceSizeSymbolStyle> value);
Parameters
value System.Nullable<ReferenceSizeSymbolStyle>
The value to set.
Returns
AuthoringInfoVisualVariable.SetSizeStops(IReadOnlyList) Method
Asynchronously set the value of the SizeStops property after render.
public System.Threading.Tasks.Task SetSizeStops(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<SizeStop>
The value to set.
Returns
AuthoringInfoVisualVariable.SetStartTime(string) Method
Asynchronously set the value of the StartTime property after render.
public System.Threading.Tasks.Task SetStartTime(string? value);
Parameters
value System.String
The value to set.
Returns
AuthoringInfoVisualVariable.SetStyle(Nullable) Method
Asynchronously set the value of the Style property after render.
public System.Threading.Tasks.Task SetStyle(System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableStyle> value);
Parameters
value System.Nullable<AuthoringInfoVisualVariableStyle>
The value to set.
Returns
AuthoringInfoVisualVariable.SetTheme(Nullable) Method
Asynchronously set the value of the Theme property after render.
public System.Threading.Tasks.Task SetTheme(System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableTheme> value);
Parameters
value System.Nullable<AuthoringInfoVisualVariableTheme>
The value to set.
Returns
AuthoringInfoVisualVariable.SetUnits(Nullable) Method
Asynchronously set the value of the Units property after render.
public System.Threading.Tasks.Task SetUnits(System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoVisualVariableUnits> value);
Parameters
value System.Nullable<AuthoringInfoVisualVariableUnits>
The value to set.
Returns
AuthoringInfoVisualVariable.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()