MapComponent

dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

MapComponent Class

The abstract base Razor Component class that all GeoBlazor components derive from.

public abstract class MapComponent : Microsoft.AspNetCore.Components.ComponentBase, System.IAsyncDisposable, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent

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

Implements System.IAsyncDisposable, IMapComponent

Fields

MapComponent.AllowRender Field

Whether to allow the component to render on the next cycle.

public bool AllowRender;

Field Value

System.Boolean

Properties

MapComponent.ChildContent Property

ChildContent defines the ability to add other components within this component in the razor syntax.

public Microsoft.AspNetCore.Components.RenderFragment? ChildContent { get; set; }

Property Value

Microsoft.AspNetCore.Components.RenderFragment

MapComponent.CoreJsModule Property

The reference to the entry point arcGisJsInterop.js from .NET

public Microsoft.JSInterop.IJSObjectReference? CoreJsModule { get; set; }

Implements CoreJsModule

Property Value

Microsoft.JSInterop.IJSObjectReference

MapComponent.DotNetComponentReference Property

The reference to the .NET object that represents the component.

public Microsoft.JSInterop.DotNetObjectReference<dymaptic.GeoBlazor.Core.Components.MapComponent> DotNetComponentReference { get; }

Property Value

Microsoft.JSInterop.DotNetObjectReference<MapComponent >

MapComponent.Id Property

A unique identifier, used to track components across .NET and JavaScript.

public System.Guid Id { get; set; }

Implements Id

Property Value

System.Guid

MapComponent.IsDisposed Property

Whether the component has been disposed.

public bool IsDisposed { get; }

Property Value

System.Boolean

MapComponent.JsModule Property

The reference to arcGisJsInterop.ts from .NET

public Microsoft.JSInterop.IJSObjectReference? JsModule { get; }

Property Value

Microsoft.JSInterop.IJSObjectReference

MapComponent.JsModuleManager Property

Manages references to JavaScript modules.

public dymaptic.GeoBlazor.Core.JsModuleManager? JsModuleManager { get; set; }

Property Value

JsModuleManager

MapComponent.JsRuntime Property

Represents an instance of a JavaScript runtime to which calls may be dispatched.

public Microsoft.JSInterop.IJSRuntime? JsRuntime { get; set; }

Property Value

Microsoft.JSInterop.IJSRuntime

MapComponent.Layer Property

The relevant Layer for the MapComponent. Not always applicable to every component type.

public virtual dymaptic.GeoBlazor.Core.Components.Layers.Layer? Layer { get; set; }

Implements Layer

Property Value

Layer

MapComponent.LayerId Property

The Id of the relevant Layer for the MapComponent. Not always applicable to every component type.

public System.Nullable<System.Guid> LayerId { get; set; }

Property Value

System.Nullable<System.Guid >

MapComponent.MapRendered Property

A boolean flag that indicates that the current MapView has finished rendering. To listen for a map rendering event, use OnViewRendered.

public bool MapRendered { get; set; }

Property Value

System.Boolean

MapComponent.Parent Property

The parent MapComponent of this component.

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

Implements Parent

Property Value

MapComponent

MapComponent.ProJsModule Property

Optional JsModule for GeoBlazor Pro

public Microsoft.JSInterop.IJSObjectReference? ProJsModule { get; }

Property Value

Microsoft.JSInterop.IJSObjectReference

MapComponent.View Property

The parent MapView of the current component.

public dymaptic.GeoBlazor.Core.Components.Views.MapView? View { get; set; }

Implements View

Property Value

MapView

MapComponent.ViewId Property

The ID of the parent MapView of the current component.

public System.Nullable<System.Guid> ViewId { get; set; }

Property Value

System.Nullable<System.Guid >

MapComponent.Visible Property

Indicates the visibility of the component. Default value: true.

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

Property Value

System.Nullable<System.Boolean >

Methods

MapComponent.AddReactiveListener(string, Action, bool) Method

Tracks any properties accessed in the

listenExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveListener<T>(string eventName, System.Action<T> handler, bool once);

Type parameters

T

The type of return value to expect in the handler.

Parameters

eventName System.String

The name of the event to add a listener for.

handler System.Action<T >

The function to call when the event triggers.

once System.Boolean

Whether to fire the callback only once. Defaults to false.

Returns

System.Threading.Tasks.Task

MapComponent.AddReactiveListener(string, Action) Method

Tracks any properties accessed in the

listenExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveListener<T>(string eventName, System.Action<T> handler);

Type parameters

T

The type of return value to expect in the handler.

Parameters

eventName System.String

The name of the event to add a listener for.

handler System.Action<T >

The action to call when the event triggers.

Returns

System.Threading.Tasks.Task

MapComponent.AddReactiveListener(string, Func<T,Task>, bool) Method

Tracks any properties accessed in the

listenExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveListener<T>(string eventName, System.Func<T,System.Threading.Tasks.Task> handler, bool once);

Type parameters

T

The type of return value to expect in the handler.

Parameters

eventName System.String

The name of the event to add a listener for.

handler System.Func<T ,System.Threading.Tasks.Task >

The function to call when the event triggers.

once System.Boolean

Whether to fire the callback only once. Defaults to false.

Returns

System.Threading.Tasks.Task

MapComponent.AddReactiveListener(string, Func<T,Task>) Method

Tracks any properties accessed in the

listenExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveListener<T>(string eventName, System.Func<T,System.Threading.Tasks.Task> handler);

Type parameters

T

The type of return value to expect in the handler.

Parameters

eventName System.String

The name of the event to add a listener for.

handler System.Func<T ,System.Threading.Tasks.Task >

The function to call when the event triggers.

Returns

System.Threading.Tasks.Task

MapComponent.AddReactiveWaiter(string, Action, string, bool, bool) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Action handler, string? targetName, bool once, bool initial);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action

The function to call when the value is truthy.

targetName System.String

The name of the target you are referencing in the

waitExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWaiter(string,System.Action,string,bool,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWaiter(string,System.Action,string,bool,bool).initial'></a>

`initial` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback immediately after initialization, if the necessary conditions are met.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding waiters to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWaiter(string, Action, string, bool) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Action handler, string? targetName, bool once);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action

The function to call when the value is truthy.

targetName System.String

The name of the target you are referencing in the

waitExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWaiter(string,System.Action,string,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding waiters to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWaiter(string, Action, string) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Action handler, string? targetName);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action

The function to call when the value is truthy.

targetName System.String

The name of the target you are referencing in the

waitExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding waiters to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWaiter(string, Action) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Action handler);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action

The function to call when the value is truthy.

Returns

System.Threading.Tasks.Task

Exceptions

UnMatchedTargetNameException
This exception is thrown when a watchExpression’s target object name doesn’t match the targetName parameter.

Remarks

For adding waiters to types other than MapView and SceneView, the default

targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWaiter(string, Func, string, bool, bool) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Func<System.Threading.Tasks.Task> handler, string? targetName, bool once, bool initial);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<System.Threading.Tasks.Task >

The function to call when the value is truthy.

targetName System.String

The name of the target you are referencing in the

waitExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWaiter(string,System.Func_System.Threading.Tasks.Task_,string,bool,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWaiter(string,System.Func_System.Threading.Tasks.Task_,string,bool,bool).initial'></a>

`initial` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback immediately after initialization, if the necessary conditions are met.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding waiters to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWaiter(string, Func, string, bool) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Func<System.Threading.Tasks.Task> handler, string? targetName, bool once);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<System.Threading.Tasks.Task >

The function to call when the value is truthy.

targetName System.String

The name of the target you are referencing in the

waitExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWaiter(string,System.Func_System.Threading.Tasks.Task_,string,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding waiters to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWaiter(string, Func, string) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Func<System.Threading.Tasks.Task> handler, string? targetName);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<System.Threading.Tasks.Task >

The function to call when the value is truthy.

targetName System.String

The name of the target you are referencing in the

waitExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding waiters to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWaiter(string, Func) Method

Tracks a value in the

waitExpression
``` and calls the callback when it becomes <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>.

```csharp
public System.Threading.Tasks.Task AddReactiveWaiter(string waitExpression, System.Func<System.Threading.Tasks.Task> handler);

Parameters

waitExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<System.Threading.Tasks.Task >

The function to call when the value is truthy.

Returns

