GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components

FieldColumnTemplate Class

A FieldColumnTemplate formats and defines the structure of a FieldColumn within a FeatureTable widget. ArcGIS Maps SDK for JavaScript

public class FieldColumnTemplate : dymaptic.GeoBlazor.Pro.Components.ColumnTemplateBase

Inheritance System.Object πŸ‘’ Microsoft.AspNetCore.Components.ComponentBase πŸ‘’ MapComponent πŸ‘’ ColumnTemplateBase πŸ‘’ FieldColumnTemplate

Constructors

FieldColumnTemplate() Constructor

Parameterless constructor for use as a Razor Component.

public FieldColumnTemplate();

FieldColumnTemplate(Nullable, string, Nullable, Domain, Nullable, string, Nullable, FormatFunction, string, string, Nullable, Nullable, string, string, ColumnTableMenuConfig, Nullable, Nullable, Nullable, Nullable, Nullable, string, Nullable, string) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public FieldColumnTemplate(System.Nullable<bool> autoWidth=null, string? description=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection> direction=null, dymaptic.GeoBlazor.Core.Components.Domain? domain=null, System.Nullable<bool> editable=null, string? fieldName=null, System.Nullable<double> flexGrow=null, dymaptic.GeoBlazor.Core.Functions.FormatFunction? formatFunction=null, string? icon=null, string? iconText=null, System.Nullable<double> initialSortPriority=null, System.Nullable<bool> invalid=null, string? label=null, string? labelTooltipText=null, dymaptic.GeoBlazor.Pro.Components.ColumnTableMenuConfig? menuConfig=null, System.Nullable<bool> required=null, System.Nullable<bool> resizable=null, System.Nullable<bool> sortable=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.TextAlign> textAlign=null, System.Nullable<bool> textWrap=null, string? timeZone=null, System.Nullable<bool> visible=null, string? width=null);

Parameters

autoWidth System.Nullable<System.Boolean>

Indicates if the column width will automatically adjust to account for large content. default false ArcGIS Maps SDK for JavaScript

description System.String

A string description of the column to give context to what it represents. ArcGIS Maps SDK for JavaScript

direction System.Nullable<SortDirection>

Controls the sort order of the column. ArcGIS Maps SDK for JavaScript

domain Domain

The coded value domain or a range domain of the associated field. ArcGIS Maps SDK for JavaScript

editable System.Nullable<System.Boolean>

Indicates whether the field is editable. ArcGIS Maps SDK for JavaScript

fieldName System.String

The unique field name as defined by the data source. ArcGIS Maps SDK for JavaScript

flexGrow System.Nullable<System.Double>

Controls the flex-grow property for the column. default 1 ArcGIS Maps SDK for JavaScript

formatFunction FormatFunction

Custom function for rendering cell content. ArcGIS Maps SDK for JavaScript

icon System.String

The string value indicating the icon displayed in the header cell of the column. ArcGIS Maps SDK for JavaScript

iconText System.String

The string value displayed when hovering over the associated icon displayed in the header cell of the column. ArcGIS Maps SDK for JavaScript

initialSortPriority System.Nullable<System.Double>

Use this in combination with FeatureTable.multiSortEnabled and FeatureTable.direction properties to set sorting functionality on multiple columns. default null ArcGIS Maps SDK for JavaScript

invalid System.Nullable<System.Boolean>

Indicates whether the column is in an invalid state. default false ArcGIS Maps SDK for JavaScript

label System.String

The default label displayed in the column header cell. ArcGIS Maps SDK for JavaScript

labelTooltipText System.String

Text displayed when hovering over the column header label. ArcGIS Maps SDK for JavaScript

menuConfig ColumnTableMenuConfig

Configuration options for the column menu. ArcGIS Maps SDK for JavaScript

required System.Nullable<System.Boolean>

Indicates whether a field requires a value. default false ArcGIS Maps SDK for JavaScript

resizable System.Nullable<System.Boolean>

Indicates whether the column is resizable. default true ArcGIS Maps SDK for JavaScript

sortable System.Nullable<System.Boolean>

Indicates whether the column can be sorted. default false ArcGIS Maps SDK for JavaScript

textAlign System.Nullable<TextAlign>

Aligns the columns cell content horizontally. default β€œstart” ArcGIS Maps SDK for JavaScript

textWrap System.Nullable<System.Boolean>

Indicates cell content should be wrapped and displayed on multiple lines within the cell. default false ArcGIS Maps SDK for JavaScript

timeZone System.String

The time zone of the specific column. ArcGIS Maps SDK for JavaScript

visible System.Nullable<System.Boolean>

Indicates whether the column is visible. default true ArcGIS Maps SDK for JavaScript

width System.String

Default width of the column in pixels. default 200 ArcGIS Maps SDK for JavaScript

Properties

FieldColumnTemplate.Domain Property

The coded value domain or a range domain of the associated field. ArcGIS Maps SDK for JavaScript

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

Property Value

Domain

FieldColumnTemplate.Editable Property

Indicates whether the field is editable. ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> Editable { get; set; }

Property Value

System.Nullable<System.Boolean>

FieldColumnTemplate.Required Property

Indicates whether a field requires a value. default false ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> Required { get; set; }

Property Value

System.Nullable<System.Boolean>

FieldColumnTemplate.Type Property

The type of column template.

public override dymaptic.GeoBlazor.Pro.Enums.ColumnTemplateBaseType Type { get; }

Property Value

ColumnTemplateBaseType

Methods

FieldColumnTemplate.GetDomain() Method

Asynchronously retrieve the current value of the Domain property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Domain?> GetDomain();

Returns

System.Threading.Tasks.Task<Domain>

FieldColumnTemplate.GetEditable() Method

Asynchronously retrieve the current value of the Editable property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetEditable();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

FieldColumnTemplate.GetRequired() Method

Asynchronously retrieve the current value of the Required property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetRequired();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

FieldColumnTemplate.SetDomain(Domain) Method

Asynchronously set the value of the Domain property after render.

public System.Threading.Tasks.Task SetDomain(dymaptic.GeoBlazor.Core.Components.Domain? value);

Parameters

value Domain

The value to set.

Returns

System.Threading.Tasks.Task

FieldColumnTemplate.SetEditable(Nullable) Method

Asynchronously set the value of the Editable property after render.

public System.Threading.Tasks.Task SetEditable(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

FieldColumnTemplate.SetRequired(Nullable) Method

Asynchronously set the value of the Required property after render.

public System.Threading.Tasks.Task SetRequired(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

FieldColumnTemplate.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()