dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
SizeVariable Class
The size visual variable defines the size of individual features in a layer based
on a numeric (often thematic) value.
ArcGIS Maps SDK for JavaScript
public class SizeVariable : dymaptic.GeoBlazor.Core.Components.VisualVariable,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 VisualVariable 🡒 SizeVariable
Implements IMapComponent
Constructors
SizeVariable() Constructor
Parameterless constructor for use as a Razor Component.
public SizeVariable();
SizeVariable(string, Dimension, Dimension, Nullable, Nullable, Nullable, Nullable, string, string, Nullable, Nullable, string, string, VisualVariableLegendOptions, IReadOnlyList) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public SizeVariable(string field, dymaptic.GeoBlazor.Core.Model.Dimension? minSize=null, dymaptic.GeoBlazor.Core.Model.Dimension? maxSize=null, System.Nullable<double> minDataValue=null, System.Nullable<double> maxDataValue=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueRepresentation> valueRepresentation=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueUnit> valueUnit=null, string? normalizationField=null, string? target=null, System.Nullable<bool> useSymbolValue=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualAxis> axis=null, string? valueExpression=null, string? valueExpressionTitle=null, dymaptic.GeoBlazor.Core.Components.VisualVariableLegendOptions? legendOptions=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>? stops=null);
Parameters
field System.String
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
minSize Dimension
The size used to render a feature containing the minimum data value.
ArcGIS Maps SDK for JavaScript
maxSize Dimension
The size used to render a feature containing the maximum data value.
ArcGIS Maps SDK for JavaScript
minDataValue System.Nullable<System.Double>
The minimum data value used in the size ramp.
ArcGIS Maps SDK for JavaScript
maxDataValue System.Nullable<System.Double>
The maximum data value used in the size ramp.
ArcGIS Maps SDK for JavaScript
valueRepresentation System.Nullable<VisualValueRepresentation>
Specifies how to apply the data value when mapping real-world sizes.
ArcGIS Maps SDK for JavaScript
valueUnit System.Nullable<VisualValueUnit>
Indicates the unit of measurement used to interpret the value returned by field or valueExpression.
ArcGIS Maps SDK for JavaScript
normalizationField System.String
The name of the numeric attribute field used to normalize
the data in the given field.
ArcGIS Maps SDK for JavaScript
target System.String
This value must be outline when scaling polygon outline widths
based on the view scale.
ArcGIS Maps SDK for JavaScript
useSymbolValue System.Nullable<System.Boolean>
When setting a size visual variable on a renderer using an
ObjectSymbol3DLayer, this property indicates whether to apply the value
defined by the height,
width, or
depth properties to the corresponding axis of
this visual variable instead of proportionally scaling this axis’ value.
ArcGIS Maps SDK for JavaScript
axis System.Nullable<VisualAxis>
Only applicable when working in a SceneView.
default “all”
ArcGIS Maps SDK for JavaScript
valueExpression System.String
An Arcade expression following the specification
defined by the Arcade Visualization Profile.
ArcGIS Maps SDK for JavaScript
valueExpressionTitle System.String
The title identifying and describing the associated
Arcade expression as defined in the valueExpression property.
ArcGIS Maps SDK for JavaScript
legendOptions VisualVariableLegendOptions
An object providing options for displaying the visual variable in
the Legend.
ArcGIS Maps SDK for JavaScript
stops System.Collections.Generic.IReadOnlyList<SizeStop>
An array of objects that defines the mapping of data values returned from field or
valueExpression to icon sizes.
ArcGIS Maps SDK for JavaScript
Properties
SizeVariable.Axis Property
Only applicable when working in a SceneView. Defines the axis the size visual variable should be applied to when rendering features with an ObjectSymbol3DLayer. See the local scene sample for an example of this.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualAxis> Axis { get; set; }
Property Value
SizeVariable.MaxDataValue Property
The maximum data value used in the size ramp.
public System.Nullable<double> MaxDataValue { get; set; }
Property Value
System.Nullable<System.Double>
SizeVariable.MaxSize Property
The size used to render a feature containing the maximum data value.
When setting a number, sizes are expressed in points for all 2D symbols and 3D flat symbol layers; size is expressed in meters for all 3D volumetric symbols.
String values are only supported for 2D symbols and 3D flat symbol layers. Strings may specify size in either points or pixels (e.g. minSize: “16pt”, minSize: “12px”).
public dymaptic.GeoBlazor.Core.Model.Dimension? MaxSize { get; set; }
Property Value
SizeVariable.MinDataValue Property
The minimum data value used in the size ramp.
public System.Nullable<double> MinDataValue { get; set; }
Property Value
System.Nullable<System.Double>
SizeVariable.MinSize Property
The size used to render a feature containing the minimum data value.
When setting a number, sizes are expressed in points for all 2D symbols and 3D flat symbol layers; size is expressed in meters for all 3D volumetric symbols.
String values are only supported for 2D symbols and 3D flat symbol layers. Strings may specify size in either points or pixels (e.g. minSize: “16pt”, minSize: “12px”).
public dymaptic.GeoBlazor.Core.Model.Dimension? MinSize { get; set; }
Property Value
SizeVariable.NormalizationField Property
The name of the numeric attribute field used to normalize the data in the given field. If this field is used, then the values in maxDataValue and minDataValue or stops should be normalized as percentages or ratios.
public string? NormalizationField { get; set; }
Property Value
SizeVariable.Stops Property
An array of objects that defines the mapping of data values returned from field or
valueExpression to icon sizes.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>? Stops { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<SizeStop>
SizeVariable.Target Property
This value must be outline when scaling polygon outline widths based on the view scale. If scale-dependent icons are desired, then this property should be ignored.
public string? Target { get; set; }
Property Value
SizeVariable.Type Property
The visual variable type.
public override dymaptic.GeoBlazor.Core.Enums.VisualVariableType Type { get; }
Property Value
SizeVariable.UseSymbolValue Property
When setting a size visual variable on a renderer using an ObjectSymbol3DLayer, this property indicates whether to apply the value defined by the height, width, or depth properties to the corresponding axis of this visual variable instead of proportionally scaling this axis’ value.
public System.Nullable<bool> UseSymbolValue { get; set; }
Property Value
System.Nullable<System.Boolean>
SizeVariable.ValueRepresentation Property
Specifies how to apply the data value when mapping real-world sizes.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueRepresentation> ValueRepresentation { get; set; }
Property Value
System.Nullable<VisualValueRepresentation>
SizeVariable.ValueUnit Property
Indicates the unit of measurement used to interpret the value returned by field or valueExpression. For 3D volumetric symbols the default is meters. This property should not be used if the data value represents a thematic quantity (e.g. traffic count, census data, etc.).
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueUnit> ValueUnit { get; set; }
Property Value
System.Nullable<VisualValueUnit>
Methods
SizeVariable.AddToStops(SizeStop[]) Method
Asynchronously adds elements to the Stops property.
public System.Threading.Tasks.Task AddToStops(params dymaptic.GeoBlazor.Core.Components.SizeStop[] values);
Parameters
The elements to add.
Returns
SizeVariable.FlipSizes() Method
Modifies the SizeVariable in place by flipping the sizes in the stops.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task FlipSizes();
Returns
SizeVariable.GetAxis() Method
Asynchronously retrieve the current value of the Axis property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualAxis>> GetAxis();
Returns
System.Threading.Tasks.Task<System.Nullable<VisualAxis>>
SizeVariable.GetMaxDataValue() Method
Asynchronously retrieve the current value of the MaxDataValue property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxDataValue();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
SizeVariable.GetMaxSize() Method
Asynchronously retrieve the current value of the MaxSize property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension?> GetMaxSize();
Returns
System.Threading.Tasks.Task<Dimension>
SizeVariable.GetMinDataValue() Method
Asynchronously retrieve the current value of the MinDataValue property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinDataValue();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
SizeVariable.GetMinSize() Method
Asynchronously retrieve the current value of the MinSize property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension?> GetMinSize();
Returns
System.Threading.Tasks.Task<Dimension>
SizeVariable.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>
SizeVariable.GetStops() Method
Asynchronously retrieve the current value of the Stops property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>?> GetStops();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SizeStop>>
SizeVariable.GetTarget() Method
Asynchronously retrieve the current value of the Target property.
public System.Threading.Tasks.Task<string?> GetTarget();
Returns
System.Threading.Tasks.Task<System.String>
SizeVariable.GetUseSymbolValue() Method
Asynchronously retrieve the current value of the UseSymbolValue property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetUseSymbolValue();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SizeVariable.GetValueRepresentation() Method
Asynchronously retrieve the current value of the ValueRepresentation property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueRepresentation>> GetValueRepresentation();
Returns
System.Threading.Tasks.Task<System.Nullable<VisualValueRepresentation>>
SizeVariable.GetValueUnit() Method
Asynchronously retrieve the current value of the ValueUnit property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueUnit>> GetValueUnit();
Returns
System.Threading.Tasks.Task<System.Nullable<VisualValueUnit>>
SizeVariable.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 MapComponent
The calling, child component to register
Returns
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.
SizeVariable.RemoveFromStops(SizeStop[]) Method
Asynchronously remove an element from the Stops property.
public System.Threading.Tasks.Task RemoveFromStops(params dymaptic.GeoBlazor.Core.Components.SizeStop[] values);
Parameters
The elements to remove.
Returns
SizeVariable.SetAxis(Nullable) Method
Asynchronously set the value of the Axis property after render.
public System.Threading.Tasks.Task SetAxis(System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualAxis> value);
Parameters
value System.Nullable<VisualAxis>
The value to set.
Returns
SizeVariable.SetMaxDataValue(Nullable) Method
Asynchronously set the value of the MaxDataValue property after render.
public System.Threading.Tasks.Task SetMaxDataValue(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
SizeVariable.SetMaxSize(Dimension) Method
Asynchronously set the value of the MaxSize property after render.
public System.Threading.Tasks.Task SetMaxSize(dymaptic.GeoBlazor.Core.Model.Dimension? value);
Parameters
value Dimension
The value to set.
Returns
SizeVariable.SetMinDataValue(Nullable) Method
Asynchronously set the value of the MinDataValue property after render.
public System.Threading.Tasks.Task SetMinDataValue(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
SizeVariable.SetMinSize(Dimension) Method
Asynchronously set the value of the MinSize property after render.
public System.Threading.Tasks.Task SetMinSize(dymaptic.GeoBlazor.Core.Model.Dimension? value);
Parameters
value Dimension
The value to set.
Returns
SizeVariable.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
SizeVariable.SetStops(IReadOnlyList) Method
Asynchronously set the value of the Stops property after render.
public System.Threading.Tasks.Task SetStops(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SizeStop>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<SizeStop>
The value to set.
Returns
SizeVariable.SetTarget(string) Method
Asynchronously set the value of the Target property after render.
public System.Threading.Tasks.Task SetTarget(string? value);
Parameters
value System.String
The value to set.
Returns
SizeVariable.SetUseSymbolValue(Nullable) Method
Asynchronously set the value of the UseSymbolValue property after render.
public System.Threading.Tasks.Task SetUseSymbolValue(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SizeVariable.SetValueRepresentation(Nullable) Method
Asynchronously set the value of the ValueRepresentation property after render.
public System.Threading.Tasks.Task SetValueRepresentation(System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueRepresentation> value);
Parameters
value System.Nullable<VisualValueRepresentation>
The value to set.
Returns
SizeVariable.SetValueUnit(Nullable) Method
Asynchronously set the value of the ValueUnit property after render.
public System.Threading.Tasks.Task SetValueUnit(System.Nullable<dymaptic.GeoBlazor.Core.Enums.VisualValueUnit> value);
Parameters
value System.Nullable<VisualValueUnit>
The value to set.
Returns
SizeVariable.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 MapComponent
The child to unregister
Returns
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.
SizeVariable.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()