System.Threading.Tasks.Task

Exceptions

UnMatchedTargetNameException
This exception is thrown when a watchExpression’s target object name doesn’t match the targetName parameter.

Remarks

For adding waiters to types other than MapView and SceneView, the default

targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
waitExpression

MapComponent.AddReactiveWatcher(string, Action, string, bool, bool) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Action<T> handler, string? targetName, bool once, bool initial);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action<T >

The function to call when there are changes.

targetName System.String

The name of the target you are referencing in the

watchExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWatcher_T_(string,System.Action_T_,string,bool,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWatcher_T_(string,System.Action_T_,string,bool,bool).initial'></a>

`initial` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback immediately after initialization, if the necessary conditions are met.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding watchers to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AddReactiveWatcher(string, Action, string, bool) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Action<T> handler, string? targetName, bool once);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action<T >

The function to call when there are changes.

targetName System.String

The name of the target you are referencing in the

watchExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWatcher_T_(string,System.Action_T_,string,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding watchers to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AddReactiveWatcher(string, Action, string) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Action<T> handler, string? targetName);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action<T >

The function to call when there are changes.

targetName System.String

The name of the target you are referencing in the

watchExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding watchers to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AddReactiveWatcher(string, Action) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Action<T> handler);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Action<T >

The function to call when there are changes.

Returns

System.Threading.Tasks.Task

Exceptions

UnMatchedTargetNameException
This exception is thrown when a watchExpression’s target object name doesn’t match the targetName parameter.

Remarks

For adding watchers to types other than MapView and SceneView, the default

targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AddReactiveWatcher(string, Func<T,Task>, string, bool, bool) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Func<T,System.Threading.Tasks.Task> handler, string? targetName, bool once, bool initial);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<T ,System.Threading.Tasks.Task >

The function to call when there are changes.

targetName System.String

The name of the target you are referencing in the

watchExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWatcher_T_(string,System.Func_T,System.Threading.Tasks.Task_,string,bool,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWatcher_T_(string,System.Func_T,System.Threading.Tasks.Task_,string,bool,bool).initial'></a>

`initial` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback immediately after initialization, if the necessary conditions are met.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding watchers to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AddReactiveWatcher(string, Func<T,Task>, string, bool) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Func<T,System.Threading.Tasks.Task> handler, string? targetName, bool once);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<T ,System.Threading.Tasks.Task >

The function to call when there are changes.

targetName System.String

The name of the target you are referencing in the

watchExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AddReactiveWatcher_T_(string,System.Func_T,System.Threading.Tasks.Task_,string,bool).once'></a>

`once` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

Whether to fire the callback only once.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding watchers to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AddReactiveWatcher(string, Func<T,Task>, string) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Func<T,System.Threading.Tasks.Task> handler, string? targetName);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<T ,System.Threading.Tasks.Task >

The function to call when there are changes.

targetName System.String

The name of the target you are referencing in the

watchExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

### Remarks
For adding watchers to types other than [MapView](dymaptic.GeoBlazor.Core.Components.Views.MapView.html 'dymaptic.GeoBlazor.Core.Components.Views.MapView') and [SceneView](dymaptic.GeoBlazor.Core.Components.Views.SceneView.html 'dymaptic.GeoBlazor.Core.Components.Views.SceneView'), the default 

```csharp
targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AddReactiveWatcher(string, Func<T,Task>) Method

Tracks any properties accessed in the

watchExpression
``` and calls the callback when any of them change.

```csharp
public System.Threading.Tasks.Task AddReactiveWatcher<T>(string watchExpression, System.Func<T,System.Threading.Tasks.Task> handler);

Type parameters

T

The type of return value to expect in the handler.

Parameters

watchExpression System.String

Expression used to get the current value. All accessed properties will be tracked.

handler System.Func<T ,System.Threading.Tasks.Task >

The function to call when there are changes.

Returns

System.Threading.Tasks.Task

Exceptions

UnMatchedTargetNameException
This exception is thrown when a watchExpression’s target object name doesn’t match the targetName parameter.

Remarks

For adding watchers to types other than MapView and SceneView, the default

targetName
``` should not be relied upon. Make sure it matches the variable in your

