dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Renderers
SimpleRenderer Class
SimpleRenderer renders all features in a Layer with one
Symbol.
ArcGIS Maps SDK for JavaScript
public class SimpleRenderer : dymaptic.GeoBlazor.Core.Components.Renderers.Renderer,
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 🡒 SimpleRenderer
Implements IRendererWithVisualVariables, IRenderersRenderer, IMapComponent, IVisualVariablesMixin
Constructors
SimpleRenderer() Constructor
Parameterless constructor for use as a Razor Component.
public SimpleRenderer();
SimpleRenderer(Symbol, string, IReadOnlyList, AuthoringInfo) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public SimpleRenderer(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol symbol, string? label=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>? visualVariables=null, dymaptic.GeoBlazor.Core.Components.AuthoringInfo? authoringInfo=null);
Parameters
symbol Symbol
The symbol used by the renderer to visualize all features in the layer.
ArcGIS Maps SDK for JavaScript
label System.String
The label for the renderer.
ArcGIS Maps SDK for JavaScript
visualVariables System.Collections.Generic.IReadOnlyList<VisualVariable>
An array of VisualVariable objects.
ArcGIS Maps SDK for JavaScript
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
Properties
SimpleRenderer.Label Property
The label for the renderer. This describes what features with the given symbol represent in the real world. This will display next to the layer’s symbol inside the Legend widget.
This text is not displayed in the Legend when visualVariables are used. When the renderer contains visualVariables, you should set the title property in legendOptions on each visual variable to describe the visualization.
public string? Label { get; set; }
Property Value
SimpleRenderer.Symbol Property
The symbol used by the renderer to visualize all features in the layer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? Symbol { get; set; }
Property Value
SimpleRenderer.Type Property
The subclass Renderer type
public override dymaptic.GeoBlazor.Core.Enums.RendererType Type { get; }
Property Value
SimpleRenderer.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
SimpleRenderer.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
SimpleRenderer.GetLabel() Method
Asynchronously retrieve the current value of the Label property.
public System.Threading.Tasks.Task<string?> GetLabel();
Returns
System.Threading.Tasks.Task<System.String>
SimpleRenderer.GetSymbol() Method
Gets the current Symbol for the object.
public virtual System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol?> GetSymbol();
Returns
System.Threading.Tasks.Task<Symbol>
SimpleRenderer.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>>
SimpleRenderer.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.
SimpleRenderer.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
SimpleRenderer.SetLabel(string) Method
Asynchronously set the value of the Label property after render.
public System.Threading.Tasks.Task SetLabel(string? value);
Parameters
value System.String
The value to set.
Returns
SimpleRenderer.SetSymbol(Symbol) Method
Sets the Symbol for the object.
public virtual System.Threading.Tasks.Task SetSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol symbol);
Parameters
symbol Symbol
The Symbol for the object.
Returns
SimpleRenderer.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
SimpleRenderer.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.
SimpleRenderer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()