dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

MultipartColorRamp Class

Creates a multipart color ramp to combine multiple continuous color ramps for use in raster
renderers.
ArcGIS Maps SDK for JavaScript

public class MultipartColorRamp : dymaptic.GeoBlazor.Core.Components.ColorRamp,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 ColorRamp 🡒 MultipartColorRamp

Implements IMapComponent

Constructors

MultipartColorRamp() Constructor

Parameterless constructor for use as a Razor Component.

public MultipartColorRamp();

MultipartColorRamp(IReadOnlyList) Constructor

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

public MultipartColorRamp(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AlgorithmicColorRamp>? colorRamps=null);

Parameters

colorRamps System.Collections.Generic.IReadOnlyList<AlgorithmicColorRamp>

Define an array of algorithmic color ramps used to generate the multi part ramp.
ArcGIS Maps SDK for JavaScript

Properties

MultipartColorRamp.ColorRamps Property

Define an array of algorithmic color ramps used to generate the multi part ramp.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Collections.Generic.IReadOnlyList<AlgorithmicColorRamp>

MultipartColorRamp.Type Property

A string value representing the color ramp type. Possible Values:”algorithmic” “multipart”
public override dymaptic.GeoBlazor.Core.Enums.ColorRampType Type { get; }

Property Value

ColorRampType

Methods

MultipartColorRamp.AddToColorRamps(AlgorithmicColorRamp[]) Method

Asynchronously adds elements to the ColorRamps property.

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

Parameters

values AlgorithmicColorRamp[]

The elements to add.

Returns

System.Threading.Tasks.Task

MultipartColorRamp.GetColorRamps() Method

Asynchronously retrieve the current value of the ColorRamps property.

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

Returns

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

MultipartColorRamp.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.

public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

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.

MultipartColorRamp.RemoveFromColorRamps(AlgorithmicColorRamp[]) Method

Asynchronously remove an element from the ColorRamps property.

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

Parameters

values AlgorithmicColorRamp[]

The elements to remove.

Returns

System.Threading.Tasks.Task

MultipartColorRamp.SetColorRamps(IReadOnlyList) Method

Asynchronously set the value of the ColorRamps property after render.

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

Parameters

value System.Collections.Generic.IReadOnlyList<AlgorithmicColorRamp>

The value to set.

Returns

System.Threading.Tasks.Task

MultipartColorRamp.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

System.Threading.Tasks.Task

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.

MultipartColorRamp.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()