layout: default title: Field parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
Field Class
Information about each field in a layer. Field objects must be constructed when creating a FeatureLayer from
client-side graphics. This class allows you to define the schema of each field in the FeatureLayer.
ArcGIS Maps SDK for JavaScript
public class Field : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Field
Constructors
Field() Constructor
Parameterless constructor for use as a razor component
public Field();
Field(FieldType, string, string, string, Nullable, Nullable, Nullable, object, Nullable) Constructor
Creates a new Field in code with parameters
public Field(dymaptic.GeoBlazor.Core.Components.Layers.FieldType type, string? name=null, string? alias=null, string? description=null, System.Nullable<int> length=null, System.Nullable<bool> editable=null, System.Nullable<bool> nullable=null, object? defaultValue=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.FieldValueType> valueType=null);
Parameters
type
FieldType
The data type of the field.
name
System.String
The name of the field.
alias
System.String
The display name for the field.
description
System.String
Contains information describing the purpose of each field.
length
System.Nullable<System.Int32>
The field length.
editable
System.Nullable<System.Boolean>
Indicates whether the field is editable.
nullable
System.Nullable<System.Boolean>
Indicates if the field can accept null values.
defaultValue
System.Object
The default value set for the field.
valueType
System.Nullable<FieldValueType>
The types of values that can be assigned to a field.
Properties
Field.Alias Property
The display name for the field.
public string? Alias { get; set; }
Property Value
Field.DefaultValue Property
The default value set for the field.
public object? DefaultValue { get; set; }
Property Value
Field.Description Property
Contains information describing the purpose of each field.
public string? Description { get; set; }
Property Value
Field.Domain Property
The domain associated with the field. Domains are used to constrain the values allowed in a field. There are two types of domains: RangeDomain and CodedValueDomain.
public dymaptic.GeoBlazor.Core.Components.Widgets.Domain? Domain { get; set; }
Property Value
Field.Editable Property
Indicates whether the field is editable.
public System.Nullable<bool> Editable { get; set; }
Property Value
System.Nullable<System.Boolean>
Field.Length Property
The field length.
public System.Nullable<int> Length { get; set; }
Property Value
Field.Name Property
The name of the field.
public string? Name { get; set; }
Property Value
Field.Nullable Property
Indicates if the field can accept null values.
public System.Nullable<bool> Nullable { get; set; }
Property Value
System.Nullable<System.Boolean>
Field.Type Property
The data type of the field.
public dymaptic.GeoBlazor.Core.Components.Layers.FieldType Type { get; set; }
Property Value
Field.ValueType Property
The types of values that can be assigned to a field.
public System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.FieldValueType> ValueType { get; set; }
Property Value
System.Nullable<FieldValueType>
Methods
Field.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.
Field.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.