menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IDiagram - API Reference

    Show / Hide Table of Contents

    Interface IDiagram

    This interface specifies the properties of the diagrams.

    Namespace: Syncfusion.Blazor.Diagrams
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public interface IDiagram

    Properties

    AddInfo

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

    Declaration
    object AddInfo { get; set; }
    Property Value
    Type Description
    System.Object

    AnnotationTemplate

    Customizes the annotation template.

    Declaration
    string AnnotationTemplate { get; set; }
    Property Value
    Type Description
    System.String

    BackgroundColor

    Defines the background color of the diagram.

    Declaration
    string BackgroundColor { get; set; }
    Property Value
    Type Description
    System.String

    BridgeDirection

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

    Declaration
    BridgeDirection BridgeDirection { get; set; }
    Property Value
    Type Description
    BridgeDirection

    CommandManager

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

    Declaration
    DiagramCommandManager CommandManager { get; set; }
    Property Value
    Type Description
    DiagramCommandManager

    ConnectorDefaults

    Helps to assign the default properties of connector.

    Declaration
    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
    ObservableCollection<DiagramConnector> Connectors { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<DiagramConnector>

    Constraints

    Constraints are used to enable/disable certain behaviors of the diagram, nodes, and connectors.

    Declaration
    DiagramConstraints Constraints { get; set; }
    Property Value
    Type Description
    DiagramConstraints

    ContextMenuSettings

    Defines type of menu that appears when you perform right-click operation. An object to customize the context menu of diagram.

    Declaration
    DiagramContextMenuSettings ContextMenuSettings { get; set; }
    Property Value
    Type Description
    DiagramContextMenuSettings

    CustomCursor

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

    Declaration
    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
    DiagramDataSource DataSourceSettings { get; set; }
    Property Value
    Type Description
    DiagramDataSource

    DiagramSettings

    Defines the settings of diagram.

    Declaration
    DiagramSettings DiagramSettings { get; set; }
    Property Value
    Type Description
    DiagramSettings

    DiagramTemplates

    Represents the template’s content to the node, annotation, and user handles. The User can define any HTML content as a template.

    Declaration
    DiagramTemplates DiagramTemplates { get; set; }
    Property Value
    Type Description
    DiagramTemplates

    DrawingObject

    Defines the object to be drawn using drawing tool.

    Declaration
    object DrawingObject { get; set; }
    Property Value
    Type Description
    System.Object

    EnablePersistence

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

    Declaration
    bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableRtl

    Enable or disable rendering component in right to left direction.

    Declaration
    bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    Height

    Defines the height of the diagram model.

    Declaration
    string Height { get; set; }
    Property Value
    Type Description
    System.String

    HistoryManager

    Customizes the undo redo functionality.

    Declaration
    History HistoryManager { get; set; }
    Property Value
    Type Description
    History

    Layers

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

    Declaration
    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
    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
    string Locale { get; set; }
    Property Value
    Type Description
    System.String

    Mode

    Defines the diagram rendering mode.

    Declaration
    RenderingMode Mode { get; set; }
    Property Value
    Type Description
    RenderingMode

    NodeDefaults

    Helps to assign the default properties of nodes.

    Declaration
    DiagramNode NodeDefaults { get; set; }
    Property Value
    Type Description
    DiagramNode

    Nodes

    Defines the collection of nodes.

    Declaration
    ObservableCollection<DiagramNode> Nodes { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<DiagramNode>

    NodeTemplate

    Customizes the node template.

    Declaration
    string NodeTemplate { get; set; }
    Property Value
    Type Description
    System.String

    PageSettings

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

    Declaration
    DiagramPageSettings PageSettings { get; set; }
    Property Value
    Type Description
    DiagramPageSettings

    RulerSettings

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

    Declaration
    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
    DiagramScrollSettings ScrollSettings { get; set; }
    Property Value
    Type Description
    DiagramScrollSettings

    SelectedItems

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

    Declaration
    DiagramSelectedItems SelectedItems { get; set; }
    Property Value
    Type Description
    DiagramSelectedItems

    SerializationSettings

    Defines the serialization settings of diagram.

    Declaration
    DiagramSerializationSettings SerializationSettings { get; set; }
    Property Value
    Type Description
    DiagramSerializationSettings

    SnapSettings

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

    Declaration
    DiagramSnapSettings SnapSettings { get; set; }
    Property Value
    Type Description
    DiagramSnapSettings

    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
    DiagramTooltip Tooltip { get; set; }
    Property Value
    Type Description
    DiagramTooltip

    Width

    Defines the width of the diagram model.

    Declaration
    string Width { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    updateChildProperties(String, Object)

    Declaration
    void updateChildProperties(string key, object value)
    Parameters
    Type Name Description
    System.String key
    System.Object value
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved