dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

HeatmapRampElement Class

Describes the schema of the HeatmapRampElement used as a legendElement.
ArcGIS Maps SDK for JavaScript

public class HeatmapRampElement : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.ILegendElement,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.ISymbolTableElementType

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 HeatmapRampElement

Implements ILegendElement, IMapComponent, ISymbolTableElementType

Constructors

HeatmapRampElement() Constructor

Parameterless constructor for use as a Razor Component.

public HeatmapRampElement();

HeatmapRampElement(IReadOnlyList, RendererTitle, string) Constructor

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

public HeatmapRampElement(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.HeatmapRampStop>? infos=null, dymaptic.GeoBlazor.Core.Model.RendererTitle? rendererTitle=null, string? stringTitle=null);

Parameters

infos System.Collections.Generic.IReadOnlyList<HeatmapRampStop>

The individual color stops rendered in the legend that correspond to the heatmap colorStops in the renderer.
ArcGIS Maps SDK for JavaScript

rendererTitle RendererTitle

The title of the heatmap ramp as displayed in the legend.
ArcGIS Maps SDK for JavaScript

stringTitle System.String

The title of the heatmap ramp as displayed in the legend.
ArcGIS Maps SDK for JavaScript

Properties

HeatmapRampElement.Infos Property

The individual color stops rendered in the legend that correspond to the heatmap colorStops in the renderer.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.HeatmapRampStop>? Infos { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<HeatmapRampStop>

HeatmapRampElement.RendererTitle Property

The title of the heatmap ramp as displayed in the legend.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Model.RendererTitle? RendererTitle { get; set; }

Property Value

RendererTitle

HeatmapRampElement.StringTitle Property

The title of the heatmap ramp as displayed in the legend.
ArcGIS Maps SDK for JavaScript

public string? StringTitle { get; set; }

Property Value

System.String

Methods

HeatmapRampElement.AddToInfos(HeatmapRampStop[]) Method

Asynchronously adds elements to the Infos property.

public System.Threading.Tasks.Task AddToInfos(params dymaptic.GeoBlazor.Core.Components.HeatmapRampStop[] values);

Parameters

values HeatmapRampStop[]

The elements to add.

Returns

System.Threading.Tasks.Task

HeatmapRampElement.GetInfos() Method

Asynchronously retrieve the current value of the Infos property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.HeatmapRampStop>?> GetInfos();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<HeatmapRampStop>>

HeatmapRampElement.GetRendererTitle() Method

Asynchronously retrieve the current value of the RendererTitle property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.RendererTitle?> GetRendererTitle();

Returns

System.Threading.Tasks.Task<RendererTitle>

HeatmapRampElement.GetStringTitle() Method

Asynchronously retrieve the current value of the StringTitle property.

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

Returns

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

HeatmapRampElement.RemoveFromInfos(HeatmapRampStop[]) Method

Asynchronously remove an element from the Infos property.

public System.Threading.Tasks.Task RemoveFromInfos(params dymaptic.GeoBlazor.Core.Components.HeatmapRampStop[] values);

Parameters

values HeatmapRampStop[]

The elements to remove.

Returns

System.Threading.Tasks.Task

HeatmapRampElement.SetInfos(IReadOnlyList) Method

Asynchronously set the value of the Infos property after render.

public System.Threading.Tasks.Task SetInfos(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.HeatmapRampStop>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<HeatmapRampStop>

The value to set.

Returns

System.Threading.Tasks.Task

HeatmapRampElement.SetRendererTitle(RendererTitle) Method

Asynchronously set the value of the RendererTitle property after render.

public System.Threading.Tasks.Task SetRendererTitle(dymaptic.GeoBlazor.Core.Model.RendererTitle? value);

Parameters

value RendererTitle

The value to set.

Returns

System.Threading.Tasks.Task

HeatmapRampElement.SetStringTitle(string) Method

Asynchronously set the value of the StringTitle property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

HeatmapRampElement.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()