dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

FeatureEffect Class

FeatureEffect allows you to emphasize or deemphasize features that
satisfy a filter in 2D MapView.
ArcGIS Maps SDK for JavaScript

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

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

Constructors

FeatureEffect() Constructor

Parameterless constructor for use as a Razor Component.

public FeatureEffect();

FeatureEffect(IReadOnlyList, Nullable, FeatureFilter, IReadOnlyList) Constructor

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

public FeatureEffect(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>? excludedEffect=null, System.Nullable<bool> excludedLabelsVisible=null, dymaptic.GeoBlazor.Core.Components.FeatureFilter? filter=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>? includedEffect=null);

Parameters

excludedEffect System.Collections.Generic.IReadOnlyList<Effect>

The effect applied to features that do not meet
the filter requirements.
ArcGIS Maps SDK for JavaScript

excludedLabelsVisible System.Nullable<System.Boolean>

Indicates if labels are visible for features that are excluded from the filter.
default false
ArcGIS Maps SDK for JavaScript

filter FeatureFilter

The filter that drives the effect.
ArcGIS Maps SDK for JavaScript

includedEffect System.Collections.Generic.IReadOnlyList<Effect>

The effect applied to features that meet the filter requirements.
ArcGIS Maps SDK for JavaScript

Properties

FeatureEffect.ExcludedEffect Property

The effect applied to features that do not meet the filter requirements.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>? ExcludedEffect { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Effect>

FeatureEffect.ExcludedLabelsVisible Property

Indicates if labels are visible for features that are excluded from the filter.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

FeatureEffect.Filter Property

The filter that drives the effect.
ArcGIS Maps SDK for JavaScript

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

Property Value

FeatureFilter

FeatureEffect.IncludedEffect Property

The effect applied to features that meet the filter requirements.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>? IncludedEffect { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Effect>

Methods

FeatureEffect.AddToExcludedEffect(Effect[]) Method

Asynchronously adds elements to the ExcludedEffect property.

public System.Threading.Tasks.Task AddToExcludedEffect(params dymaptic.GeoBlazor.Core.Model.Effect[] values);

Parameters

values Effect[]

The elements to add.

Returns

System.Threading.Tasks.Task

FeatureEffect.AddToIncludedEffect(Effect[]) Method

Asynchronously adds elements to the IncludedEffect property.

public System.Threading.Tasks.Task AddToIncludedEffect(params dymaptic.GeoBlazor.Core.Model.Effect[] values);

Parameters

values Effect[]

The elements to add.

Returns

System.Threading.Tasks.Task

FeatureEffect.GetExcludedEffect() Method

Asynchronously retrieve the current value of the ExcludedEffect property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>?> GetExcludedEffect();

Returns

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

FeatureEffect.GetExcludedLabelsVisible() Method

Asynchronously retrieve the current value of the ExcludedLabelsVisible property.

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

Returns

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

FeatureEffect.GetFilter() Method

Asynchronously retrieve the current value of the Filter property.

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

Returns

System.Threading.Tasks.Task<FeatureFilter>

FeatureEffect.GetIncludedEffect() Method

Asynchronously retrieve the current value of the IncludedEffect property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>?> GetIncludedEffect();

Returns

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

FeatureEffect.RemoveFromExcludedEffect(Effect[]) Method

Asynchronously remove an element from the ExcludedEffect property.

public System.Threading.Tasks.Task RemoveFromExcludedEffect(params dymaptic.GeoBlazor.Core.Model.Effect[] values);

Parameters

values Effect[]

The elements to remove.

Returns

System.Threading.Tasks.Task

FeatureEffect.RemoveFromIncludedEffect(Effect[]) Method

Asynchronously remove an element from the IncludedEffect property.

public System.Threading.Tasks.Task RemoveFromIncludedEffect(params dymaptic.GeoBlazor.Core.Model.Effect[] values);

Parameters

values Effect[]

The elements to remove.

Returns

System.Threading.Tasks.Task

FeatureEffect.SetExcludedEffect(IReadOnlyList) Method

Asynchronously set the value of the ExcludedEffect property after render.

public System.Threading.Tasks.Task SetExcludedEffect(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Effect>

The value to set.

Returns

System.Threading.Tasks.Task

FeatureEffect.SetExcludedLabelsVisible(Nullable) Method

Asynchronously set the value of the ExcludedLabelsVisible property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

FeatureEffect.SetFilter(FeatureFilter) Method

Asynchronously set the value of the Filter property after render.

public System.Threading.Tasks.Task SetFilter(dymaptic.GeoBlazor.Core.Components.FeatureFilter? value);

Parameters

value FeatureFilter

The value to set.

Returns

System.Threading.Tasks.Task

FeatureEffect.SetIncludedEffect(IReadOnlyList) Method

Asynchronously set the value of the IncludedEffect property after render.

public System.Threading.Tasks.Task SetIncludedEffect(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.Effect>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Effect>

The value to set.

Returns

System.Threading.Tasks.Task

FeatureEffect.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()