dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

Graphic Class

A Graphic is a vector representation of real world geographic phenomena.
ArcGIS Maps SDK for JavaScript

public class Graphic : dymaptic.GeoBlazor.Core.Components.MapComponent,
System.IEquatable<dymaptic.GeoBlazor.Core.Components.Graphic>,
dymaptic.GeoBlazor.Core.Interfaces.IHitTestItem,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IIntersectItem

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

Implements System.IEquatable<Graphic>, IHitTestItem, IMapComponent, IIntersectItem

Constructors

Graphic() Constructor

Parameterless constructor for use as a Razor Component.

public Graphic();

Graphic(Geometry, Symbol, PopupTemplate, AttributesDictionary, Nullable, string, string, GraphicOrigin) Constructor

Constructor for use in C# code.

public Graphic(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? geometry=null, dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? symbol=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? popupTemplate=null, dymaptic.GeoBlazor.Core.Model.AttributesDictionary? attributes=null, System.Nullable<bool> visible=null, string? legendLabel=null, string? aggregateGeometries=null, dymaptic.GeoBlazor.Core.Model.GraphicOrigin? origin=null);

Parameters

geometry Geometry

The geometry that defines the graphic’s location.
ArcGIS Maps SDK for JavaScript

symbol Symbol

The Symbol for the graphic.
ArcGIS Maps SDK for JavaScript

popupTemplate PopupTemplate

The template for displaying content in a Popup when the graphic is selected.
ArcGIS Maps SDK for JavaScript

attributes AttributesDictionary

Name-value pairs of fields and field values associated with the graphic.
ArcGIS Maps SDK for JavaScript

visible System.Nullable<System.Boolean>

legendLabel System.String

aggregateGeometries System.String

The aggregateGeometries contains spatial aggregation geometries when statistics query is executed with envelope-aggregate, centroid-aggregate and/or convex-hull-aggregate statistics type.
ArcGIS Maps SDK for JavaScript

origin GraphicOrigin

Returns information about an origin of a graphic if applicable.
ArcGIS Maps SDK for JavaScript

Properties

Graphic.AggregateGeometries Property

The aggregateGeometries contains spatial aggregation geometries when statistics query is executed with
envelope-aggregate, centroid-aggregate and/or convex-hull-aggregate statistics type.
ArcGIS Maps SDK for JavaScript

public string? AggregateGeometries { get; set; }

Property Value

System.String

Graphic.Attributes Property

Name-value pairs of fields and field values associated with the graphic.

public dymaptic.GeoBlazor.Core.Model.AttributesDictionary Attributes { get; set; }

Property Value

AttributesDictionary

Remarks

This collection should only be set via the constructor or as a markup parameter/attribute. To add or remove members, use the methods defined in AttributesDictionary

Graphic.Geometry Property

The geometry that defines the graphic’s location.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Geometries.Geometry? Geometry { get; set; }

Property Value

Geometry

Graphic.IsAggregate Property

Indicates whether the graphic refers to an aggregate, or cluster graphic.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

Graphic.LegendLabel Property

Legend label override for this graphic in the GeoBlazor Pro Graphics Legend Widget.
Supports attribute substitution using the syntax {attributeName}.

public string? LegendLabel { get; set; }

Property Value

System.String

Graphic.Origin Property

Returns information about an origin of a graphic if applicable.
ArcGIS Maps SDK for JavaScript

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

Property Value

GraphicOrigin

Graphic.PopupTemplate Property

The template for displaying content in a Popup when the graphic is selected.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? PopupTemplate { get; set; }

Property Value

PopupTemplate

Graphic.Symbol Property

The Symbol for the graphic.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? Symbol { get; set; }

Property Value

Symbol

Methods

Graphic.DisposeAsync() Method

Implements the IAsyncDisposable pattern.

public override System.Threading.Tasks.ValueTask DisposeAsync();

Implements DisposeAsync(), DisposeAsync()

Returns

System.Threading.Tasks.ValueTask

Graphic.Equals(Graphic) Method

public bool Equals(dymaptic.GeoBlazor.Core.Components.Graphic? other);

Parameters

other Graphic

Returns

System.Boolean

Graphic.Equals(object) Method

public override bool Equals(object? obj);

Parameters

obj System.Object

Returns

System.Boolean

Graphic.GetAggregateGeometries() Method

Asynchronously retrieve the current value of the AggregateGeometries property.

public System.Threading.Tasks.Task<object?> GetAggregateGeometries();