```csharp
watchExpression

MapComponent.AwaitReactiveSingleWatchUpdate(string, string, CancellationToken) Method

Tracks any properties being evaluated by the getValue function. When getValue changes, it returns a Task containing the value. This method only tracks a single change.

public System.Threading.Tasks.Task<T> AwaitReactiveSingleWatchUpdate<T>(string watchExpression, string? targetName=null, System.Threading.CancellationToken token=default(System.Threading.CancellationToken));

Type parameters

T

The expected return type.

Parameters

watchExpression System.String

The expression to be tracked.

targetName System.String

The name of the target you are referencing in the

waitExpression
```. For example, if the expression is "layer?.refresh", then the targetName should be "layer". The type of the target should also match the class on which this method was called.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.AwaitReactiveSingleWatchUpdate_T_(string,string,System.Threading.CancellationToken).token'></a>

`token` [System.Threading.CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.CancellationToken 'System.Threading.CancellationToken')

Optional Cancellation Token to abort a listener.

#### Returns
[System.Threading.Tasks.Task&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task\`1')[T](dymaptic.GeoBlazor.Core.Components.MapComponent.html#dymaptic.GeoBlazor.Core.Components.MapComponent.AwaitReactiveSingleWatchUpdate_T_(string,string,System.Threading.CancellationToken).T 'dymaptic.GeoBlazor.Core.Components.MapComponent.AwaitReactiveSingleWatchUpdate<T>(string, string, System.Threading.CancellationToken).T')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task\`1')  
Returns the value from the evaluated property when it changes.

#### Exceptions

[UnMatchedTargetNameException](dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException.html 'dymaptic.GeoBlazor.Core.Exceptions.UnMatchedTargetNameException')  
This exception is thrown when a watchExpression's target object name doesn't match the targetName parameter.

<a name='dymaptic.GeoBlazor.Core.Components.MapComponent.DisposeAsync()'></a>

## MapComponent.DisposeAsync() Method

Implements the \`IAsyncDisposable\` pattern.

```csharp
public virtual System.Threading.Tasks.ValueTask DisposeAsync();

Implements DisposeAsync(), DisposeAsync()

Returns

System.Threading.Tasks.ValueTask

MapComponent.GetProperty(string) Method

Asynchronously retrieve the current value of any property, based on the property name. You must also define the type of the property in the Generic type.

public virtual System.Threading.Tasks.Task<T?> GetProperty<T>(string propertyName);

Type parameters

T

The type of the value to get.

Parameters

propertyName System.String

The name of the property to get.

Returns

System.Threading.Tasks.Task<T >

Exceptions

System.NotSupportedException
Throws if the component does not support the GetProperty method.

MapComponent.GetVisible() Method

Retrieves the current value of the Visible property.

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

Returns

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

MapComponent.OnJsComponentCreated(IJSObjectReference, IJSStreamReference) Method

For internal use, registration from JavaScript.

public virtual System.Threading.Tasks.ValueTask<dymaptic.GeoBlazor.Core.Components.MapComponent?> OnJsComponentCreated(Microsoft.JSInterop.IJSObjectReference jsComponentReference, Microsoft.JSInterop.IJSStreamReference jsonStreamReference);

Parameters

jsComponentReference Microsoft.JSInterop.IJSObjectReference

jsonStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.ValueTask<MapComponent >

MapComponent.OnReactiveListenerTriggered(string, IJSStreamReference) Method

JS-Invokable method that is triggered by the reactiveUtils ‘on’ listeners. This method will dynamically trigger handlers passed to AddReactiveListener<T>(string, Func<T,Task>)

public System.Threading.Tasks.Task OnReactiveListenerTriggered(string eventName, Microsoft.JSInterop.IJSStreamReference? jsStreamReference);

Parameters

eventName System.String

The tracked event that was triggered.

jsStreamReference Microsoft.JSInterop.IJSStreamReference

The return value of the watcher callback.

Returns

System.Threading.Tasks.Task

MapComponent.OnReactiveWaiterTrue(string) Method

JS-Invokable method that is triggered by the reactiveUtils waiters. This method will dynamically trigger handlers passed to AddReactiveWaiter(string, Func<Task>)

public void OnReactiveWaiterTrue(string waitExpression);

Parameters

waitExpression System.String

The tracked expression that was triggered.

MapComponent.OnReactiveWatcherUpdate(string, IJSStreamReference) Method

JS-Invokable method that is triggered by the reactiveUtils watchers. This method will dynamically trigger handlers passed to AddReactiveWatcher<T>(string, Func<T,Task>)

public System.Threading.Tasks.Task OnReactiveWatcherUpdate(string watchExpression, Microsoft.JSInterop.IJSStreamReference? jsStreamReference);

Parameters

watchExpression System.String

The tracked expression that was triggered.

jsStreamReference Microsoft.JSInterop.IJSStreamReference

The return value of the watcher callback.

Returns

System.Threading.Tasks.Task

MapComponent.Refresh() Method

Provides a way to externally call `StateHasChanged` on the component.

public virtual System.Threading.Tasks.ValueTask Refresh();

Returns

System.Threading.Tasks.ValueTask

MapComponent.RegisterChildComponent(MapComponent) Method

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

public virtual 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.

MapComponent.RemoveReactiveListener(string) Method

Removes the tracker on a particular expression.

public System.Threading.Tasks.Task RemoveReactiveListener(string eventName);

Parameters

eventName System.String

The expression to stop tracking.

Returns

System.Threading.Tasks.Task

MapComponent.RemoveReactiveWaiter(string) Method

Removes the tracker on a particular expression.

public System.Threading.Tasks.Task RemoveReactiveWaiter(string waitExpression);

Parameters

waitExpression System.String

The expression to stop tracking.

Returns

System.Threading.Tasks.Task

MapComponent.RemoveReactiveWatcher(string) Method

Removes the tracker on a particular expression.

public System.Threading.Tasks.Task RemoveReactiveWatcher(string watchExpression);

Parameters

watchExpression System.String

The expression to stop tracking.

Returns

System.Threading.Tasks.Task

MapComponent.SetParametersAsync(ParameterView) Method

Sets parameters supplied by the component’s parent in the render tree.

public override System.Threading.Tasks.Task SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView parameters);

