dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Symbols
TextSymbol Class
Text symbols are used to define the graphic for displaying labels on a FeatureLayer, CSVLayer, Sublayer, and
StreamLayer in a 2D MapView. Text symbols can also be used to define the symbol property of Graphic if the geometry
type is Point or Multipoint. With this class, you may alter the color, font, halo, and other properties of the
label graphic.
ArcGIS JS API
public class TextSymbol : dymaptic.GeoBlazor.Core.Components.Symbols.Symbol
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Symbol 🡒 TextSymbol
Constructors
TextSymbol() Constructor
Parameterless constructor for use as a razor component
public TextSymbol();
TextSymbol(string, MapColor, MapColor, Nullable, MapFont) Constructor
Constructor for use in code
public TextSymbol(string text, dymaptic.GeoBlazor.Core.Objects.MapColor? color=null, dymaptic.GeoBlazor.Core.Objects.MapColor? haloColor=null, System.Nullable<int> haloSize=null, dymaptic.GeoBlazor.Core.Components.Symbols.MapFont? font=null);
Parameters
text System.String
The text string to display in the view.
color MapColor
The color of the symbol.
haloColor MapColor
The color of the text symbol’s halo.
haloSize System.Nullable<System.Int32>
The size in points of the text symbol’s halo.
font MapFont
The MapFont used to style the text.
Properties
TextSymbol.Font Property
The MapFont used to style the text.
public dymaptic.GeoBlazor.Core.Components.Symbols.MapFont? Font { get; set; }
Property Value
TextSymbol.HaloColor Property
The color of the text symbol’s halo.
public dymaptic.GeoBlazor.Core.Objects.MapColor? HaloColor { get; set; }
Property Value
TextSymbol.HaloSize Property
The size in points of the text symbol’s halo.
public System.Nullable<int> HaloSize { get; set; }
Property Value
TextSymbol.Text Property
The text string to display in the view.
public string? Text { get; set; }
Property Value
TextSymbol.Type Property
The symbol type
public override string Type { get; }
Property Value
Methods
TextSymbol.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s 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.
TextSymbol.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.