GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components

CreateTools Class

The available sketch tools within the widget.

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

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

Constructors

CreateTools() Constructor

Parameterless constructor for use as a Razor Component.

public CreateTools();

CreateTools(Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable) Constructor

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

public CreateTools(System.Nullable<bool> circle=null, System.Nullable<bool> freehandPolygon=null, System.Nullable<bool> freehandPolyline=null, System.Nullable<bool> point=null, System.Nullable<bool> polygon=null, System.Nullable<bool> polyline=null, System.Nullable<bool> rectangle=null);

Parameters

circle System.Nullable<System.Boolean>

Indicates whether to display the circle sketch tool. Default is true.

freehandPolygon System.Nullable<System.Boolean>

Indicates whether to display the freehand polygon sketch tool. Default is false.

freehandPolyline System.Nullable<System.Boolean>

Indicates whether to display the freehand polyline sketch tool. Default is false.

point System.Nullable<System.Boolean>

Indicates whether to display the point sketch tool. Default is true.

polygon System.Nullable<System.Boolean>

Indicates whether to display the polygon sketch tool. Default is true.

polyline System.Nullable<System.Boolean>

Indicates whether to display the polyline sketch tool. Default is true.

rectangle System.Nullable<System.Boolean>

Indicates whether to display the rectangle sketch tool. Default is true.

Properties

CreateTools.Circle Property

Indicates whether to display the circle sketch tool. Default is true.

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

Property Value

System.Nullable<System.Boolean>

CreateTools.FreehandPolygon Property

Indicates whether to display the freehand polygon sketch tool. Default is false.

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

Property Value

System.Nullable<System.Boolean>

CreateTools.FreehandPolyline Property

Indicates whether to display the freehand polyline sketch tool. Default is false.

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

Property Value

System.Nullable<System.Boolean>

CreateTools.Point Property

Indicates whether to display the point sketch tool. Default is true.

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

Property Value

System.Nullable<System.Boolean>

CreateTools.Polygon Property

Indicates whether to display the polygon sketch tool. Default is true.

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

Property Value

System.Nullable<System.Boolean>

CreateTools.Polyline Property

Indicates whether to display the polyline sketch tool. Default is true.

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

Property Value

System.Nullable<System.Boolean>

CreateTools.Rectangle Property

Indicates whether to display the rectangle sketch tool. Default is true.

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

Property Value

System.Nullable<System.Boolean>

Methods

CreateTools.GetCircle() Method

Asynchronously retrieve the current value of the Circle property.

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

Returns

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

CreateTools.GetFreehandPolygon() Method

Asynchronously retrieve the current value of the FreehandPolygon property.

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

Returns

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

CreateTools.GetFreehandPolyline() Method

Asynchronously retrieve the current value of the FreehandPolyline property.

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

Returns

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

CreateTools.GetPoint() Method

Asynchronously retrieve the current value of the Point property.

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

Returns

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

CreateTools.GetPolygon() Method

Asynchronously retrieve the current value of the Polygon property.

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

Returns

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

CreateTools.GetPolyline() Method

Asynchronously retrieve the current value of the Polyline property.

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

Returns

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

CreateTools.GetRectangle() Method

Asynchronously retrieve the current value of the Rectangle property.

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

Returns

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

CreateTools.SetCircle(Nullable) Method

Asynchronously set the value of the Circle property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

CreateTools.SetFreehandPolygon(Nullable) Method

Asynchronously set the value of the FreehandPolygon property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

CreateTools.SetFreehandPolyline(Nullable) Method

Asynchronously set the value of the FreehandPolyline property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

CreateTools.SetPoint(Nullable) Method

Asynchronously set the value of the Point property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

CreateTools.SetPolygon(Nullable) Method

Asynchronously set the value of the Polygon property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

CreateTools.SetPolyline(Nullable) Method

Asynchronously set the value of the Polyline property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

CreateTools.SetRectangle(Nullable) Method

Asynchronously set the value of the Rectangle property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task