Parameters

parameters Microsoft.AspNetCore.Components.ParameterView

The parameters.

Implements SetParametersAsync(ParameterView)

Returns

System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes when the component has finished updating and rendering itself.

Remarks

Parameters are passed when Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView) is called. It is not required that the caller supply a parameter value for all of the parameters that are logically understood by the component.

The default implementation of Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView) will set the value of each property decorated with Microsoft.AspNetCore.Components.ParameterAttribute or Microsoft.AspNetCore.Components.CascadingParameterAttribute that has a corresponding value in the Microsoft.AspNetCore.Components.ParameterView. Parameters that do not have a corresponding value will be unchanged.

MapComponent.SetProperty(string, T) Method

Sets any property to a new value after initial render. Supports all basic types (strings, numbers, booleans, dictionaries) and properties.

public virtual System.Threading.Tasks.Task SetProperty<T>(string propertyName, T? value);

Type parameters

T

The type of the value to set.

Parameters

propertyName System.String

The name of the property to set.

value T

The new value.

Returns

System.Threading.Tasks.Task

Exceptions

System.NotSupportedException
Throws if the component does not support the SetProperty method.

MapComponent.SetVisibility(bool) Method

Toggles the visibility of the component.

public System.Threading.Tasks.Task SetVisibility(bool visible);

Parameters

visible System.Boolean

The new value to set for visibility of the component.

Returns

System.Threading.Tasks.Task

MapComponent.SetVisible(bool) Method

Toggles the visibility of the component.

public System.Threading.Tasks.Task SetVisible(bool visible);

Parameters

visible System.Boolean

The new value to set for visibility of the component.

Returns

System.Threading.Tasks.Task

MapComponent.UnregisterChildComponent(MapComponent) Method

Undoes the “Registration” of a child with its parent.

public virtual 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.

MapComponent.ValidateRequiredChildren() Method

When a MapView is prepared to render, this will check to make sure that all properties with the RequiredPropertyAttribute are provided.

public virtual void ValidateRequiredChildren();

Implements ValidateRequiredChildren()

Exceptions

MissingRequiredChildElementException
The consumer needs to provide the missing child component

MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components

MapComponent.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public virtual void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()