menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Namespace Syncfusion.Blazor.Diagram - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Namespace Syncfusion.Blazor.Diagram

    Classes

    AlignmentMode

    Defines how the specified selected items are aligned when calling the align command.

    AlignmentOptions

    Defines how the selected objects should be positioned.

    Annotation

    Represents the textual content of nodes and connectors in a diagram.

    AnnotationAlignment

    It specifies the alignment of the diagram elements based on its immediate parent.

    AnnotationConstraints

    Enables or disables certain features and behaviors of the annotations.

    AnnotationRotationReference

    Specifies how the annotation should rotate in relation to the node.

    AutoScrollChangeEventArgs

    Provides information about the OnAutoScrollChange event callback.

    BackgroundStyle

    Represents the characteristics of the background of the SfDiagramComponent.

    BasicShape

    Represents a basic shape used in a diagram with defined properties such as shape type, corner radius, and points.

    BezierConnectorSettings

    Represents the settings for a Bezier connector, which defines the appearance and behavior of the connector's curved segments.

    BezierSegment

    Represents the bezier segment of the connector.

    BezierSegmentEditOrientation

    Specifies the orientation for editing mode of the intermediate point of two bezier segment

    BezierSmoothness

    Specifies the smoothness between the neighboring bezier segments.

    BoundaryConstraints

    Allows users to specify the region of the diagram in which they can interact with it.

    BpmnActivity

    Represents the work that a company or organization performs in a business process using a node in the diagram.

    BpmnActivityType

    Specifies the type of BpmnActivity.

    BpmnDataObject

    Represents the flow of data through the process in the diagram.

    BpmnDataObjectType

    Specifies the type of BpmnDataObject.

    BpmnDataStore

    Represents the storing or access of data associated with business processes.

    BpmnEvent

    Represents an event in a BPMN diagram as a circle that depicts an action within a process.

    BpmnEventTrigger

    Specifies type of triggers in BpmnEvent.

    BpmnEventType

    Specifies the type of BpmnEvent.

    BpmnExpandedSubProcess

    Represents the Expanded SubProcess that exposes its flow details within the context of its parent process.

    BpmnFlow

    Represents a Business Process Model and Notation (BPMN) flow element that connects different components in a diagram.

    BpmnFlowType

    Specifies the type of BpmnFlow.

    BpmnGateway

    Represents a BPMN Gateway used to control the merging and splitting of process flows within a diagram.

    BpmnGatewayType

    Specifies the type of BpmnGateway.

    BpmnLoopCharacteristic

    Specifies the LoopCharacteristics of BpmnActivity/BpmnExpandedSubProcess.

    BpmnMessage

    Represents the transferring of information into or out of an Activity in the diagram as part of the BPMN shapes.

    BpmnSubProcessType

    Specifies the Boundary.

    BpmnTaskType

    Specifies the type of the task in BpmnActivity.

    BpmnTextAnnotation

    Represents the information about any Bpmn element in the diagram.

    BranchDirection

    Defines the different branch directions available for Type when using Flowchart.

    BranchType

    Defines the Alignment position

    ClickEventArgs

    Notifies when clicking on an object or diagram.

    CollectionChangedAction

    Specifies whether an object is added/removed from the diagram.

    CollectionChangedEventArgs

    Notifies while the node/connector is added or removed from the diagram.

    CollectionChangingEventArgs

    Notifies before the node/connector is added or removed from the diagram.

    CommandKeyArgs

    Notifies when to execute the custom keyboard commands .

    CommandManager

    Represents the manager that handles a collection of custom commands and their associated key gestures in a diagram component.

    CommonController

    Represents an abstract base class that provides common functionality and tools for all controller implementations.

    CommonElement

    Represents the base class for all UI building blocks used in diagram nodes and connectors within the SfDiagramComponent.

    ConnectionChangedEventArgs

    Notifies when the connector’s source id or target id has changed.

    ConnectionChangingEventArgs

    Notifies before the connector’s source id or target id has changing.

    ConnectionController

    Represents a ConnectionController that manages the connection operations between connectors and nodes in diagram interactions.

    ConnectionObject

    Specifies the source and the target details of the connector.

    Connector

    Represents a Connector which serves as a line indicating the relationship between two points, nodes, or ports. Inherits from NodeBase.

    ConnectorConstraints

    Enables or disables certain behaviors and features of the connectors.

    ConnectorDrawingController

    Represents a specialized controller that manages the interactive drawing and creation of connectors in a SfDiagramComponent.

    ConnectorFixedUserHandle

    Represents the fixed user handle for a connector in the diagram.

    ConnectorPort

    Represents a port that can be positioned along a path on a connector in a diagram.

    ConnectorSegment

    Represents the segment of the connector. This class is a fundamental part of the connector structure used to visualize connections between diagram nodes.

    ConnectorSegmentType

    Specifies the segment type of the connector.

    ConnectorShape

    Represents the shape of the connector.

    Container

    Represents a graphical element used to visually group logically related diagram elements on a page.

    ContainerHeader

    Represents the header for a Container, providing additional details such as a title, label, or other descriptive information.

    ContextMenuItem

    Represents a context menu item model for the SfDiagramComponent.

    ContextMenuSettings

    Represents the settings for a context menu (shortcut menu) in a diagram component.

    ControlPointsVisibility

    Specifies the visibility options for control points in a Bezier curve.

    DataSourceSettings

    Represents the settings that specify the data source and define how the parent and child relationship will be generated in the diagram layout. It is applicable only when a diagram layout is used.

    DecoratorSettings

    Represents the shape and style configuration for the end points of a Connector in a diagram.

    DecoratorShape

    Specifies the decorator shape of the connector.

    DiagramAction

    Stores certain diagram state information that differ based on the usecase. For example, diagram rendering is in progress or any interaction currently in progress.

    DiagramCanvas

    Represents a specialized DiagramContainer that provides a plane for arranging child elements according to their margins and positioning requirements.

    DiagramCollapseIcon

    Represents a collapse icon for a node within a diagram.

    DiagramCollapseIcons

    Specifies the shape of the Collapse Icon.

    DiagramConstraints

    Specifies the constraints that enable or disable certain features of the SfDiagramComponent.

    DiagramContainer

    Represents a container used to group related diagram objects.

    DiagramElement

    Represents the basic UI building blocks in a diagram node or connector are diagram elements. To create a node or connector, multiple DiagramElements can be combined.

    DiagramElementAction

    It specifies the action to be performed in the diagram while interacting.

    DiagramElementMouseEventArgs

    Notifies when the mouse events such as mouse enter, mouse leave, and mouseover are detected.

    DiagramElementTooltip

    Represents a tooltip component associated with diagram elements such as nodes, connectors, ports, or user handles. Provides management of the display, configuration, and lifecycle of tooltips within the diagram component environment.

    DiagramExpandIcon

    Represents the expand icon used to indicate the expandable state of a node in a diagram component.

    DiagramExpandIcons

    Specifies the shape of the Expand Icon.

    DiagramExportFormat

    File Format type for export.

    DiagramExportSettings

    Represents the configuration settings for exporting the diagram to various formats including PDF, PNG, JPEG, and SVG.

    DiagramFlipMode

    Specifies the flip behavior options for diagram objects.

    DiagramGridLines

    Represents the visual guidance lines displayed while dragging or arranging objects in the SfDiagramComponent.

    DiagramHistoryManager

    Represents the manager that handles undo and redo operations for a diagram, notifying when changes are reverted or restored.

    DiagramHtmlElement

    Represents a DiagramHtmlElement that serves as the basic HTML building block for diagram nodes. To create a node, multiple diagram HTML elements can be combined.

    DiagramIcon

    Represents the icon of a node in the diagram.

    DiagramInteractions

    Allows the users to customize the selection, zooming, and interaction behavior of the diagram.

    DiagramKeys

    Specifies the key value, on recognition of which the command will be executed.

    DiagramMargin

    Represents the extra space around the outer boundaries of diagram elements in the SfDiagramComponent.

    DiagramMenuClickEventArgs

    Provides information about the SfDiagramComponent context menu item click event.

    DiagramMenuOpeningEventArgs

    Represents event arguments for the SfDiagramComponent context menu opening event.

    DiagramModel

    Represents the base class for all diagram models. This class can be extended to provide specific diagram types such as UML sequence diagrams.

    DiagramMouseEventArgs

    Provides information about current mouse events like mouse down, mouse move, etc.

    DiagramObject

    Represents the base class for all diagram objects in the SfDiagramComponent. This class provides fundamental functionality for property change notifications, parent-child relationships, and object lifecycle management.

    DiagramObjectCollection<T>

    Represents a dynamic data collection that provides notifications when nodes, connectors, annotations, or ports are added, removed, or when the entire list is refreshed.

    DiagramOverviewConstraints

    Specifies the interaction setting (such as the zoom, pan, draw, and tap) enabled or disabled in overview component.

    DiagramPoint

    Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.

    DiagramPrintExportRegion

    Specifies the region that has to be printed or exported in diagram.

    DiagramPrintSettings

    Represents the configuration settings for printing the diagram.

    DiagramRect

    Represents the width, height, and position of a rectangle in a SfDiagramComponent.

    DiagramRegion

    Specifies the region that has to be fit within the viewport.

    DiagramRuler

    Represents the properties common to both horizontal and vertical rulers for measuring the diagram area.

    DiagramScale

    Indicates whether or not the image should be scaled uniformly.

    DiagramSelectionSettings

    Represents a visual representation of the selected elements. Provides functionality as a container for single or multiple selected elements in a diagram structure.

    DiagramSize

    Represents the size of a diagram object.

    DiagramSvgElement

    Represents a native SVG element that serves as a fundamental building block for diagram nodes in the DiagramElement hierarchy. To create a node, multiple diagram native elements can be combined.

    DiagramTemplates

    Represents a collection of UI content templates for diagram elements, implemented as delegates that define the rendering content for nodes in the SfDiagramComponent.

    DiagramThickness

    Represents a DiagramThickness that describes the thickness of a frame around a rectangle in diagram elements.

    DiagramTooltip

    Represents the DiagramTooltip that provides textual content displayed when the mouse hovers over nodes or connectors in the diagram.

    Direction

    Specifies the orthogonal connector's connection segment direction.

    DistributeOptions

    Distribute the options that enable you to place the selected objects on the page at equal intervals from each other.

    DragController

    Represents a DragController that helps to move (drag) the selected objects in a diagram.

    DraggingEventArgs

    Notifies when an element drags over another diagram element.

    DragLeaveEventArgs

    Notifies when the element leaves the diagram.

    DragStartEventArgs

    Notifies when the element enters into the diagram from the symbol palette.

    DropEventArgs

    Notifies when the element is dropped from the diagram.

    EndPointChangedEventArgs

    Represents the source and target points of the connector are changed.

    EndPointChangingEventArgs

    Represents before the source and target points of the connector are changing.

    FitMode

    Indicates where an element should be displayed on the viewport relative to the Height and Width of the Diagram elementss in the page

    FitOptions

    Represents the configuration options for fitting the SfDiagramComponent into the viewport.

    FixedUserHandle

    Represents the behavior of a FixedUserHandle which is part of the diagram user handle, providing customization options for appearance and behavior.

    FixedUserHandleAlignment

    Represents the alignment of the FixedUserHandle with respect to its immediate parent.

    FixedUserHandleClickEventArgs

    Notifies when the fixed user handle gets clicked.

    FixedUserHandleController

    Represents a controller that handles fixed user handle events.

    FlipDirection

    Specifies how the diagram elements have to be flipped.

    FlowchartLayoutSettings

    Represents the configuration settings for the flowchart diagram layout.

    FlowShape

    Represents a flow shape used within a diagram.

    GradientBrush

    Represents a smooth transition from one color to the next while painting the node.

    GradientStop

    Represents a gradient stop, which defines a color at a specific position within a gradient.

    GridType

    Specifies the type of grid lines.

    HistoryAddingEventArgs

    HistoryAddingEventArgs notifies when an entry is added to the undo/redo stack.

    HistoryChangedAction

    Specifies the state of history actions such as undo and redo.

    HistoryChangedEventArgs

    Represents the class which is used to notifies while the changes occurs during undo/redo process.

    HistoryEntry

    Represents the entry of the changed history of an object.

    HistoryEntryBase

    Represents the entry of the changed history of an object.

    HistoryEntryChangeType

    Defines the change type from which the history will be entered.

    HistoryEntryType

    Defines the entry type

    HorizontalAlignment

    Represents the alignment of the diagram elements based on its immediate parent.

    HorizontalGridLines

    Represents the horizontal grid lines configuration for the SfDiagramComponent.

    HorizontalRuler

    Represents the horizontal ruler component that provides measurement guidance along the horizontal axis of a diagram.

    HyperlinkSettings

    Represents settings for configuring hyperlink properties in SfDiagramComponent annotations.

    ImageAlignment

    Specifies the process of overlaying images of the same scene under different condition of the image.

    ImageElement

    Represents a DiagramElement that defines and renders image content within diagrams.

    ImageShape

    Represents the behavior of the image shape within a Node.

    InteractionControllerBase

    Represents the base class for interactive tools in diagram components, providing foundational functionality for handling user interactions.

    KeyboardCommand

    Represents a command associated with a keyboard gesture within a diagram component.

    KeyEventArgs

    Notifies while performing the key actions.

    KeyGesture

    Represents a keyboard combination that can be used to invoke a command.

    Lane

    Represents a lane in a swimlane, which is a functional unit or responsible department within a business process.

    Layout

    Represents the class for arranging the nodes and connectors in a tree structure.

    LayoutMargin

    Represents the space configuration between the viewport and the automatic layout in a SfDiagramComponent.

    LayoutOrientation

    Specifies the orientation of the automatic layout.

    LayoutType

    Specifies the type of the layout that Diagram can be aligned its nodes and connectors.

    LinearGradientBrush

    Represents the class that provides functionality to paint nodes with a linear color transition using GradientBrush.

    LineRoutingSettings

    Represents settings for customizing line routing behavior in the diagram component.

    ModifierKeys

    Specifies a combination of key modifiers, on recognition of which the command will be executed.

    MouseButtons

    Defines the value that specifies the buttons on a mouse device.

    Node

    Represents the shape that is used to visualize geometrical information in the diagram.

    NodeBase

    Represents the base class for all diagram elements including nodes, connectors, and groups in the SfDiagramComponent.

    NodeBasicShapes

    Represents the available built-in basic shapes.

    NodeConstraints

    Specifies the node constraints allow the users to enable or disable certain behaviors and features of the diagram nodes.

    NodeDrawingController

    Represents a controller class that provides functionality for drawing nodes in a diagram component.

    NodeFixedUserHandle

    Represents the node’s fixed user handle in a diagram. This handle provides a standard way to interact with nodes in the diagram interface, allowing for uniform manipulation and interaction.

    NodeFlowShapes

    Specifies the type of process flow shape.

    NodeGroup

    Represents a cluster of multiple nodes and connectors into a single element, functioning as a container for its children (nodes, groups, and connectors).

    NodeShapes

    Specifies the type of node.

    Orientation

    Representing the placement of child elements in a vertical or horizontal stack

    OrthogonalSegment

    Represents how an orthogonal segment can be created with length and direction.

    PageMargin

    Represents the margin settings for a diagram page in the SfDiagramComponent.

    PageOrientation

    Defines the orientation of the Page

    PageSettings

    Represents the page settings configuration for customizing the appearance, width and height of the diagram page in the SfDiagramComponent.

    PathAnnotation

    Represents a PathAnnotation that displays text content along or over a connector path in a diagram.

    PathElement

    Represents a DiagramElement which defines how to align the path based on offsetX and offsetY.

    PathShape

    Represents a shape that draws a series of connected lines and curves.

    Phase

    Represents a phase is the subprocess which will split each lanes as horizontally or vertically based on the Swimlane orientation.

    PointPort

    Represents a behavior for a port (connection point) that sticks to a specific point on a node.

    PolygonDrawingController

    Represents a controller that provides functionality for drawing polygon shape nodes dynamically using the polygon drawing tool in a diagram.

    PolylineDrawingController

    Represents a specialized controller that enables dynamic drawing of polyline connectors using the PolyLine Drawing Tool in the SfDiagramComponent.

    Port

    Represents a port or connection point of the node. Provides a means for connecting nodes at specific locations.

    PortConnectionDirection

    Represents the allowed direction for connections to the port.

    PortConstraints

    Enables or disables certain features of the port.

    PortShapes

    Specifies the shape of the ports.

    PortVisibility

    Represents the visibility options of the port.

    PositionChangedEventArgs

    Notifies when the node or connector is dragged or its position is changed.

    PositionChangingEventArgs

    Notifies before the node or connector is dragging or its position is changing.

    PropertyChangedEventArgs

    Provides data for the PropertyChanged event.

    RadialGradientBrush

    Represents the focal point that defines the beginning of the gradient and a circle that defines the endpoint of the gradient.

    RelativeMode

    Specifies the relative mode.

    ResizeController

    Represents a controller that provides functionality for scaling and resizing selected objects in a diagram.

    RotationChangedEventArgs

    RotationChangedEventArgs notifies when the node/connector are rotated

    RotationChangingEventArgs

    RotationChangingEventArgs notifies before the node/connector are rotating

    RotationController

    Represents a controller that manages rotation interactions for selected diagram objects.

    RoutingTypes

    Specifies the types of Routing.

    RubberBandSelectionMode

    Defines how to handle the selected items via rubber band selection.

    RulerSettings

    Represents the ruler settings for the SfDiagramComponent that controls the visibility and appearance of horizontal and vertical rulers.

    ScrollChangedEventArgs

    ScrollChangedEventArgs notifies when the scroller has changed

    ScrollLimitMode

    Defines the scrollable region of the diagram.

    ScrollSettings

    Represents the scroll and zoom configuration settings for the SfDiagramComponent.

    SegmentCollectionChangeEventArgs

    SegmentCollectionChangeEventArgs notifies while the segment of the connectors changes

    SegmentThumbSettings

    Represents the settings for a segment thumb, including its shape, for connector segments.

    SegmentThumbShapes

    Defines the segmentThumb shape of the connector

    SelectionChangedEventArgs

    Notifies when select or deselect any objects from the diagram.

    SelectionChangingEventArgs

    Notifies before the select or deselect any objects from the diagram.

    SelectionController

    Represents a controller that provides object selection functionality within the SfDiagramComponent.

    SelectorConstraints

    Enables or disables certain behaviors and features of the selector.

    SfDiagramComponent

    Represents a comprehensive diagramming component that provides functionality for creating, editing, and rendering interactive diagrams with nodes, connectors, and various diagramming features.

    Shadow

    Represents the shadow appearance of the diagram object.

    Shape

    Represents a shape in the diagram. Shape provides the basic characteristics and behaviors of a diagram element shape.

    ShapeAnnotation

    Represents a textual annotation that can be displayed over nodes and connectors in a diagram.

    ShapeStyle

    Represents the appearance of a shape or path in a diagram.

    SizeChangedEventArgs

    Notifies when the element is resized.

    SizeChangingEventArgs

    Notifies when the element is resizing.

    SizingMode

    Specifies how to equally size the selected nodes with respect to the first selected object.

    SnapConstraints

    Enables or disables certain features of snapping.

    SnapSettings

    Represents the snap settings that customize and control the grid lines and snap behavior of the SfDiagramComponent.

    StackPanel

    Represents a DiagramContainer that arranges child elements into a single line that can be oriented horizontally or vertically.

    StraightSegment

    Represents how a straight segment can be created for a connector.

    SubTreeAlignmentType

    Specifies the collection of sub tree alignments in an organizational chart.

    Swimlane

    Represents a swimlane in a diagram, which acts as a container for multiple nodes, connectors, and groups.

    SwimlaneChild

    Represents a base class for header, phase, and lane within a swimlane.

    SwimlaneHeader

    Represents the header of a swimlane, phase, or lane.

    TextAlign

    Represents the alignment of the text inside the text block.

    TextAnnotationDirection

    Specifies the directions of the BpmnTextAnnotation from its target.

    TextChangeEventArgs

    Notifies when the label of an element undergoes editing.

    TextDecoration

    Represents the decoration of a text in the text block.

    TextElement

    Represents a TextElement which is used to display text content or annotations within diagram components.

    TextOverflow

    Specifies a value that indicates whether to render ellipses (...) to indicate text overflow.

    TextShape

    Represents the TextShape class which allows the user to draw nodes in the diagram with a shape based on text as per user preference.

    TextStyle

    Represents the appearance of the text in a diagram, providing various styling options such as boldness, color, font, and more.

    TextWrap

    Specifies how to control the overflow of text in the node boundaries. The wrapping property defines how to wrap the text.

    TickAlignment

    Controls the alignment of ticks on the ruler.

    TreeInfo

    Represents the behavior and appearance of the tree layout configuration for the Layout.

    UmlSequenceActivationBox

    Represents an activation region on a participant's lifeline in a UML sequence diagram, indicating a time period during which the participant is actively involved in processing or executing operations.

    UmlSequenceDiagramModel

    Represents a data model for creating and managing UML sequence diagrams. This model encapsulates the structural elements of a sequence diagram including actors, messages, lifelines, and their interactions over time.

    UmlSequenceFragment

    Represents a fragment in a UML sequence diagram that defines interaction blocks such as loops, conditionals, alternatives, and other control flow structures that group and control the execution of messages.

    UmlSequenceFragmentCondition

    Represents a condition within a UML sequence diagram fragment that defines guard expressions and controls the execution of specific messages within the fragment's scope.

    UmlSequenceFragmentType

    Specifies the different types of fragments used in a UML sequence diagram.

    UmlSequenceMessage

    Represents a message exchanged between participants in a UML sequence diagram. Messages define the communications, method calls, or interactions that occur between participants in chronological order, displayed as horizontal arrows connecting the participant lifelines.

    UmlSequenceMessageType

    Specifies the different types of UML message connectors used in a sequence diagram.

    UmlSequenceParticipant

    Represents a participant in the sequence diagram, such as an actor or object. Participants are the entities that interact with each other through message exchanges in the sequence diagram, displayed as vertical lifelines with headers showing their names or roles.

    UnitMode

    Specifies the type of unit mode.

    UserHandle

    Represents how to execute commonly or frequently used commands around nodes, connectors, and groups in the diagram.

    Vector

    Represents a vector that describes the length and angle between the control point and the start point of a bezier segment.

    VerticalAlignment

    Represents the alignment of the diagram elements based on its immediate parent.

    VerticalGridLines

    Represents the vertical grid lines configuration for the SfDiagramComponent.

    VerticalRuler

    Represents the vertical ruler component for the SfDiagramComponent.

    VisibleTarget

    Specifies whether the userhandle is visible for Node or Connector.

    Interfaces

    IDiagramObject

    Represents the base interface for all diagram objects in the SfDiagramComponent, providing common functionality for property change handling and object cloning.

    IDiagramPrintExportSettings

    Represents the common configuration settings for printing and exporting the diagram.

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved