Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DiagramSnapSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class DiagramSnapSettings

    Customizes and controls the gridlines and snap behavior of the diagram.

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    Syncfusion.Blazor.SfBaseExtension
    DiagramSnapSettings
    Namespace: Syncfusion.Blazor.Diagrams
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class DiagramSnapSettings : SfBaseExtension
    Examples
    <SfDiagram Height="600px">
       // Shows horizontal gridlines
       <DiagramSnapSettings Constraints = SnapConstraints.ShowLines SnapAngle="10">
           <HorizontalGridlines LineColor = "blue" LineDashArray="2,2">
           </HorizontalGridlines>
           <VerticalGridlines LineColor = "blue" LineDashArray="2,2">
           </VerticalGridlines>
       </DiagramSnapSettings>
    </SfDiagram>

    Constructors

    DiagramSnapSettings()

    Declaration
    public DiagramSnapSettings()

    Properties

    ChildContent

    Represents a segment of UI content, implemented.

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    Constraints

    Enables or disables features of gridlines and SnapSettings.

    Declaration
    public SnapConstraints Constraints { get; set; }
    Property Value
    Type Description
    SnapConstraints

    GridType

    Defines the diagram Grid pattern.

    Declaration
    public GridType GridType { get; set; }
    Property Value
    Type Description
    GridType
    Remarks

    The GridType can be set to lines or dots. By default, the GridType is set to lines.

    HorizontalGridlines

    Defines the pattern of horizontal gridlines

    Declaration
    public HorizontalGridlines HorizontalGridlines { get; set; }
    Property Value
    Type Description
    HorizontalGridlines

    jsProperty

    Declaration
    protected override string jsProperty { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    Syncfusion.Blazor.SfBaseExtension.jsProperty

    mainParent

    Declaration
    protected override SfBaseExtension mainParent { get; set; }
    Property Value
    Type Description
    Syncfusion.Blazor.SfBaseExtension
    Overrides
    Syncfusion.Blazor.SfBaseExtension.mainParent

    SnapAngle

    SnapAngle defines the angle by which the object needs to be rotated. By default, 5.

    Declaration
    public double SnapAngle { get; set; }
    Property Value
    Type Description
    System.Double

    SnapObjectDistance

    Defines the minimum distance between the selected object and the nearest object. By default, 5.

    Declaration
    public double SnapObjectDistance { get; set; }
    Property Value
    Type Description
    System.Double
    Examples
    <SfDiagram>
     <DiagramSnapSettings SnapObjectDistance="10">
     </DiagramSnapSettings>
    </SfDiagram>

    VerticalGridlines

    Defines the pattern of vertical gridlines.

    Declaration
    public VerticalGridlines VerticalGridlines { get; set; }
    Property Value
    Type Description
    VerticalGridlines

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    Dispose()

    Declaration
    public override void Dispose()
    Overrides
    Syncfusion.Blazor.SfBaseExtension.Dispose()

    GetJSNamespace()

    Declaration
    public string GetJSNamespace()
    Returns
    Type Description
    System.String

    Get the parent namespaces

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    Returns asynchronous operation when the component is ready to start, having received its initial parameters from its parent in the render tree

    Overrides
    Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    Returns asynchronous operation when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties

    updateChildProperties(String, Object)

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