GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components

ColumnTemplateBase Class

The base class for all column templates used by the tableTemplate within the FeatureTable widget.
ArcGIS Maps SDK for JavaScript

public class ColumnTemplateBase : dymaptic.GeoBlazor.Core.Components.MapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 ColumnTemplateBase

Constructors

ColumnTemplateBase() Constructor

Parameterless constructor for use as a Razor Component.

public ColumnTemplateBase();

ColumnTemplateBase(Nullable, string, Nullable, string, Nullable, FormatFunction, string, string, Nullable, Nullable, string, ColumnTableMenuConfig, 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 ColumnTemplateBase(System.Nullable<bool> autoWidth=null, string? description=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection> direction=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, dymaptic.GeoBlazor.Pro.Components.ColumnTableMenuConfig? menuConfig=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<dymaptic.GeoBlazor.Core.Enums.SortDirection>

Controls the sort order of the column.
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 dymaptic.GeoBlazor.Core.Functions.FormatFunction

Custom function for rendering cell content that is called when the column is rendered in the table.
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

menuConfig ColumnTableMenuConfig

Configuration options for the column menu.
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<dymaptic.GeoBlazor.Core.Enums.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

ColumnTemplateBase.AutoWidth Property

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

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

Property Value

System.Nullable<System.Boolean>

ColumnTemplateBase.Description Property

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

public string? Description { get; set; }

Property Value

System.String

ColumnTemplateBase.Direction Property

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

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection> Direction { get; set; }

Property Value

System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection>

ColumnTemplateBase.FieldName Property

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

public string? FieldName { get; set; }

Property Value

System.String

ColumnTemplateBase.FlexGrow Property

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

public System.Nullable<double> FlexGrow { get; set; }

Property Value

System.Nullable<System.Double>

ColumnTemplateBase.FormatFunction Property

Custom function for rendering cell content that is called when the column is rendered in the table.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Functions.FormatFunction? FormatFunction { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Functions.FormatFunction

ColumnTemplateBase.Frozen Property

Indicates if the the column is frozen in place at the beginning of the table.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ColumnTemplateBase.FrozenToEnd Property

Indicates if the column is frozen in place at the end of the table.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

ColumnTemplateBase.HasFormatFunction Property

A convenience property that signifies whether a custom FormatFunction function was registered.

public bool HasFormatFunction { get; }

Property Value

System.Boolean

ColumnTemplateBase.Icon Property

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

public string? Icon { get; set; }

Property Value

System.String

ColumnTemplateBase.IconText Property

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

public string? IconText { get; set; }

Property Value

System.String

ColumnTemplateBase.InitialSortPriority Property

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

public System.Nullable<double> InitialSortPriority { get; set; }

Property Value

System.Nullable<System.Double>

ColumnTemplateBase.Invalid Property

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

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

Property Value

System.Nullable<System.Boolean>

ColumnTemplateBase.Label Property

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

public string? Label { get; set; }

Property Value

System.String

ColumnTemplateBase.MenuConfig Property

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

public dymaptic.GeoBlazor.Pro.Components.ColumnTableMenuConfig? MenuConfig { get; set; }

Property Value

ColumnTableMenuConfig

ColumnTemplateBase.Resizable Property

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

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

Property Value

System.Nullable<System.Boolean>

ColumnTemplateBase.Sortable Property

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

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

Property Value

System.Nullable<System.Boolean>

ColumnTemplateBase.TextAlign Property

Aligns the columns cell content horizontally.
default “start”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.TextAlign> TextAlign { get; set; }

Property Value

System.Nullable<dymaptic.GeoBlazor.Core.Enums.TextAlign>

ColumnTemplateBase.TextWrap Property

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

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

Property Value

System.Nullable<System.Boolean>

ColumnTemplateBase.TimeZone Property

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

public string? TimeZone { get; set; }

Property Value

System.String

ColumnTemplateBase.Width Property

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

public string? Width { get; set; }

Property Value

System.String

Methods

ColumnTemplateBase.GetAutoWidth() Method

Asynchronously retrieve the current value of the AutoWidth property.

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

Returns

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

ColumnTemplateBase.GetDescription() Method

Asynchronously retrieve the current value of the Description property.

public System.Threading.Tasks.Task<string?> GetDescription();

Returns

System.Threading.Tasks.Task<System.String>

ColumnTemplateBase.GetDirection() Method

Asynchronously retrieve the current value of the Direction property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection>> GetDirection();

Returns

System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection>>

ColumnTemplateBase.GetFieldName() Method

Asynchronously retrieve the current value of the FieldName property.

public System.Threading.Tasks.Task<string?> GetFieldName();

Returns

System.Threading.Tasks.Task<System.String>

ColumnTemplateBase.GetFlexGrow() Method

Asynchronously retrieve the current value of the FlexGrow property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetFlexGrow();

Returns

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

ColumnTemplateBase.GetFrozen() Method

Asynchronously retrieve the current value of the Frozen property.

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

Returns

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

ColumnTemplateBase.GetFrozenToEnd() Method

Asynchronously retrieve the current value of the FrozenToEnd property.

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

Returns

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

ColumnTemplateBase.GetIcon() Method

Asynchronously retrieve the current value of the Icon property.

public System.Threading.Tasks.Task<string?> GetIcon();

Returns

System.Threading.Tasks.Task<System.String>

ColumnTemplateBase.GetIconText() Method

Asynchronously retrieve the current value of the IconText property.

public System.Threading.Tasks.Task<string?> GetIconText();

Returns

System.Threading.Tasks.Task<System.String>

ColumnTemplateBase.GetInitialSortPriority() Method

Asynchronously retrieve the current value of the InitialSortPriority property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetInitialSortPriority();

Returns

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

ColumnTemplateBase.GetInvalid() Method

Asynchronously retrieve the current value of the Invalid property.

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

Returns

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

ColumnTemplateBase.GetLabel() Method

Asynchronously retrieve the current value of the Label property.

public System.Threading.Tasks.Task<string?> GetLabel();

Returns

System.Threading.Tasks.Task<System.String>

ColumnTemplateBase.GetMenuConfig() Method

Asynchronously retrieve the current value of the MenuConfig property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.ColumnTableMenuConfig?> GetMenuConfig();

Returns

System.Threading.Tasks.Task<ColumnTableMenuConfig>

ColumnTemplateBase.GetResizable() Method

Asynchronously retrieve the current value of the Resizable property.

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

Returns

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

ColumnTemplateBase.GetSortable() Method

Asynchronously retrieve the current value of the Sortable property.

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

Returns

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

ColumnTemplateBase.GetTextAlign() Method

Asynchronously retrieve the current value of the TextAlign property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.TextAlign>> GetTextAlign();

Returns

System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.TextAlign>>

ColumnTemplateBase.GetTextWrap() Method

Asynchronously retrieve the current value of the TextWrap property.

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

Returns

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

ColumnTemplateBase.GetTimeZone() Method

Asynchronously retrieve the current value of the TimeZone property.

public System.Threading.Tasks.Task<string?> GetTimeZone();

Returns

System.Threading.Tasks.Task<System.String>

ColumnTemplateBase.GetWidth() Method

Asynchronously retrieve the current value of the Width property.

public System.Threading.Tasks.Task<string?> GetWidth();

Returns

System.Threading.Tasks.Task<System.String>

ColumnTemplateBase.SetAutoWidth(Nullable) Method

Asynchronously set the value of the AutoWidth property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetDescription(string) Method

Asynchronously set the value of the Description property after render.

public System.Threading.Tasks.Task SetDescription(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetDirection(Nullable) Method

Asynchronously set the value of the Direction property after render.

public System.Threading.Tasks.Task SetDirection(System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection> value);

Parameters

value System.Nullable<dymaptic.GeoBlazor.Core.Enums.SortDirection>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetFieldName(string) Method

Asynchronously set the value of the FieldName property after render.

public System.Threading.Tasks.Task SetFieldName(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetFlexGrow(Nullable) Method

Asynchronously set the value of the FlexGrow property after render.

public System.Threading.Tasks.Task SetFlexGrow(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetIcon(string) Method

Asynchronously set the value of the Icon property after render.

public System.Threading.Tasks.Task SetIcon(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetIconText(string) Method

Asynchronously set the value of the IconText property after render.

public System.Threading.Tasks.Task SetIconText(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetInitialSortPriority(Nullable) Method

Asynchronously set the value of the InitialSortPriority property after render.

public System.Threading.Tasks.Task SetInitialSortPriority(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetInvalid(Nullable) Method

Asynchronously set the value of the Invalid property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetLabel(string) Method

Asynchronously set the value of the Label property after render.

public System.Threading.Tasks.Task SetLabel(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetMenuConfig(ColumnTableMenuConfig) Method

Asynchronously set the value of the MenuConfig property after render.

public System.Threading.Tasks.Task SetMenuConfig(dymaptic.GeoBlazor.Pro.Components.ColumnTableMenuConfig? value);

Parameters

value ColumnTableMenuConfig

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetResizable(Nullable) Method

Asynchronously set the value of the Resizable property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetSortable(Nullable) Method

Asynchronously set the value of the Sortable property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetTextAlign(Nullable) Method

Asynchronously set the value of the TextAlign property after render.

public System.Threading.Tasks.Task SetTextAlign(System.Nullable<dymaptic.GeoBlazor.Core.Enums.TextAlign> value);

Parameters

value System.Nullable<dymaptic.GeoBlazor.Core.Enums.TextAlign>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetTextWrap(Nullable) Method

Asynchronously set the value of the TextWrap property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetTimeZone(string) Method

Asynchronously set the value of the TimeZone property after render.

public System.Threading.Tasks.Task SetTimeZone(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.SetWidth(string) Method

Asynchronously set the value of the Width property after render.

public System.Threading.Tasks.Task SetWidth(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

ColumnTemplateBase.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()