dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Renderers
UniqueValueRenderer Class
UniqueValueRenderer allows you to symbolize features in a Layer based on one
or more categorical attributes.
ArcGIS Maps SDK for JavaScript
public class UniqueValueRenderer : dymaptic.GeoBlazor.Core.Components.Renderers.Renderer,
dymaptic.GeoBlazor.Core.Interfaces.IImageryRenderer,
dymaptic.GeoBlazor.Core.Interfaces.IRendererWithVisualVariables,
dymaptic.GeoBlazor.Core.Interfaces.IRenderersRenderer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IVisualVariablesMixin
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Renderer 🡒 UniqueValueRenderer
Implements IImageryRenderer, IRendererWithVisualVariables, IRenderersRenderer, IMapComponent, IVisualVariablesMixin
Constructors
UniqueValueRenderer() Constructor
Parameterless constructor for use as a Razor Component.
public UniqueValueRenderer();
UniqueValueRenderer(AuthoringInfo, FillSymbol, string, Symbol, string, string, string, string, UniqueValueRendererLegendOptions, Nullable, IReadOnlyList, IReadOnlyList, string, string, IReadOnlyList) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public UniqueValueRenderer(dymaptic.GeoBlazor.Core.Components.AuthoringInfo? authoringInfo=null, dymaptic.GeoBlazor.Core.Components.Symbols.FillSymbol? backgroundFillSymbol=null, string? defaultLabel=null, dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? defaultSymbol=null, string? field=null, string? field2=null, string? field3=null, string? fieldDelimiter=null, dymaptic.GeoBlazor.Core.Components.Renderers.UniqueValueRendererLegendOptions? legendOptions=null, System.Nullable<bool> orderByClassesEnabled=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueGroup>? uniqueValueGroups=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueInfo>? uniqueValueInfos=null, string? valueExpression=null, string? valueExpressionTitle=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>? visualVariables=null);
Parameters
authoringInfo AuthoringInfo
Authoring metadata only included in renderers generated from one of the
Smart Mapping creator methods, such as
sizeRendererCreator.createContinuousRenderer() or
colorRendererCreator.createContinuousRenderer().
ArcGIS Maps SDK for JavaScript
backgroundFillSymbol FillSymbol
This property is only relevant when symbolizing polygon features with marker symbols
(or IconSymbol3DLayer) in the uniqueValueInfos of this renderer.
ArcGIS Maps SDK for JavaScript
defaultLabel System.String
The label used in the Legend to describe features assigned the
default symbol.
ArcGIS Maps SDK for JavaScript
defaultSymbol Symbol
The symbol used to draw
all features with values not referenced by uniqueValueInfos or
uniqueValueGroups.
ArcGIS Maps SDK for JavaScript
field System.String
The name of the attribute field containing types or categorical values referenced
in uniqueValueInfos or uniqueValueGroups.
ArcGIS Maps SDK for JavaScript
field2 System.String
Specifies the name of an additional attribute field used to categorize features.
ArcGIS Maps SDK for JavaScript
field3 System.String
Specifies the name of a third attribute field used to categorize features.
ArcGIS Maps SDK for JavaScript
fieldDelimiter System.String
A string used as a separator between the values in the legend
if multiple attribute fields are used to categorize values.
ArcGIS Maps SDK for JavaScript
legendOptions UniqueValueRendererLegendOptions
An object providing options for displaying the renderer in the Legend.
ArcGIS Maps SDK for JavaScript
orderByClassesEnabled System.Nullable<System.Boolean>
Indicates whether the order of the classes or uniqueValueInfos in the renderer definition
should be used for the feature drawing order of the layer.
default false
ArcGIS Maps SDK for JavaScript
uniqueValueGroups System.Collections.Generic.IReadOnlyList<UniqueValueGroup>
An array of objects defining groups of unique values.
ArcGIS Maps SDK for JavaScript
uniqueValueInfos System.Collections.Generic.IReadOnlyList<UniqueValueInfo>
Defines categories and their corresponding symbols based on a set of values expected
from the provided field or valueExpression.
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
visualVariables System.Collections.Generic.IReadOnlyList<VisualVariable>
An array of VisualVariable objects.
ArcGIS Maps SDK for JavaScript
Properties
UniqueValueRenderer.BackgroundFillSymbol Property
This property is only relevant when symbolizing polygon features with marker symbols
(or IconSymbol3DLayer) in the uniqueValueInfos of this renderer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Symbols.FillSymbol? BackgroundFillSymbol { get; set; }
Property Value
UniqueValueRenderer.DefaultLabel Property
Label used in the Legend to describe features assigned the default symbol.
public string? DefaultLabel { get; set; }
Property Value
UniqueValueRenderer.DefaultSymbol Property
The symbol used to draw
all features with values not referenced by uniqueValueInfos or
uniqueValueGroups.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? DefaultSymbol { get; set; }
Property Value
UniqueValueRenderer.Field Property
The name of the attribute field the renderer uses to match unique values or types.
public string? Field { get; set; }
Property Value
UniqueValueRenderer.Field2 Property
Specifies the name of an additional attribute field used to categorize features.
ArcGIS Maps SDK for JavaScript
public string? Field2 { get; set; }
Property Value
UniqueValueRenderer.Field3 Property
Specifies the name of a third attribute field used to categorize features.
ArcGIS Maps SDK for JavaScript
public string? Field3 { get; set; }
Property Value
UniqueValueRenderer.FieldDelimiter Property
A string used as a separator between the values in the legend
if multiple attribute fields are used to categorize values.
ArcGIS Maps SDK for JavaScript
public string? FieldDelimiter { get; set; }
Property Value
UniqueValueRenderer.LegendOptions Property
An object providing options for displaying the renderer in the Legend.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Renderers.UniqueValueRendererLegendOptions? LegendOptions { get; set; }
Property Value
UniqueValueRendererLegendOptions
UniqueValueRenderer.OrderByClassesEnabled Property
Indicates whether the order of the classes or uniqueValueInfos in the renderer definition
should be used for the feature drawing order of the layer.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> OrderByClassesEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
UniqueValueRenderer.Type Property
The type of renderer.
public override dymaptic.GeoBlazor.Core.Enums.RendererType Type { get; }
Implements Type
Property Value
UniqueValueRenderer.UniqueValueGroups Property
An array of objects defining groups of unique values.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueGroup>? UniqueValueGroups { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<UniqueValueGroup>
UniqueValueRenderer.UniqueValueInfos Property
Defines categories and their corresponding symbols based on a set of values expected
from the provided field or valueExpression.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueInfo>? UniqueValueInfos { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<UniqueValueInfo>
UniqueValueRenderer.ValueExpression Property
An Arcade expression following the specification
defined by the Arcade Visualization Profile.
ArcGIS Maps SDK for JavaScript
public string? ValueExpression { get; set; }
Property Value
UniqueValueRenderer.ValueExpressionTitle Property
The title identifying and describing the associated Arcade
expression as defined in the valueExpression property.
ArcGIS Maps SDK for JavaScript
public string? ValueExpressionTitle { get; set; }
Property Value
UniqueValueRenderer.VisualVariables Property
An array of VisualVariable objects.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>? VisualVariables { get; set; }
Implements VisualVariables
Property Value
System.Collections.Generic.IReadOnlyList<VisualVariable>
Methods
UniqueValueRenderer.AddToUniqueValueGroups(UniqueValueGroup[]) Method
Asynchronously adds elements to the UniqueValueGroups property.
public System.Threading.Tasks.Task AddToUniqueValueGroups(params dymaptic.GeoBlazor.Core.Components.UniqueValueGroup[] values);
Parameters
values UniqueValueGroup[]
The elements to add.
Returns
UniqueValueRenderer.AddToUniqueValueInfos(UniqueValueInfo[]) Method
Asynchronously adds elements to the UniqueValueInfos property.
public System.Threading.Tasks.Task AddToUniqueValueInfos(params dymaptic.GeoBlazor.Core.Components.UniqueValueInfo[] values);
Parameters
values UniqueValueInfo[]
The elements to add.
Returns
UniqueValueRenderer.AddToVisualVariables(VisualVariable[]) Method
Asynchronously adds elements to the VisualVariables property.
public System.Threading.Tasks.Task AddToVisualVariables(params dymaptic.GeoBlazor.Core.Components.VisualVariable[] values);
Parameters
values VisualVariable[]
The elements to add.
Implements AddToVisualVariables(VisualVariable[])
Returns
UniqueValueRenderer.GetBackgroundFillSymbol() Method
Asynchronously retrieve the current value of the BackgroundFillSymbol property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.FillSymbol?> GetBackgroundFillSymbol();
Returns
System.Threading.Tasks.Task<FillSymbol>
UniqueValueRenderer.GetDefaultLabel() Method
Asynchronously retrieve the current value of the DefaultLabel property.
public System.Threading.Tasks.Task<string?> GetDefaultLabel();
Returns
System.Threading.Tasks.Task<System.String>
UniqueValueRenderer.GetDefaultSymbol() Method
Asynchronously retrieve the current value of the DefaultSymbol property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol?> GetDefaultSymbol();
Returns
System.Threading.Tasks.Task<Symbol>
UniqueValueRenderer.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>
UniqueValueRenderer.GetField2() Method
Asynchronously retrieve the current value of the Field2 property.
public System.Threading.Tasks.Task<string?> GetField2();
Returns
System.Threading.Tasks.Task<System.String>
UniqueValueRenderer.GetField3() Method
Asynchronously retrieve the current value of the Field3 property.
public System.Threading.Tasks.Task<string?> GetField3();
Returns
System.Threading.Tasks.Task<System.String>
UniqueValueRenderer.GetFieldDelimiter() Method
Asynchronously retrieve the current value of the FieldDelimiter property.
public System.Threading.Tasks.Task<string?> GetFieldDelimiter();
Returns
System.Threading.Tasks.Task<System.String>
UniqueValueRenderer.GetLegendOptions() Method
Asynchronously retrieve the current value of the LegendOptions property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Renderers.UniqueValueRendererLegendOptions?> GetLegendOptions();
Returns
System.Threading.Tasks.Task<UniqueValueRendererLegendOptions>
UniqueValueRenderer.GetOrderByClassesEnabled() Method
Asynchronously retrieve the current value of the OrderByClassesEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetOrderByClassesEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
UniqueValueRenderer.GetUniqueValueGroups() Method
Asynchronously retrieve the current value of the UniqueValueGroups property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueGroup>?> GetUniqueValueGroups();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<UniqueValueGroup>>
UniqueValueRenderer.GetUniqueValueInfo(Graphic) Method
Returns rendering and legend information (as defined by the renderer) associated with the given graphic.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.UniqueValueInfo?> GetUniqueValueInfo(dymaptic.GeoBlazor.Core.Components.Graphic graphic);
Parameters
graphic Graphic
The graphic whose rendering and legend information will be returned.
Returns
System.Threading.Tasks.Task<UniqueValueInfo>
UniqueValueRenderer.GetUniqueValueInfos() Method
Asynchronously retrieve the current value of the UniqueValueInfos property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueInfo>?> GetUniqueValueInfos();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<UniqueValueInfo>>
UniqueValueRenderer.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>
UniqueValueRenderer.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>
UniqueValueRenderer.GetVisualVariables() Method
Asynchronously retrieve the current value of the VisualVariables property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>?> GetVisualVariables();
Implements GetVisualVariables()
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<VisualVariable>>
UniqueValueRenderer.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.
UniqueValueRenderer.RemoveFromUniqueValueGroups(UniqueValueGroup[]) Method
Asynchronously remove an element from the UniqueValueGroups property.
public System.Threading.Tasks.Task RemoveFromUniqueValueGroups(params dymaptic.GeoBlazor.Core.Components.UniqueValueGroup[] values);
Parameters
values UniqueValueGroup[]
The elements to remove.
Returns
UniqueValueRenderer.RemoveFromUniqueValueInfos(UniqueValueInfo[]) Method
Asynchronously remove an element from the UniqueValueInfos property.
public System.Threading.Tasks.Task RemoveFromUniqueValueInfos(params dymaptic.GeoBlazor.Core.Components.UniqueValueInfo[] values);
Parameters
values UniqueValueInfo[]
The elements to remove.
Returns
UniqueValueRenderer.RemoveFromVisualVariables(VisualVariable[]) Method
Asynchronously remove an element from the VisualVariables property.
public System.Threading.Tasks.Task RemoveFromVisualVariables(params dymaptic.GeoBlazor.Core.Components.VisualVariable[] values);
Parameters
values VisualVariable[]
The elements to remove.
Implements RemoveFromVisualVariables(VisualVariable[])
Returns
UniqueValueRenderer.RemoveUniqueValueInfo(string) Method
Removes a unique value from the renderer.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task RemoveUniqueValueInfo(string value);
Parameters
value System.String
Value to remove from uniqueValueInfos.
Returns
UniqueValueRenderer.SetBackgroundFillSymbol(FillSymbol) Method
Asynchronously set the value of the BackgroundFillSymbol property after render.
public System.Threading.Tasks.Task SetBackgroundFillSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.FillSymbol? value);
Parameters
value FillSymbol
The value to set.
Returns
UniqueValueRenderer.SetDefaultLabel(string) Method
Asynchronously set the value of the DefaultLabel property after render.
public System.Threading.Tasks.Task SetDefaultLabel(string? value);
Parameters
value System.String
The value to set.
Returns
UniqueValueRenderer.SetDefaultSymbol(Symbol) Method
Asynchronously set the value of the DefaultSymbol property after render.
public System.Threading.Tasks.Task SetDefaultSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? value);
Parameters
value Symbol
The value to set.
Returns
UniqueValueRenderer.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
UniqueValueRenderer.SetField2(string) Method
Asynchronously set the value of the Field2 property after render.
public System.Threading.Tasks.Task SetField2(string? value);
Parameters
value System.String
The value to set.
Returns
UniqueValueRenderer.SetField3(string) Method
Asynchronously set the value of the Field3 property after render.
public System.Threading.Tasks.Task SetField3(string? value);
Parameters
value System.String
The value to set.
Returns
UniqueValueRenderer.SetFieldDelimiter(string) Method
Asynchronously set the value of the FieldDelimiter property after render.
public System.Threading.Tasks.Task SetFieldDelimiter(string? value);
Parameters
value System.String
The value to set.
Returns
UniqueValueRenderer.SetLegendOptions(UniqueValueRendererLegendOptions) Method
Asynchronously set the value of the LegendOptions property after render.
public System.Threading.Tasks.Task SetLegendOptions(dymaptic.GeoBlazor.Core.Components.Renderers.UniqueValueRendererLegendOptions? value);
Parameters
value UniqueValueRendererLegendOptions
The value to set.
Returns
UniqueValueRenderer.SetOrderByClassesEnabled(Nullable) Method
Asynchronously set the value of the OrderByClassesEnabled property after render.
public System.Threading.Tasks.Task SetOrderByClassesEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
UniqueValueRenderer.SetUniqueValueGroups(IReadOnlyList) Method
Asynchronously set the value of the UniqueValueGroups property after render.
public System.Threading.Tasks.Task SetUniqueValueGroups(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueGroup>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<UniqueValueGroup>
The value to set.
Returns
UniqueValueRenderer.SetUniqueValueInfos(IReadOnlyList) Method
Asynchronously set the value of the UniqueValueInfos property after render.
public System.Threading.Tasks.Task SetUniqueValueInfos(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.UniqueValueInfo>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<UniqueValueInfo>
The value to set.
Returns
UniqueValueRenderer.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
UniqueValueRenderer.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
UniqueValueRenderer.SetVisualVariables(IReadOnlyList) Method
Asynchronously set the value of the VisualVariables property after render.
public System.Threading.Tasks.Task SetVisualVariables(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<VisualVariable>
The value to set.
Implements SetVisualVariables(IReadOnlyList<VisualVariable>)
Returns
UniqueValueRenderer.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.
UniqueValueRenderer.ValidateRequiredChildren() Method
When a MapView is prepared to render, this will check to make sure that all properties with the RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Implements ValidateRequiredChildren()
Exceptions
MissingRequiredChildElementException
The consumer needs to provide the missing child component
MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components
UniqueValueRenderer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()
Explicit Interface Implementations
UniqueValueRenderer.dymaptic.GeoBlazor.Core.Interfaces.IImageryRenderer.Type Property
The type of renderer.
dymaptic.GeoBlazor.Core.Enums.ImageryRendererType dymaptic.GeoBlazor.Core.Interfaces.IImageryRenderer.Type { get; }
Implements Type