ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DiagramBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class DiagramBuilder

    Inheritance
    System.Object
    ControlBuilder
    DiagramBuilder
    Inherited Members
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Diagrams
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class DiagramBuilder : ControlBuilder

    Constructors

    DiagramBuilder()

    Declaration
    public DiagramBuilder()

    DiagramBuilder(Diagram)

    Declaration
    public DiagramBuilder(Diagram model)
    Parameters
    Type Name Description
    Diagram model

    Fields

    model

    Declaration
    public Diagram model
    Field Value
    Type Description
    Diagram

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

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

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    AddInfo(Object)

    Allows the user to save custom information/data about diagram

    Declaration
    public DiagramBuilder AddInfo(object addInfo)
    Parameters
    Type Name Description
    System.Object addInfo
    Returns
    Type Description
    DiagramBuilder

    AnimationComplete(String)

    Triggers after animation is completed for the diagram elements.

    Declaration
    public DiagramBuilder AnimationComplete(string animationComplete)
    Parameters
    Type Name Description
    System.String animationComplete
    Returns
    Type Description
    DiagramBuilder

    AnnotationTemplate(String)

    Customizes the annotation template

    Declaration
    public DiagramBuilder AnnotationTemplate(string annotationTemplate)
    Parameters
    Type Name Description
    System.String annotationTemplate
    Returns
    Type Description
    DiagramBuilder

    BackgroundColor(String)

    Defines the background color of the diagram

    Declaration
    public DiagramBuilder BackgroundColor(string backgroundColor)
    Parameters
    Type Name Description
    System.String backgroundColor
    Returns
    Type Description
    DiagramBuilder

    BridgeDirection(BridgeDirection)

    Defines the direction of the bridge that is inserted when the segments are intersected Top - Defines the direction of the bridge as Top Bottom - Defines the direction of the bridge as Bottom Left - Sets the bridge direction as left Right - Sets the bridge direction as right

    Declaration
    public DiagramBuilder BridgeDirection(BridgeDirection bridgeDirection)
    Parameters
    Type Name Description
    BridgeDirection bridgeDirection
    Returns
    Type Description
    DiagramBuilder

    Click(String)

    Triggers when a node, connector or diagram is clicked

    Declaration
    public DiagramBuilder Click(string click)
    Parameters
    Type Name Description
    System.String click
    Returns
    Type Description
    DiagramBuilder

    CollectionChange(String)

    Triggers when a node/connector is added/removed to/from the diagram.

    Declaration
    public DiagramBuilder CollectionChange(string collectionChange)
    Parameters
    Type Name Description
    System.String collectionChange
    Returns
    Type Description
    DiagramBuilder

    CommandExecute(String)

    Triggers when a command executed.

    Declaration
    public DiagramBuilder CommandExecute(string commandExecute)
    Parameters
    Type Name Description
    System.String commandExecute
    Returns
    Type Description
    DiagramBuilder

    CommandManager(DiagramCommandManager)

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

    Declaration
    public DiagramBuilder CommandManager(DiagramCommandManager commandManager)
    Parameters
    Type Name Description
    DiagramCommandManager commandManager
    Returns
    Type Description
    DiagramBuilder

    CommandManager(Action<DiagramCommandManagerBuilder>)

    Declaration
    public DiagramBuilder CommandManager(Action<DiagramCommandManagerBuilder> commandManager)
    Parameters
    Type Name Description
    System.Action<DiagramCommandManagerBuilder> commandManager
    Returns
    Type Description
    DiagramBuilder

    ConnectionChange(String)

    Triggers when the connection is changed

    Declaration
    public DiagramBuilder ConnectionChange(string connectionChange)
    Parameters
    Type Name Description
    System.String connectionChange
    Returns
    Type Description
    DiagramBuilder

    ConnectorDefaults(Object)

    Helps to assign the default properties of connector

    Declaration
    public DiagramBuilder ConnectorDefaults(object connectorDefaults)
    Parameters
    Type Name Description
    System.Object connectorDefaults
    Returns
    Type Description
    DiagramBuilder

    Connectors(Action<DiagramConnectorBuilder>)

    Declaration
    public DiagramBuilder Connectors(Action<DiagramConnectorBuilder> connectors)
    Parameters
    Type Name Description
    System.Action<DiagramConnectorBuilder> connectors
    Returns
    Type Description
    DiagramBuilder

    Connectors(List<DiagramConnector>)

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

    Declaration
    public DiagramBuilder Connectors(List<DiagramConnector> connectors)
    Parameters
    Type Name Description
    System.Collections.Generic.List<DiagramConnector> connectors
    Returns
    Type Description
    DiagramBuilder

    Constraints(DiagramConstraints)

    Constraints are used to enable/disable certain behaviors of the diagram. None - Disables DiagramConstraints constraints Bridging - Enables/Disables Bridging support for connector UndoRedo - Enables/Disables the Undo/Redo support Tooltip - Enables/Disables Tooltip support UserInteraction - Enables/Disables editing diagram interactively ApiUpdate - Enables/Disables editing diagram through code PageEditable - Enables/Disables editing diagrams both interactively and through code Zoom - Enables/Disables Zoom support for the diagram PanX - Enables/Disable PanX support for the diagram PanY - Enables/Disable PanY support for the diagram Pan - Enables/Disable Pan support the diagram

    Declaration
    public DiagramBuilder Constraints(DiagramConstraints constraints)
    Parameters
    Type Name Description
    DiagramConstraints constraints
    Returns
    Type Description
    DiagramBuilder

    ContextMenuBeforeItemRender(String)

    Triggers before rendering the context menu item

    Declaration
    public DiagramBuilder ContextMenuBeforeItemRender(string contextMenuBeforeItemRender)
    Parameters
    Type Name Description
    System.String contextMenuBeforeItemRender
    Returns
    Type Description
    DiagramBuilder

    ContextMenuClick(String)

    Triggers when a context menu item is clicked

    Declaration
    public DiagramBuilder ContextMenuClick(string contextMenuClick)
    Parameters
    Type Name Description
    System.String contextMenuClick
    Returns
    Type Description
    DiagramBuilder

    ContextMenuOpen(String)

    Triggers before opening the context menu

    Declaration
    public DiagramBuilder ContextMenuOpen(string contextMenuOpen)
    Parameters
    Type Name Description
    System.String contextMenuOpen
    Returns
    Type Description
    DiagramBuilder

    ContextMenuSettings(DiagramContextMenuSettings)

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

    Declaration
    public DiagramBuilder ContextMenuSettings(DiagramContextMenuSettings contextMenuSettings)
    Parameters
    Type Name Description
    DiagramContextMenuSettings contextMenuSettings
    Returns
    Type Description
    DiagramBuilder

    ContextMenuSettings(Action<DiagramContextMenuSettingsBuilder>)

    Declaration
    public DiagramBuilder ContextMenuSettings(Action<DiagramContextMenuSettingsBuilder> contextMenuSettings)
    Parameters
    Type Name Description
    System.Action<DiagramContextMenuSettingsBuilder> contextMenuSettings
    Returns
    Type Description
    DiagramBuilder

    Created(String)

    Triggered when the diagram is rendered completely.

    Declaration
    public DiagramBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    DiagramBuilder

    CustomCursor(Action<DiagramCustomCursorBuilder>)

    Declaration
    public DiagramBuilder CustomCursor(Action<DiagramCustomCursorBuilder> customCursor)
    Parameters
    Type Name Description
    System.Action<DiagramCustomCursorBuilder> customCursor
    Returns
    Type Description
    DiagramBuilder

    CustomCursor(List<DiagramCustomCursor>)

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

    Declaration
    public DiagramBuilder CustomCursor(List<DiagramCustomCursor> customCursor)
    Parameters
    Type Name Description
    System.Collections.Generic.List<DiagramCustomCursor> customCursor
    Returns
    Type Description
    DiagramBuilder

    DataLoaded(String)

    Triggers after diagram is populated from the external data source

    Declaration
    public DiagramBuilder DataLoaded(string dataLoaded)
    Parameters
    Type Name Description
    System.String dataLoaded
    Returns
    Type Description
    DiagramBuilder

    DataSourceSettings(DiagramDataSource)

    Configures the data source that is to be bound with diagram

    Declaration
    public DiagramBuilder DataSourceSettings(DiagramDataSource dataSourceSettings)
    Parameters
    Type Name Description
    DiagramDataSource dataSourceSettings
    Returns
    Type Description
    DiagramBuilder

    DataSourceSettings(Action<DiagramDataSourceBuilder>)

    Declaration
    public DiagramBuilder DataSourceSettings(Action<DiagramDataSourceBuilder> dataSourceSettings)
    Parameters
    Type Name Description
    System.Action<DiagramDataSourceBuilder> dataSourceSettings
    Returns
    Type Description
    DiagramBuilder

    DiagramSettings(Object)

    Represents the diagram settings

    Declaration
    public DiagramBuilder DiagramSettings(object diagramSettings)
    Parameters
    Type Name Description
    System.Object diagramSettings
    Returns
    Type Description
    DiagramBuilder

    DoubleClick(String)

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

    Declaration
    public DiagramBuilder DoubleClick(string doubleClick)
    Parameters
    Type Name Description
    System.String doubleClick
    Returns
    Type Description
    DiagramBuilder

    DragEnter(String)

    Triggers when a symbol is dragged into diagram from symbol palette

    Declaration
    public DiagramBuilder DragEnter(string dragEnter)
    Parameters
    Type Name Description
    System.String dragEnter
    Returns
    Type Description
    DiagramBuilder

    DragLeave(String)

    Triggers when a symbol is dragged outside of the diagram.

    Declaration
    public DiagramBuilder DragLeave(string dragLeave)
    Parameters
    Type Name Description
    System.String dragLeave
    Returns
    Type Description
    DiagramBuilder

    DragOver(String)

    Triggers when a symbol is dragged over diagram

    Declaration
    public DiagramBuilder DragOver(string dragOver)
    Parameters
    Type Name Description
    System.String dragOver
    Returns
    Type Description
    DiagramBuilder

    DrawingObject(Object)

    Defines the object to be drawn using drawing tool

    Declaration
    public DiagramBuilder DrawingObject(object drawingObject)
    Parameters
    Type Name Description
    System.Object drawingObject
    Returns
    Type Description
    DiagramBuilder

    Drop(String)

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

    Declaration
    public DiagramBuilder Drop(string drop)
    Parameters
    Type Name Description
    System.String drop
    Returns
    Type Description
    DiagramBuilder

    EnablePersistence(Boolean)

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

    Declaration
    public DiagramBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    DiagramBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public DiagramBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    DiagramBuilder

    ExpandStateChange(String)

    Triggers when the state of the expand and collapse icon change for a node.

    Declaration
    public DiagramBuilder ExpandStateChange(string expandStateChange)
    Parameters
    Type Name Description
    System.String expandStateChange
    Returns
    Type Description
    DiagramBuilder

    FixedUserHandleClick(String)

    Triggers when a node/connector fixedUserHandle is clicked in the diagram.

    Declaration
    public DiagramBuilder FixedUserHandleClick(string fixedUserHandleClick)
    Parameters
    Type Name Description
    System.String fixedUserHandleClick
    Returns
    Type Description
    DiagramBuilder

    GetConnectorDefaults(Object)

    Helps to return the default properties of connector

    Declaration
    public DiagramBuilder GetConnectorDefaults(object getConnectorDefaults)
    Parameters
    Type Name Description
    System.Object getConnectorDefaults
    Returns
    Type Description
    DiagramBuilder

    GetConnectorDefaults(String)

    Helps to return the default properties of connector

    Declaration
    public DiagramBuilder GetConnectorDefaults(string getConnectorDefaults)
    Parameters
    Type Name Description
    System.String getConnectorDefaults
    Returns
    Type Description
    DiagramBuilder

    GetCustomCursor(Object)

    Declaration
    public DiagramBuilder GetCustomCursor(object getCustomCursor)
    Parameters
    Type Name Description
    System.Object getCustomCursor
    Returns
    Type Description
    DiagramBuilder

    GetCustomCursor(String)

    Declaration
    public DiagramBuilder GetCustomCursor(string getCustomCursor)
    Parameters
    Type Name Description
    System.String getCustomCursor
    Returns
    Type Description
    DiagramBuilder

    GetCustomProperty(Object)

    Allows to get the custom properties that have to be serialized

    Declaration
    public DiagramBuilder GetCustomProperty(object getCustomProperty)
    Parameters
    Type Name Description
    System.Object getCustomProperty
    Returns
    Type Description
    DiagramBuilder

    GetCustomProperty(String)

    Allows to get the custom properties that have to be serialized

    Declaration
    public DiagramBuilder GetCustomProperty(string getCustomProperty)
    Parameters
    Type Name Description
    System.String getCustomProperty
    Returns
    Type Description
    DiagramBuilder

    GetCustomTool(Object)

    Declaration
    public DiagramBuilder GetCustomTool(object getCustomTool)
    Parameters
    Type Name Description
    System.Object getCustomTool
    Returns
    Type Description
    DiagramBuilder

    GetCustomTool(String)

    Declaration
    public DiagramBuilder GetCustomTool(string getCustomTool)
    Parameters
    Type Name Description
    System.String getCustomTool
    Returns
    Type Description
    DiagramBuilder

    GetDescription(Object)

    Declaration
    public DiagramBuilder GetDescription(object getDescription)
    Parameters
    Type Name Description
    System.Object getDescription
    Returns
    Type Description
    DiagramBuilder

    GetDescription(String)

    Declaration
    public DiagramBuilder GetDescription(string getDescription)
    Parameters
    Type Name Description
    System.String getDescription
    Returns
    Type Description
    DiagramBuilder

    GetNodeDefaults(Object)

    Helps to return the default properties of node

    Declaration
    public DiagramBuilder GetNodeDefaults(object getNodeDefaults)
    Parameters
    Type Name Description
    System.Object getNodeDefaults
    Returns
    Type Description
    DiagramBuilder

    GetNodeDefaults(String)

    Helps to return the default properties of node

    Declaration
    public DiagramBuilder GetNodeDefaults(string getNodeDefaults)
    Parameters
    Type Name Description
    System.String getNodeDefaults
    Returns
    Type Description
    DiagramBuilder

    Height(Double)

    Defines the height of the diagram model.

    Declaration
    public DiagramBuilder Height(double height)
    Parameters
    Type Name Description
    System.Double height
    Returns
    Type Description
    DiagramBuilder

    Height(String)

    Defines the height of the diagram model.

    Declaration
    public DiagramBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    DiagramBuilder

    HistoryChange(String)

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

    Declaration
    public DiagramBuilder HistoryChange(string historyChange)
    Parameters
    Type Name Description
    System.String historyChange
    Returns
    Type Description
    DiagramBuilder

    HistoryManager(Object)

    Customizes the undo redo functionality

    Declaration
    public DiagramBuilder HistoryManager(object historyManager)
    Parameters
    Type Name Description
    System.Object historyManager
    Returns
    Type Description
    DiagramBuilder

    HistoryStateChange(String)

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

    Declaration
    public DiagramBuilder HistoryStateChange(string historyStateChange)
    Parameters
    Type Name Description
    System.String historyStateChange
    Returns
    Type Description
    DiagramBuilder

    HtmlAttributes(Object)

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    public DiagramBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    DiagramBuilder

    KeyDown(String)

    Triggers when a user is pressing a key.

    Declaration
    public DiagramBuilder KeyDown(string keyDown)
    Parameters
    Type Name Description
    System.String keyDown
    Returns
    Type Description
    DiagramBuilder

    KeyUp(String)

    Triggers when a user releases a key.

    Declaration
    public DiagramBuilder KeyUp(string keyUp)
    Parameters
    Type Name Description
    System.String keyUp
    Returns
    Type Description
    DiagramBuilder

    Layers(Action<DiagramLayerBuilder>)

    Declaration
    public DiagramBuilder Layers(Action<DiagramLayerBuilder> layers)
    Parameters
    Type Name Description
    System.Action<DiagramLayerBuilder> layers
    Returns
    Type Description
    DiagramBuilder

    Layers(List<DiagramLayer>)

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

    Declaration
    public DiagramBuilder Layers(List<DiagramLayer> layers)
    Parameters
    Type Name Description
    System.Collections.Generic.List<DiagramLayer> layers
    Returns
    Type Description
    DiagramBuilder

    Layout(DiagramLayout)

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

    Declaration
    public DiagramBuilder Layout(DiagramLayout layout)
    Parameters
    Type Name Description
    DiagramLayout layout
    Returns
    Type Description
    DiagramBuilder

    Layout(Action<DiagramLayoutBuilder>)

    Declaration
    public DiagramBuilder Layout(Action<DiagramLayoutBuilder> layout)
    Parameters
    Type Name Description
    System.Action<DiagramLayoutBuilder> layout
    Returns
    Type Description
    DiagramBuilder

    Locale(String)

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

    Declaration
    public DiagramBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    DiagramBuilder

    Mode(RenderingMode)

    Defines the diagram rendering mode. SVG - Renders the diagram objects as SVG elements Canvas - Renders the diagram in a canvas

    Declaration
    public DiagramBuilder Mode(RenderingMode mode)
    Parameters
    Type Name Description
    RenderingMode mode
    Returns
    Type Description
    DiagramBuilder

    MouseEnter(String)

    Triggered when mouse enters a node/connector.

    Declaration
    public DiagramBuilder MouseEnter(string mouseEnter)
    Parameters
    Type Name Description
    System.String mouseEnter
    Returns
    Type Description
    DiagramBuilder

    MouseLeave(String)

    Triggered when mouse leaves node/connector.

    Declaration
    public DiagramBuilder MouseLeave(string mouseLeave)
    Parameters
    Type Name Description
    System.String mouseLeave
    Returns
    Type Description
    DiagramBuilder

    MouseOver(String)

    Triggered when mouse hovers a node/connector.

    Declaration
    public DiagramBuilder MouseOver(string mouseOver)
    Parameters
    Type Name Description
    System.String mouseOver
    Returns
    Type Description
    DiagramBuilder

    NodeDefaults(Object)

    Helps to assign the default properties of nodes

    Declaration
    public DiagramBuilder NodeDefaults(object nodeDefaults)
    Parameters
    Type Name Description
    System.Object nodeDefaults
    Returns
    Type Description
    DiagramBuilder

    Nodes(Action<DiagramNodeBuilder>)

    Declaration
    public DiagramBuilder Nodes(Action<DiagramNodeBuilder> nodes)
    Parameters
    Type Name Description
    System.Action<DiagramNodeBuilder> nodes
    Returns
    Type Description
    DiagramBuilder

    Nodes(List<DiagramNode>)

    Defines the collection of nodes

    Declaration
    public DiagramBuilder Nodes(List<DiagramNode> nodes)
    Parameters
    Type Name Description
    System.Collections.Generic.List<DiagramNode> nodes
    Returns
    Type Description
    DiagramBuilder

    NodeTemplate(String)

    Customizes the node template

    Declaration
    public DiagramBuilder NodeTemplate(string nodeTemplate)
    Parameters
    Type Name Description
    System.String nodeTemplate
    Returns
    Type Description
    DiagramBuilder

    OnImageLoad(String)

    Triggers when the image node is loaded.

    Declaration
    public DiagramBuilder OnImageLoad(string onImageLoad)
    Parameters
    Type Name Description
    System.String onImageLoad
    Returns
    Type Description
    DiagramBuilder

    OnUserHandleMouseDown(String)

    Triggers when a mouseDown on the user handle.

    Declaration
    public DiagramBuilder OnUserHandleMouseDown(string onUserHandleMouseDown)
    Parameters
    Type Name Description
    System.String onUserHandleMouseDown
    Returns
    Type Description
    DiagramBuilder

    OnUserHandleMouseEnter(String)

    Triggers when a mouseEnter on the user handle.

    Declaration
    public DiagramBuilder OnUserHandleMouseEnter(string onUserHandleMouseEnter)
    Parameters
    Type Name Description
    System.String onUserHandleMouseEnter
    Returns
    Type Description
    DiagramBuilder

    OnUserHandleMouseLeave(String)

    Triggers when a mouseLeave on the user handle.

    Declaration
    public DiagramBuilder OnUserHandleMouseLeave(string onUserHandleMouseLeave)
    Parameters
    Type Name Description
    System.String onUserHandleMouseLeave
    Returns
    Type Description
    DiagramBuilder

    OnUserHandleMouseUp(String)

    Triggers when a mouseUp on the user handle.

    Declaration
    public DiagramBuilder OnUserHandleMouseUp(string onUserHandleMouseUp)
    Parameters
    Type Name Description
    System.String onUserHandleMouseUp
    Returns
    Type Description
    DiagramBuilder

    PageSettings(DiagramPageSettings)

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

    Declaration
    public DiagramBuilder PageSettings(DiagramPageSettings pageSettings)
    Parameters
    Type Name Description
    DiagramPageSettings pageSettings
    Returns
    Type Description
    DiagramBuilder

    PageSettings(Action<DiagramPageSettingsBuilder>)

    Declaration
    public DiagramBuilder PageSettings(Action<DiagramPageSettingsBuilder> pageSettings)
    Parameters
    Type Name Description
    System.Action<DiagramPageSettingsBuilder> pageSettings
    Returns
    Type Description
    DiagramBuilder

    PositionChange(String)

    Triggers while dragging the elements in diagram

    Declaration
    public DiagramBuilder PositionChange(string positionChange)
    Parameters
    Type Name Description
    System.String positionChange
    Returns
    Type Description
    DiagramBuilder

    PropertyChange(String)

    Triggers once the node or connector property changed.

    Declaration
    public DiagramBuilder PropertyChange(string propertyChange)
    Parameters
    Type Name Description
    System.String propertyChange
    Returns
    Type Description
    DiagramBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    RotateChange(String)

    Triggers when the diagram elements are rotated

    Declaration
    public DiagramBuilder RotateChange(string rotateChange)
    Parameters
    Type Name Description
    System.String rotateChange
    Returns
    Type Description
    DiagramBuilder

    RulerSettings(DiagramRulerSettings)

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

    Declaration
    public DiagramBuilder RulerSettings(DiagramRulerSettings rulerSettings)
    Parameters
    Type Name Description
    DiagramRulerSettings rulerSettings
    Returns
    Type Description
    DiagramBuilder

    RulerSettings(Action<DiagramRulerSettingsBuilder>)

    Declaration
    public DiagramBuilder RulerSettings(Action<DiagramRulerSettingsBuilder> rulerSettings)
    Parameters
    Type Name Description
    System.Action<DiagramRulerSettingsBuilder> rulerSettings
    Returns
    Type Description
    DiagramBuilder

    ScrollChange(String)

    Triggers when the diagram is zoomed or panned

    Declaration
    public DiagramBuilder ScrollChange(string scrollChange)
    Parameters
    Type Name Description
    System.String scrollChange
    Returns
    Type Description
    DiagramBuilder

    ScrollSettings(DiagramScrollSettings)

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

    Declaration
    public DiagramBuilder ScrollSettings(DiagramScrollSettings scrollSettings)
    Parameters
    Type Name Description
    DiagramScrollSettings scrollSettings
    Returns
    Type Description
    DiagramBuilder

    ScrollSettings(Action<DiagramScrollSettingsBuilder>)

    Declaration
    public DiagramBuilder ScrollSettings(Action<DiagramScrollSettingsBuilder> scrollSettings)
    Parameters
    Type Name Description
    System.Action<DiagramScrollSettingsBuilder> scrollSettings
    Returns
    Type Description
    DiagramBuilder

    SegmentCollectionChange(String)

    Triggers when a segment is added/removed to/from the connector.

    Declaration
    public DiagramBuilder SegmentCollectionChange(string segmentCollectionChange)
    Parameters
    Type Name Description
    System.String segmentCollectionChange
    Returns
    Type Description
    DiagramBuilder

    SelectedItems(DiagramSelector)

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

    Declaration
    public DiagramBuilder SelectedItems(DiagramSelector selectedItems)
    Parameters
    Type Name Description
    DiagramSelector selectedItems
    Returns
    Type Description
    DiagramBuilder

    SelectedItems(Action<DiagramSelectorBuilder>)

    Declaration
    public DiagramBuilder SelectedItems(Action<DiagramSelectorBuilder> selectedItems)
    Parameters
    Type Name Description
    System.Action<DiagramSelectorBuilder> selectedItems
    Returns
    Type Description
    DiagramBuilder

    SelectionChange(String)

    Triggers when the selection is changed in diagram

    Declaration
    public DiagramBuilder SelectionChange(string selectionChange)
    Parameters
    Type Name Description
    System.String selectionChange
    Returns
    Type Description
    DiagramBuilder

    SerializationSettings(DiagramSerializationSettings)

    Defines the serialization settings of diagram.

    Declaration
    public DiagramBuilder SerializationSettings(DiagramSerializationSettings serializationSettings)
    Parameters
    Type Name Description
    DiagramSerializationSettings serializationSettings
    Returns
    Type Description
    DiagramBuilder

    SerializationSettings(Action<DiagramSerializationSettingsBuilder>)

    Declaration
    public DiagramBuilder SerializationSettings(Action<DiagramSerializationSettingsBuilder> serializationSettings)
    Parameters
    Type Name Description
    System.Action<DiagramSerializationSettingsBuilder> serializationSettings
    Returns
    Type Description
    DiagramBuilder

    SetNodeTemplate(Object)

    setNodeTemplate helps to customize the content of a node

    function setNodeTemplate() { setNodeTemplate: (obj: NodeModel, diagram: Diagram): StackPanel => { if (obj.id === 'node2') { let table: StackPanel = new StackPanel(); table.orientation = 'Horizontal'; let column1: StackPanel = new StackPanel(); column1.children = []; column1.children.push(getTextElement('Column1')); addRows(column1); let column2: StackPanel = new StackPanel(); column2.children = []; column2.children.push(getTextElement('Column2')); addRows(column2); table.children = [column1, column2]; return table; } return null; } ... }

    Declaration
    public DiagramBuilder SetNodeTemplate(object setNodeTemplate)
    Parameters
    Type Name Description
    System.Object setNodeTemplate
    Returns
    Type Description
    DiagramBuilder

    SetNodeTemplate(String)

    setNodeTemplate helps to customize the content of a node

    function setNodeTemplate() { setNodeTemplate: (obj: NodeModel, diagram: Diagram): StackPanel => { if (obj.id === 'node2') { let table: StackPanel = new StackPanel(); table.orientation = 'Horizontal'; let column1: StackPanel = new StackPanel(); column1.children = []; column1.children.push(getTextElement('Column1')); addRows(column1); let column2: StackPanel = new StackPanel(); column2.children = []; column2.children.push(getTextElement('Column2')); addRows(column2); table.children = [column1, column2]; return table; } return null; } ... }

    Declaration
    public DiagramBuilder SetNodeTemplate(string setNodeTemplate)
    Parameters
    Type Name Description
    System.String setNodeTemplate
    Returns
    Type Description
    DiagramBuilder

    SizeChange(String)

    Triggers when a node is resized

    Declaration
    public DiagramBuilder SizeChange(string sizeChange)
    Parameters
    Type Name Description
    System.String sizeChange
    Returns
    Type Description
    DiagramBuilder

    SnapSettings(DiagramSnapSettings)

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

    Declaration
    public DiagramBuilder SnapSettings(DiagramSnapSettings snapSettings)
    Parameters
    Type Name Description
    DiagramSnapSettings snapSettings
    Returns
    Type Description
    DiagramBuilder

    SnapSettings(Action<DiagramSnapSettingsBuilder>)

    Declaration
    public DiagramBuilder SnapSettings(Action<DiagramSnapSettingsBuilder> snapSettings)
    Parameters
    Type Name Description
    System.Action<DiagramSnapSettingsBuilder> snapSettings
    Returns
    Type Description
    DiagramBuilder

    SourcePointChange(String)

    Triggers when the connector's source point is changed

    Declaration
    public DiagramBuilder SourcePointChange(string sourcePointChange)
    Parameters
    Type Name Description
    System.String sourcePointChange
    Returns
    Type Description
    DiagramBuilder

    TargetPointChange(String)

    Triggers when the connector's target point is changed

    Declaration
    public DiagramBuilder TargetPointChange(string targetPointChange)
    Parameters
    Type Name Description
    System.String targetPointChange
    Returns
    Type Description
    DiagramBuilder

    TextEdit(String)

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

    Declaration
    public DiagramBuilder TextEdit(string textEdit)
    Parameters
    Type Name Description
    System.String textEdit
    Returns
    Type Description
    DiagramBuilder

    Tool(DiagramTools)

    Defines the precedence of the interactive tools. They are, None - Disables selection, zooming and drawing tools SingleSelect - Enables/Disables single select support for the diagram MultipleSelect - Enables/Disable MultipleSelect select support for the diagram ZoomPan - Enables/Disable ZoomPan support for the diagram DrawOnce - Enables/Disable ContinuousDraw support for the diagram ContinuousDraw - Enables/Disable ContinuousDraw support for the diagram

    Declaration
    public DiagramBuilder Tool(DiagramTools tool)
    Parameters
    Type Name Description
    DiagramTools tool
    Returns
    Type Description
    DiagramBuilder

    Tooltip(DiagramDiagramTooltip)

    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 DiagramBuilder Tooltip(DiagramDiagramTooltip tooltip)
    Parameters
    Type Name Description
    DiagramDiagramTooltip tooltip
    Returns
    Type Description
    DiagramBuilder

    Tooltip(Action<DiagramDiagramTooltipBuilder>)

    Declaration
    public DiagramBuilder Tooltip(Action<DiagramDiagramTooltipBuilder> tooltip)
    Parameters
    Type Name Description
    System.Action<DiagramDiagramTooltipBuilder> tooltip
    Returns
    Type Description
    DiagramBuilder

    UpdateSelection(Object)

    Helps to set the undo and redo node selection

    Declaration
    public DiagramBuilder UpdateSelection(object updateSelection)
    Parameters
    Type Name Description
    System.Object updateSelection
    Returns
    Type Description
    DiagramBuilder

    UpdateSelection(String)

    Helps to set the undo and redo node selection

    Declaration
    public DiagramBuilder UpdateSelection(string updateSelection)
    Parameters
    Type Name Description
    System.String updateSelection
    Returns
    Type Description
    DiagramBuilder

    UserHandleTemplate(String)

    This property represents the template content of a user handle. The user can define any HTML element as a template.

    Declaration
    public DiagramBuilder UserHandleTemplate(string userHandleTemplate)
    Parameters
    Type Name Description
    System.String userHandleTemplate
    Returns
    Type Description
    DiagramBuilder

    Width(Double)

    Defines the width of the diagram model.

    Declaration
    public DiagramBuilder Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    DiagramBuilder

    Width(String)

    Defines the width of the diagram model.

    Declaration
    public DiagramBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    DiagramBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved