Skip to main content Link Menu Expand (external link) Document Search Copy Copied

dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Layers

Label Class

Defines label expressions, symbols, scale ranges, label priorities, and label placement options for labels on a
layer. See the Labeling guide for more information about labeling.

ArcGIS
  
JS API

</a>

public class Label : dymaptic.GeoBlazor.Core.Components.Layers.LayerObject,
System.IEquatable<dymaptic.GeoBlazor.Core.Components.Layers.Label>

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 LayerObject 🡒 Label

Implements System.IEquatable<Label>

Properties

Label.LabelExpression Property

Defines the labels for a MapImageLayer.

public string? LabelExpression { get; set; }

Property Value

System.String

Remarks

MapImageLayer not yet implemented in GeoBlazor

Label.LabelExpressionInfo Property

Defines the labels for a FeatureLayer.

public dymaptic.GeoBlazor.Core.Components.Layers.LabelExpressionInfo? LabelExpressionInfo { get; set; }

Property Value

LabelExpressionInfo

Label.LabelPlacement Property

The position of the label.

public string? LabelPlacement { get; set; }

Property Value

System.String

Methods

Label.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.

Label.GetHashCode() Method

Serves as the default hash function.

public override int GetHashCode();

Returns

System.Int32
A hash code for the current object.

Label.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

System.Threading.Tasks.Task

Exceptions

InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.

Label.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

System.Threading.Tasks.Task

Label.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

Label.operator ==(Label, Label) Operator

Compares two Labels for equality.

public static bool operator ==(dymaptic.GeoBlazor.Core.Components.Layers.Label? left, dymaptic.GeoBlazor.Core.Components.Layers.Label? right);

Parameters

left Label

right Label

Returns

System.Boolean

Label.operator !=(Label, Label) Operator

Compares two Labels for inequality.

public static bool operator !=(dymaptic.GeoBlazor.Core.Components.Layers.Label? left, dymaptic.GeoBlazor.Core.Components.Layers.Label? right);

Parameters

left Label

right Label

Returns

System.Boolean