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
</a>
public class TextSymbol : dymaptic.GeoBlazor.Core.Components.Symbols.Symbol,
System.IEquatable<dymaptic.GeoBlazor.Core.Components.Symbols.TextSymbol>
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Symbol 🡒 TextSymbol
Implements System.IEquatable<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.Equals(object) Method
Determines whether the specified object is equal to the current object.
public override bool Equals(object? obj);
Parameters
obj System.Object
The object to compare with the current object.
Returns
System.Boolean
true if the specified object is equal to the current object; otherwise, false.
TextSymbol.GetHashCode() Method
Serves as the default hash function.
public override int GetHashCode();
Returns
System.Int32
A hash code for the current object.
TextSymbol.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnAfterRenderAsync(System.Boolean) 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.
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
TextSymbol.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();
Exceptions
MissingRequiredChildElementException
The consumer needs to provide the missing child component
MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components
Operators
TextSymbol.operator ==(TextSymbol, TextSymbol) Operator
Compares two TextSymbol objects for equality.
public static bool operator ==(dymaptic.GeoBlazor.Core.Components.Symbols.TextSymbol? left, dymaptic.GeoBlazor.Core.Components.Symbols.TextSymbol? right);
Parameters
left TextSymbol
right TextSymbol
Returns
TextSymbol.operator !=(TextSymbol, TextSymbol) Operator
Compares two TextSymbol objects for inequality.
public static bool operator !=(dymaptic.GeoBlazor.Core.Components.Symbols.TextSymbol? left, dymaptic.GeoBlazor.Core.Components.Symbols.TextSymbol? right);
Parameters
left TextSymbol
right TextSymbol