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.
ArcGIS Maps SDK for JavaScript
public class TextSymbol : dymaptic.GeoBlazor.Core.Components.Symbols.Symbol,
dymaptic.GeoBlazor.Core.Interfaces.ISymbol2D,
dymaptic.GeoBlazor.Core.Interfaces.ISymbol2D3D,
dymaptic.GeoBlazor.Core.Interfaces.ISymbolsSymbol,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Symbol 🡒 TextSymbol
Implements ISymbol2D, ISymbol2D3D, ISymbolsSymbol, IMapComponent
Constructors
TextSymbol() Constructor
Parameterless constructor for use as a Razor Component.
public TextSymbol();
TextSymbol(string, MapColor, MapColor, Dimension, MapFont, Nullable, MapColor, MapColor, Nullable, Nullable, Nullable, Nullable, Dimension, Nullable, Nullable, Dimension, Dimension) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public TextSymbol(string text, dymaptic.GeoBlazor.Core.Model.MapColor? color=null, dymaptic.GeoBlazor.Core.Model.MapColor? haloColor=null, dymaptic.GeoBlazor.Core.Model.Dimension? haloSize=null, dymaptic.GeoBlazor.Core.Components.MapFont? font=null, System.Nullable<double> angle=null, dymaptic.GeoBlazor.Core.Model.MapColor? backgroundColor=null, dymaptic.GeoBlazor.Core.Model.MapColor? borderLineColor=null, System.Nullable<double> borderLineSize=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.HorizontalAlignment> horizontalAlignment=null, System.Nullable<bool> kerning=null, System.Nullable<double> lineHeight=null, dymaptic.GeoBlazor.Core.Model.Dimension? lineWidth=null, System.Nullable<bool> rotated=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.VerticalAlignment> verticalAlignment=null, dymaptic.GeoBlazor.Core.Model.Dimension? xoffset=null, dymaptic.GeoBlazor.Core.Model.Dimension? yoffset=null);
Parameters
text System.String
The text string to display in the view.
ArcGIS Maps SDK for JavaScript
color MapColor
The color of the symbol.
default “black”
ArcGIS Maps SDK for JavaScript
haloColor MapColor
The color of the text symbol’s halo.
ArcGIS Maps SDK for JavaScript
haloSize Dimension
The size in points of the text symbol’s halo.
ArcGIS Maps SDK for JavaScript
font MapFont
The Font used to style the text.
ArcGIS Maps SDK for JavaScript
angle System.Nullable<System.Double>
The angle of the text.
default 0
ArcGIS Maps SDK for JavaScript
backgroundColor MapColor
The background color of the label’s bounding box.
ArcGIS Maps SDK for JavaScript
borderLineColor MapColor
The border color of the label’s bounding box.
ArcGIS Maps SDK for JavaScript
borderLineSize System.Nullable<System.Double>
The border size or width of the label’s bounding box.
ArcGIS Maps SDK for JavaScript
horizontalAlignment System.Nullable<HorizontalAlignment>
Adjusts the horizontal alignment of the text in multi-lines.
default “center”
ArcGIS Maps SDK for JavaScript
kerning System.Nullable<System.Boolean>
Determines whether to adjust the spacing between characters in the text string.
default true
ArcGIS Maps SDK for JavaScript
lineHeight System.Nullable<System.Double>
The height of the space between each line of text.
default 1.0
ArcGIS Maps SDK for JavaScript
lineWidth Dimension
The maximum length in points for each line of text.
default 192
ArcGIS Maps SDK for JavaScript
rotated System.Nullable<System.Boolean>
Determines whether every character in the text string is rotated.
default false
ArcGIS Maps SDK for JavaScript
verticalAlignment System.Nullable<VerticalAlignment>
Adjusts the vertical alignment of the text.
default “baseline”
ArcGIS Maps SDK for JavaScript
xoffset Dimension
The offset on the x-axis in points.
default 0
ArcGIS Maps SDK for JavaScript
yoffset Dimension
The offset on the y-axis in points.
default 0
ArcGIS Maps SDK for JavaScript
Properties
TextSymbol.Angle Property
The angle of the text. 0 is horizontal and the angle moves clockwise.
public System.Nullable<double> Angle { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This property is currently not supported in 3D SceneViews.
TextSymbol.BackgroundColor Property
The background color of the label’s bounding box.
public dymaptic.GeoBlazor.Core.Model.MapColor? BackgroundColor { get; set; }
Property Value
Remarks
This property is currently not supported when labelling a FeatureLayer polyline with a “curved” labelPosition.
TextSymbol.BorderLineColor Property
The border color of the label’s bounding box.
public dymaptic.GeoBlazor.Core.Model.MapColor? BorderLineColor { get; set; }
Property Value
Remarks
This property is currently not supported when labelling a FeatureLayer polyline with a “curved” labelPosition.
TextSymbol.BorderLineSize Property
The border size or width of the label’s bounding box.
public System.Nullable<double> BorderLineSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This property is currently not supported when labelling a FeatureLayer polyline with a “curved” labelPosition.
TextSymbol.Font Property
The Font used to style the text.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.MapFont? Font { get; set; }
Property Value
TextSymbol.HaloColor Property
The color of the text symbol’s halo.
public dymaptic.GeoBlazor.Core.Model.MapColor? HaloColor { get; set; }
Property Value
TextSymbol.HaloSize Property
The size in points of the text symbol’s halo.
public dymaptic.GeoBlazor.Core.Model.Dimension? HaloSize { get; set; }
Property Value
Remarks
Known Limitations
- Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers.
- Halo size should not be 1/4 larger than the text size. For example, if your text size is 12, the halo size should not be larger than 3.
TextSymbol.HorizontalAlignment Property
Adjusts the horizontal alignment of the text in multi-lines. Default value is Center.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.HorizontalAlignment> HorizontalAlignment { get; set; }
Property Value
System.Nullable<HorizontalAlignment>
Remarks
This property only applies when TextSymbol is not used for labeling purposes. The horizontalAlignment for labels is inferred from the labelPlacement value.
TextSymbol.Kerning Property
Determines whether to adjust the spacing between characters in the text string. Default value is true.
public System.Nullable<bool> Kerning { get; set; }
Property Value
System.Nullable<System.Boolean>
TextSymbol.LineHeight Property
The height of the space between each line of text. Only applies to multiline text.
This property can be considered as a multiplier of the default value of 1.0 (e.g. a value of 2.0 will be two times the height of the default height). The range of possible values is: 0.1 - 4.0. If a value of 0 is specified, the default value of 1.0 will be used.
Default Value: 1.0
public System.Nullable<double> LineHeight { get; set; }
Property Value
System.Nullable<System.Double>
TextSymbol.LineWidth Property
The maximum length in points for each line of text. This value is a string expressing size in points or pixels (e.g. “12px”, “12pt”), which defaults to points.
The default value is 192 points. The range of possible values is: 32px - 512px.
If text extends farther than the lineWidth value, then the line will break at the whitespace before the text that extends past the limit if possible, and a new line will be created.
public dymaptic.GeoBlazor.Core.Model.Dimension? LineWidth { get; set; }
Property Value
Remarks
Known Limitations:
- This property is currently not supported in 3D SceneViews.
- The default value is subject to change in future releases.
TextSymbol.Rotated Property
Determines whether every character in the text string is rotated. Default value is false.
public System.Nullable<bool> Rotated { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
This property is currently not supported in 3D SceneViews.
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 dymaptic.GeoBlazor.Core.Enums.SymbolType Type { get; }
Property Value
TextSymbol.VerticalAlignment Property
Adjusts the vertical alignment of the text. Default value is Baseline.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.VerticalAlignment> VerticalAlignment { get; set; }
Property Value
System.Nullable<VerticalAlignment>
Remarks
This property only applies when TextSymbol is not used for labeling purposes. The verticalAlignment for labels is inferred from the labelPlacement value.
TextSymbol.Xoffset Property
The offset on the x-axis in points. This value is a string expressing size in points or pixels (e.g. “12px”, “12pt”), which defaults to points.
public dymaptic.GeoBlazor.Core.Model.Dimension? Xoffset { get; set; }
Property Value
Remarks
This property is currently not supported in 3D SceneViews.
TextSymbol.Yoffset Property
The offset on the y-axis in points. This value is a string expressing size in points or pixels (e.g. “12px”, “12pt”), which defaults to points.
public dymaptic.GeoBlazor.Core.Model.Dimension? Yoffset { get; set; }
Property Value
Remarks
This property is currently not supported in 3D SceneViews.
Methods
TextSymbol.GetAngle() Method
Asynchronously retrieve the current value of the Angle property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetAngle();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
TextSymbol.GetBackgroundColor() Method
Asynchronously retrieve the current value of the BackgroundColor property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetBackgroundColor();
Returns
System.Threading.Tasks.Task<MapColor>
TextSymbol.GetBorderLineColor() Method
Asynchronously retrieve the current value of the BorderLineColor property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetBorderLineColor();
Returns
System.Threading.Tasks.Task<MapColor>
TextSymbol.GetBorderLineSize() Method
Asynchronously retrieve the current value of the BorderLineSize property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetBorderLineSize();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
TextSymbol.GetFont() Method
Asynchronously retrieve the current value of the Font property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.MapFont?> GetFont();
Returns
System.Threading.Tasks.Task<MapFont>
TextSymbol.GetHaloColor() Method
Asynchronously retrieve the current value of the HaloColor property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetHaloColor();
Returns
System.Threading.Tasks.Task<MapColor>
TextSymbol.GetHaloSize() Method
Asynchronously retrieve the current value of the HaloSize property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension?> GetHaloSize();
Returns
System.Threading.Tasks.Task<Dimension>
TextSymbol.GetHorizontalAlignment() Method
Asynchronously retrieve the current value of the HorizontalAlignment property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.HorizontalAlignment>> GetHorizontalAlignment();
Returns
System.Threading.Tasks.Task<System.Nullable<HorizontalAlignment>>
TextSymbol.GetKerning() Method
Asynchronously retrieve the current value of the Kerning property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetKerning();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
TextSymbol.GetLineHeight() Method
Asynchronously retrieve the current value of the LineHeight property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetLineHeight();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
TextSymbol.GetLineWidth() Method
Asynchronously retrieve the current value of the LineWidth property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension?> GetLineWidth();
Returns
System.Threading.Tasks.Task<Dimension>
TextSymbol.GetRotated() Method
Asynchronously retrieve the current value of the Rotated property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetRotated();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
TextSymbol.GetText() Method
Asynchronously retrieve the current value of the Text property.
public System.Threading.Tasks.Task<string?> GetText();
Returns
System.Threading.Tasks.Task<System.String>
TextSymbol.GetVerticalAlignment() Method
Asynchronously retrieve the current value of the VerticalAlignment property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.VerticalAlignment>> GetVerticalAlignment();
Returns
System.Threading.Tasks.Task<System.Nullable<VerticalAlignment>>
TextSymbol.GetXoffset() Method
Asynchronously retrieve the current value of the Xoffset property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension?> GetXoffset();
Returns
System.Threading.Tasks.Task<Dimension>
TextSymbol.GetYoffset() Method
Asynchronously retrieve the current value of the Yoffset property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension?> GetYoffset();
Returns
System.Threading.Tasks.Task<Dimension>
TextSymbol.SetAngle(Nullable) Method
Asynchronously set the value of the Angle property after render.
public System.Threading.Tasks.Task SetAngle(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
TextSymbol.SetBackgroundColor(MapColor) Method
Asynchronously set the value of the BackgroundColor property after render.
public System.Threading.Tasks.Task SetBackgroundColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);
Parameters
value MapColor
The value to set.
Returns
TextSymbol.SetBorderLineColor(MapColor) Method
Asynchronously set the value of the BorderLineColor property after render.
public System.Threading.Tasks.Task SetBorderLineColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);
Parameters
value MapColor
The value to set.
Returns
TextSymbol.SetBorderLineSize(Nullable) Method
Asynchronously set the value of the BorderLineSize property after render.
public System.Threading.Tasks.Task SetBorderLineSize(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
TextSymbol.SetFont(MapFont) Method
Asynchronously set the value of the Font property after render.
public System.Threading.Tasks.Task SetFont(dymaptic.GeoBlazor.Core.Components.MapFont? value);
Parameters
value MapFont
The value to set.
Returns
TextSymbol.SetHaloColor(MapColor) Method
Asynchronously set the value of the HaloColor property after render.
public System.Threading.Tasks.Task SetHaloColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);
Parameters
value MapColor
The value to set.
Returns
TextSymbol.SetHaloSize(Dimension) Method
Asynchronously set the value of the HaloSize property after render.
public System.Threading.Tasks.Task SetHaloSize(dymaptic.GeoBlazor.Core.Model.Dimension? value);
Parameters
value Dimension
The value to set.
Returns
TextSymbol.SetHorizontalAlignment(Nullable) Method
Asynchronously set the value of the HorizontalAlignment property after render.
public System.Threading.Tasks.Task SetHorizontalAlignment(System.Nullable<dymaptic.GeoBlazor.Core.Enums.HorizontalAlignment> value);
Parameters
value System.Nullable<HorizontalAlignment>
The value to set.
Returns
TextSymbol.SetKerning(Nullable) Method
Asynchronously set the value of the Kerning property after render.
public System.Threading.Tasks.Task SetKerning(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
TextSymbol.SetLineHeight(Nullable) Method
Asynchronously set the value of the LineHeight property after render.
public System.Threading.Tasks.Task SetLineHeight(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
TextSymbol.SetLineWidth(Dimension) Method
Asynchronously set the value of the LineWidth property after render.
public System.Threading.Tasks.Task SetLineWidth(dymaptic.GeoBlazor.Core.Model.Dimension? value);
Parameters
value Dimension
The value to set.
Returns
TextSymbol.SetRotated(Nullable) Method
Asynchronously set the value of the Rotated property after render.
public System.Threading.Tasks.Task SetRotated(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
TextSymbol.SetText(string) Method
Asynchronously set the value of the Text property after render.
public System.Threading.Tasks.Task SetText(string? value);
Parameters
value System.String
The value to set.
Returns
TextSymbol.SetVerticalAlignment(Nullable) Method
Asynchronously set the value of the VerticalAlignment property after render.
public System.Threading.Tasks.Task SetVerticalAlignment(System.Nullable<dymaptic.GeoBlazor.Core.Enums.VerticalAlignment> value);
Parameters
value System.Nullable<VerticalAlignment>
The value to set.
Returns
TextSymbol.SetXoffset(Dimension) Method
Asynchronously set the value of the Xoffset property after render.
public System.Threading.Tasks.Task SetXoffset(dymaptic.GeoBlazor.Core.Model.Dimension? value);
Parameters
value Dimension
The value to set.
Returns
TextSymbol.SetYoffset(Dimension) Method
Asynchronously set the value of the Yoffset property after render.
public System.Threading.Tasks.Task SetYoffset(dymaptic.GeoBlazor.Core.Model.Dimension? value);
Parameters
value Dimension
The value to set.
Returns
TextSymbol.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()