New to Telerik UI for Blazor? Start a free 30-day trial

DiagramShape

Class

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class DiagramShape : DataVizCollectionItemComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentDiagramShape

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataVizChildComponent.Dispose()ComponentBase.OnInitializedAsync()ComponentBase.OnParametersSetAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)...

Constructors

DiagramShape()

public DiagramShape()

Properties

ChildContent

RenderFragment

[Parameter]
public RenderFragment ChildContent { get; set; }

CornerRadius

double?

Defines the shape corner radius.

[Parameter]
public double? CornerRadius { get; set; }

DataItem

object

The data item of the shape.

[Parameter]
public object DataItem { get; set; }

Height

double?

Defines the height of the shape when added to the Diagram.

[Parameter]
public double? Height { get; set; }

Id

string

The unique identifier for a Shape. The id value is used to identify shapes in connection configurations. The connection to and from properties usually point to shape id values.

[Parameter]
public string Id { get; set; }

MinHeight

double?

Defines the minimum height the shape should have, that is, it cannot be resized to a value smaller than the given one.

[Parameter]
public double? MinHeight { get; set; }

MinWidth

double?

Defines the minimum width the shape should have, that is, it cannot be resized to a value smaller than the given one. See example at shapes.minHeight.

[Parameter]
public double? MinWidth { get; set; }

Path

string

The path option of a Shape is a description of a custom geometry. The format follows the standard SVG format (https://www.w3.org/TR/SVG/paths.html#PathData "SVG Path data.").

[Parameter]
public string Path { get; set; }

Source

string

The source of the shape image. Applicable when the type is set to "image".

[Parameter]
public string Source { get; set; }

Type

DiagramShapeType?

Specifies the type of the Shape using any of the built-in shape type. "rectangle" - The default option; "circle" - A circle/ellipse or "image" - An image.

[Parameter]
public DiagramShapeType? Type { get; set; }

Visual

string

A function returning a visual element to render for this shape. For more information, refer to visual.

[Parameter]
public string Visual { get; set; }

Width

double?

Defines the width of the shape when added to the Diagram.

[Parameter]
public double? Width { get; set; }

X

double?

Defines the x-coordinate of the shape when added to the Diagram. Does not take effect if the Diagram is using a pre-defined layout.

[Parameter]
public double? X { get; set; }

Y

double?

Defines the y-coordinate of the shape when added to the Diagram. Does not take effect if the Diagram is using a pre-defined layout. You can see an example at shapes.x

[Parameter]
public double? Y { get; set; }

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

protected override void Dispose(bool disposing)

Parameters:disposingbool

Overrides: DataVizChildComponent.Dispose(bool)

OnAfterRender(bool)

protected override void OnAfterRender(bool firstRender)

Parameters:firstRenderbool

Overrides: ComponentBase.OnAfterRender(bool)

OnInitialized()

protected override void OnInitialized()

Overrides: DataVizChildComponent.OnInitialized()

OnParametersSet()

protected override void OnParametersSet()

Overrides: ComponentBase.OnParametersSet()