dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Popups
FieldInfo Class
The FieldInfo class defines how a Field participates, or in some cases, does not participate, in a PopupTemplate.
ArcGIS
JS API
</a>
public class FieldInfo : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 FieldInfo
Constructors
FieldInfo() Constructor
Parameterless constructor for using as a razor component
public FieldInfo();
FieldInfo(string, string, string, string, FieldInfoFormat, Nullable, Nullable) Constructor
Constructor for creating a new FieldInfo in code with parameters
public FieldInfo(string? fieldName=null, string? label=null, string? tooltip=null, string? stringFieldOption=null, dymaptic.GeoBlazor.Core.Components.Popups.FieldInfoFormat? format=null, System.Nullable<bool> isEditable=null, System.Nullable<bool> visible=null);
Parameters
fieldName System.String
The field name as defined by the service or the name of an Arcade expression.
label System.String
The field name as defined by the service or the name of an Arcade expression.
tooltip System.String
A string providing an editing hint for editors of the field.
stringFieldOption System.String
A string determining what type of input box editors see when editing the field.
format FieldInfoFormat
Class which provides formatting options for numerical or date fields and how they should display within a popup.
isEditable System.Nullable<System.Boolean>
A Boolean determining whether users can edit this field.
visible System.Nullable<System.Boolean>
Indicates whether the field is visible in the popup window.
Properties
FieldInfo.FieldName Property
The field name as defined by the service or the name of an Arcade expression.
public string? FieldName { get; set; }
Property Value
FieldInfo.Format Property
Class which provides formatting options for numerical or date fields and how they should display within a popup.
public dymaptic.GeoBlazor.Core.Components.Popups.FieldInfoFormat? Format { get; set; }
Property Value
FieldInfo.IsEditable Property
A Boolean determining whether users can edit this field.
public System.Nullable<bool> IsEditable { get; set; }
Property Value
System.Nullable<System.Boolean>
FieldInfo.Label Property
The field name as defined by the service or the name of an Arcade expression.
public string? Label { get; set; }
Property Value
FieldInfo.StringFieldOption Property
A string determining what type of input box editors see when editing the field.
public string? StringFieldOption { get; set; }
Property Value
FieldInfo.Tooltip Property
A string providing an editing hint for editors of the field.
public string? Tooltip { get; set; }
Property Value
FieldInfo.Visible Property
Indicates whether the field is visible in the popup window.
public System.Nullable<bool> Visible { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
FieldInfo.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.
FieldInfo.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
FieldInfo.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