Returns

System.Threading.Tasks.Task<System.Object>

Graphic.GetAttribute(string) Method

Returns the value of the specified attribute.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<object?> GetAttribute(string name);

Parameters

name System.String

The name of the attribute.

Returns

System.Threading.Tasks.Task<System.Object>

Graphic.GetEffectivePopupTemplate(bool) Method

Returns the popup template applicable for the graphic.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate?> GetEffectivePopupTemplate(bool defaultPopupTemplateEnabled);

Parameters

defaultPopupTemplateEnabled System.Boolean

Whether support for default popup templates is enabled. When true, a default popup template may be created automatically if neither the graphic nor its layer have a popup template defined.

Returns

System.Threading.Tasks.Task<PopupTemplate>

Graphic.GetGeometry() Method

Retrieves the Geometry from the rendered graphic.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Geometry?> GetGeometry();

Returns

System.Threading.Tasks.Task<Geometry>

Graphic.GetHashCode() Method

public override int GetHashCode();

Returns

System.Int32

Graphic.GetIsAggregate() Method

Asynchronously retrieve the current value of the IsAggregate property.

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

Returns

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

Graphic.GetLayer() Method

Retrieves the Layer from the rendered graphic.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.Layer?> GetLayer();

Returns

System.Threading.Tasks.Task<Layer>

Graphic.GetObjectId() Method

Returns the Object ID of the feature associated with the graphic, if it exists.
ArcGIS Maps SDK for JavaScript

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

Returns

System.Threading.Tasks.Task<ObjectId>

Graphic.GetOrigin() Method

Asynchronously retrieve the current value of the Origin property.

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

Returns

System.Threading.Tasks.Task<GraphicOrigin>

Graphic.GetPopupTemplate() Method

Retrieves the PopupTemplate from the rendered graphic.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate?> GetPopupTemplate();

Returns

System.Threading.Tasks.Task<PopupTemplate>

Graphic.GetSymbol() Method

Gets the current Symbol for the object.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol?> GetSymbol();

Returns

System.Threading.Tasks.Task<Symbol>

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

Graphic.SetAggregateGeometries(string) Method

Asynchronously set the value of the AggregateGeometries property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

Graphic.SetAttribute(string, string) Method

Sets a new value to the specified attribute.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task SetAttribute(string name, string newValue);

Parameters

name System.String

The name of the attribute to set.

newValue System.String

The new value to set on the named attribute.

Returns

System.Threading.Tasks.Task

Graphic.SetGeometry(Geometry) Method

Sets the Geometry on the rendered graphic.

public System.Threading.Tasks.Task SetGeometry(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry geometry);

Parameters

geometry Geometry

Returns

System.Threading.Tasks.Task

Graphic.SetOrigin(GraphicOrigin) Method

Asynchronously set the value of the Origin property after render.

public System.Threading.Tasks.Task SetOrigin(dymaptic.GeoBlazor.Core.Model.GraphicOrigin? value);

Parameters

value GraphicOrigin

The value to set.

Returns

System.Threading.Tasks.Task

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

Graphic.SetPopupTemplate(PopupTemplate) Method

Sets the PopupTemplate on the rendered graphic.

public System.Threading.Tasks.Task SetPopupTemplate(dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate popupTemplate);

Parameters

popupTemplate PopupTemplate

The PopupTemplate for displaying content in a Popup when the graphic is selected.

Returns

System.Threading.Tasks.Task

Graphic.SetSymbol(Symbol) Method

Sets the Symbol for the object.

public System.Threading.Tasks.Task SetSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol symbol);

Parameters

symbol Symbol

The Symbol for the object.

Returns

System.Threading.Tasks.Task

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

Graphic.ValidateRequiredChildren() Method

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

public override 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

Operators

Graphic.operator ==(Graphic, Graphic) Operator

Override the equality operator to compare two Graphic objects.

public static bool operator ==(dymaptic.GeoBlazor.Core.Components.Graphic? left, dymaptic.GeoBlazor.Core.Components.Graphic? right);

Parameters

left Graphic

right Graphic

Returns

System.Boolean

Graphic.operator !=(Graphic, Graphic) Operator

Override the inequality operator to compare two Graphic objects.

public static bool operator !=(dymaptic.GeoBlazor.Core.Components.Graphic? left, dymaptic.GeoBlazor.Core.Components.Graphic? right);

Parameters

left Graphic

right Graphic

Returns

System.Boolean