Class DiagramModel

Represents the interface for a class diagram.

Inheritance

System.Object

DiagramModel

Namespace: Syncfusion.Blazor.Diagrams

Assembly: Syncfusion.Blazor.dll

Syntax

public class DiagramModel : Object

Constructors

DiagramModel()

Declaration

public DiagramModel()

Properties

AddInfo

Allows the user to save custom information/data about diagram.

Declaration

public object AddInfo { get; set; }

Property Value

Type	Description
System.Object

AnnotationTemplate

Customizes the annotation template.

Declaration

public string AnnotationTemplate { get; set; }

Property Value

Type	Description
System.String

BackgroundColor

Defines the background color of the diagram.

Declaration

public string BackgroundColor { get; set; }

Property Value

Type	Description
System.String

BridgeDirection

Defines the direction of the bridge that is inserted when the segments are intersected.

Declaration

public BridgeDirection BridgeDirection { get; set; }

Property Value

Type	Description
BridgeDirection

Click

Triggers when a node, connector or diagram is clicked.

Declaration

public IBlazorClickEventArgs Click { get; set; }

Property Value

Type	Description
IBlazorClickEventArgs

CommandExecute

Triggers when a command executed.

Declaration

public ICommandExecuteEventArgs CommandExecute { get; set; }

Property Value

Type	Description
ICommandExecuteEventArgs

CommandManager

Defines a set of custom commands and binds them with a set of desired key gestures.

Declaration

public DiagramCommandManager CommandManager { get; set; }

Property Value

Type	Description
DiagramCommandManager

ConnectionChange

Triggers when the connection is changed.

Declaration

public IBlazorConnectionChangeEventArgs ConnectionChange { get; set; }

Property Value

Type	Description
IBlazorConnectionChangeEventArgs

ConnectorDefaults

Helps to assign the default properties of connector.

Declaration

public DiagramConnector ConnectorDefaults { get; set; }

Property Value

Type	Description
DiagramConnector

Connectors

Defines a collection of objects, used to create link between two points, nodes or ports to represent the relationships between them.

Declaration

public ObservableCollection<DiagramConnector> Connectors { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<DiagramConnector>

Constraints

Defines the collection of constraints which enable or disable certain features of the diagram.

Declaration

public DiagramConstraints Constraints { get; set; }

Property Value

Type	Description
DiagramConstraints

ContextMenuClick

Triggers when a context menu item is clicked.

Declaration

public DiagramMenuEventArgs ContextMenuClick { get; set; }

Property Value

Type	Description
DiagramMenuEventArgs

ContextMenuOpen

Triggers before opening the context menu.

Declaration

public DiagramBeforeMenuOpenEventArgs ContextMenuOpen { get; set; }

Property Value

Type	Description
DiagramBeforeMenuOpenEventArgs

ContextMenuSettings

Represents the context menu for an element.

Declaration

public DiagramContextMenuSettings ContextMenuSettings { get; set; }

Property Value

Type	Description
DiagramContextMenuSettings

Created

Triggered when the diagram is rendered completely.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

CustomCursor

A collection of JSON objects where each object represents a custom cursor action. Layer is a named category of diagram shapes.

Declaration

public ObservableCollection<DiagramCustomCursor> CustomCursor { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<DiagramCustomCursor>

DataSourceSettings

Configures the data source that is to be bound with diagram.

Declaration

public DiagramDataSource DataSourceSettings { get; set; }

Property Value

Type	Description
DiagramDataSource

DiagramSettings

Defines the settings of diagram.

Declaration

public DiagramSettings DiagramSettings { get; set; }

Property Value

Type	Description
DiagramSettings

DoubleClick

Triggers when a node, connector or diagram model is clicked twice.

Declaration

public IBlazorDoubleClickEventArgs DoubleClick { get; set; }

Property Value

Type	Description
IBlazorDoubleClickEventArgs

DragEnter

Triggers when a symbol is dragged into diagram from symbol palette.

Declaration

public IBlazorDragEnterEventArgs DragEnter { get; set; }

Property Value

Type	Description
IBlazorDragEnterEventArgs

DragLeave

Triggers when a symbol is dragged outside of the diagram.

Declaration

public IBlazorDragLeaveEventArgs DragLeave { get; set; }

Property Value

Type	Description
IBlazorDragLeaveEventArgs

DrawingObject

Defines the object to be drawn using drawing tool.

Declaration

public object DrawingObject { get; set; }

Property Value

Type	Description
System.Object

Drop

Triggers when a symbol is dragged and dropped from symbol palette to drawing area.

Declaration

public IBlazorDropEventArgs Drop { get; set; }

Property Value

Type	Description
IBlazorDropEventArgs

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

FixedUserHandleClick

Triggers when a mouseDown on the user handle.

Declaration

public FixedUserHandleClickEventArgs FixedUserHandleClick { get; set; }

Property Value

Type	Description
FixedUserHandleClickEventArgs

Height

Defines the height of the diagram model.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

HistoryChange

Triggers when a change is reverted or restored(undo/redo).

Declaration

public IBlazorHistoryChangeArgs HistoryChange { get; set; }

Property Value

Type	Description
IBlazorHistoryChangeArgs

HistoryManager

Customizes the undo redo functionality.

Declaration

public History HistoryManager { get; set; }

Property Value

Type	Description
History

HistoryStateChange

Triggers when a custom entry change is reverted or restored(undo/redo).

Declaration

public IBlazorCustomHistoryChangeArgs HistoryStateChange { get; set; }

Property Value

Type	Description
IBlazorCustomHistoryChangeArgs

KeyDown

Triggers when a user is pressing a key.

Declaration

public EventCallback<object> KeyDown { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

KeyUp

Triggers when a user releases a key.

Declaration

public EventCallback<object> KeyUp { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Layers

A collection of JSON objects where each object represents a layer. Layer is a named category of diagram shapes.

Declaration

public ObservableCollection<DiagramLayer> Layers { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<DiagramLayer>

Layout

Layout is used to auto-arrange the nodes in the Diagram area.

Declaration

public DiagramLayout Layout { get; set; }

Property Value

Type	Description
DiagramLayout

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Mode

Defines the diagram rendering mode.

Declaration

public RenderingMode Mode { get; set; }

Property Value

Type	Description
RenderingMode

MouseEnter

Triggered when mouse enters a node/connector.

Declaration

public IBlazorMouseEventArgs MouseEnter { get; set; }

Property Value

Type	Description
IBlazorMouseEventArgs

MouseLeave

Triggered when mouse leaves node/connector.

Declaration

public IBlazorMouseEventArgs MouseLeave { get; set; }

Property Value

Type	Description
IBlazorMouseEventArgs

NodeDefaults

Helps to assign the default properties of nodes.

Declaration

public DiagramNode NodeDefaults { get; set; }

Property Value

Type	Description
DiagramNode

Nodes

Defines the node's collection and properties of each node to be rendered in the diagram.

Declaration

public ObservableCollection<DiagramNode> Nodes { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<DiagramNode>

NodeTemplate

Customizes the node template.

Declaration

public string NodeTemplate { get; set; }

Property Value

Type	Description
System.String

OnUserHandleMouseDown

Triggers when a mouseDown on the user handle.

Declaration

public EventCallback<object> OnUserHandleMouseDown { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

OnUserHandleMouseEnter

Triggers when a mouseEnter on the user handle.

Declaration

public EventCallback<object> OnUserHandleMouseEnter { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

OnUserHandleMouseLeave

Triggers when a mouseLeave on the user handle.

Declaration

public EventCallback<object> OnUserHandleMouseLeave { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

OnUserHandleMouseUp

Triggers when a mouseUp on the user handle.

Declaration

public EventCallback<object> OnUserHandleMouseUp { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

PageSettings

Page settings enable to customize the appearance, width, and height of the Diagram page.

Declaration

public DiagramPageSettings PageSettings { get; set; }

Property Value

Type	Description
DiagramPageSettings

PositionChange

Triggers while dragging the elements in diagram.

Declaration

public IBlazorDraggingEventArgs PositionChange { get; set; }

Property Value

Type	Description
IBlazorDraggingEventArgs

PropertyChange

Triggers once the node or connector property changed.

Declaration

public IBlazorPropertyChangeEventArgs PropertyChange { get; set; }

Property Value

Type	Description
IBlazorPropertyChangeEventArgs

RotateChange

Triggers when the diagram elements are rotated.

Declaration

public EventCallback<object> RotateChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

RulerSettings

Defines the properties of both horizontal and vertical guides/rulers to measure the diagram area.

Declaration

public DiagramRulerSettings RulerSettings { get; set; }

Property Value

Type	Description
DiagramRulerSettings

ScrollSettings

Defines the current zoom value, zoom factor, scroll status and view port size of the diagram.

Declaration

public DiagramScrollSettings ScrollSettings { get; set; }

Property Value

Type	Description
DiagramScrollSettings

SelectedItems

Defines the collection of selected items, size and position of the selector.

Declaration

public DiagramSelectedItems SelectedItems { get; set; }

Property Value

Type	Description
DiagramSelectedItems

SelectionChange

Triggers when the selection is changed in diagram.

Declaration

public IBlazorSelectionChangeEventArgs SelectionChange { get; set; }

Property Value

Type	Description
IBlazorSelectionChangeEventArgs

SerializationSettings

Defines the properties of saving and loading for the state persistence of the diagram.

Declaration

public DiagramSerializationSettings SerializationSettings { get; set; }

Property Value

Type	Description
DiagramSerializationSettings

SizeChange

Triggers when a node is resized.

Declaration

public EventCallback<object> SizeChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

SnapSettings

Defines the gridlines and defines how and when the objects have to be snapped.

Declaration

public DiagramSnapSettings SnapSettings { get; set; }

Property Value

Type	Description
DiagramSnapSettings

TextEdit

Triggers when editor got focus at the time of node’s label or text node editing.

Declaration

public IBlazorTextEditEventArgs TextEdit { get; set; }

Property Value

Type	Description
IBlazorTextEditEventArgs

Tooltip

Defines the tooltip that should be shown when the mouse hovers over a node or connector An object that defines the description, appearance and alignments of tooltip.

Declaration

public DiagramTooltip Tooltip { get; set; }

Property Value

Type	Description
DiagramTooltip

Width

Defines the width of the diagram model.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String