Blazor

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

    Show / Hide Table of Contents

    Class DiagramRulerSettings

    The diagram has vertical and horizontal rulers that show measurements at the scale objects like nodes etc.,

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    Syncfusion.Blazor.SfBaseExtension
    DiagramRulerSettings
    Namespace: Syncfusion.Blazor.Diagrams
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class DiagramRulerSettings : SfBaseExtension
    Remarks
    The ShowRulers should be set to true in DiagramRulerSettings, to make the rulers visible
    Examples
     <SfDiagram Nodes="@NodeCollection">
    <DiagramRulerSettings ShowRulers = true HorizontalRuler="@Horizontal"></DiagramRulerSettings>
    </SfDiagram>
    @code{
       HorizontalRuler Horizontal = new HorizontalRuler()
       {
           SegmentWidth = 50,
           Orientation = RulerOrientation.Horizontal,
           Interval = 10
       };
    }

    Constructors

    DiagramRulerSettings()

    Declaration
    public DiagramRulerSettings()

    Properties

    ChildContent

    Represents a segment of UI content, implemented.

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

    DynamicGrid

    The Dynamic Grid allows user to create dynamic responsive grid lines and sets the gridlines can be relative to the ruler ticks or not.

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

    HorizontalRuler

    Defines the properties of the horizontal ruler.

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

    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

    ShowRulers

    A Boolean type which enables or disables ruler both horizontally and vertically. By default, ShowRulers is set to false.

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

    VerticalRuler

    Defines the properties of the vertical ruler.

    Declaration
    public VerticalRuler VerticalRuler { get; set; }
    Property Value
    Type Description
    VerticalRuler
    Examples
    <SfDiagram>
    <DiagramRulerSettings HorizontalRuler="@Vertical">
    </ DiagramRulerSettings>
    </SfDiagram>
     VerticalRuler Vertical = new VerticalRuler()
     {
       SegmentWidth = 50,
       Thickness = 10,
       Interval = 10
     };

    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