Class DiagramScrollSettings
Defines the current zoom value, zoom factor, scroll status and viewport size of the diagram.
Inheritance
System.Object
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension
DiagramScrollSettings
Assembly: Syncfusion.Blazor.dll
public class DiagramScrollSettings : SfDiagramBaseExtension, IBaseInit
<SfDiagram Height="600px">
//Sets the ScrollSettings for the diagram
<DiagramScrollSettings HorizontalOffset = ”100” VerticalOffset = ”100” CurrentZoom="60" ScrollLimit="ScrollLimit.Limited">
</DiagramScrollSettings>
</SfDiagram>
Constructors
Declaration
public DiagramScrollSettings()
Properties
Specifies the space between the object (Node/Connector) and the diagram edge such that, auto-scroll triggers.
Declaration
public AutoScrollMargin AutoScrollBorder { get; set; }
Property Value
<SfDiagram Height="600px">
//Sets the ScrollSettings for the diagram
<DiagramScrollSettings HorizontalOffset="100" VerticalOffset="50">
//Sets the Auto Scroll border for the diagram
<AutoScrollMargin Left="15" Bottom="15" Right="15" Top="15"></AutoScrollMargin>
</DiagramScrollSettings>
</SfDiagram>
A boolean which enables or disables auto-scroll in the diagram while dragging any diagram object.
Declaration
public bool CanAutoScroll { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ChildContent
Represents a segment of UI content, implemented.
Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.RenderFragment |
|
Gets the current zoom level. By default, CurrentZoom is set to 1.
Declaration
public double CurrentZoom { get; set; }
Property Value
Type |
Description |
System.Double |
|
Gets or sets the horizontal offset of the scroller.
Declaration
public Nullable<double> HorizontalOffset { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Double> |
|
Declaration
protected override string jsProperty { get; set; }
Property Value
Type |
Description |
System.String |
|
Overrides
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension.jsProperty
mainParent
Declaration
protected override SfDiagramBaseExtension mainParent { get; set; }
Property Value
Type |
Description |
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension |
|
Overrides
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension.mainParent
Sets maximum zoom value of the scroller. By default, MaxZoom is set to 30.
Declaration
public double MaxZoom { get; set; }
Property Value
Type |
Description |
System.Double |
|
Sets the minimum zoom value of the scroller. By default, MinZoom is set to 0.2.
Declaration
public double MinZoom { get; set; }
Property Value
Type |
Description |
System.Double |
|
Defines the maximum space between the object and the diagram viewport edge.
Declaration
public AutoScrollPadding Padding { get; set; }
Property Value
Scrolling beyond any rectangular area can be restricted by using the ScrollableArea property of scroll settings.
Declaration
public object ScrollableArea { get; set; }
Property Value
Type |
Description |
System.Object |
|
Controls and sets the scrollable region in the diagram. Scrollable Area can be set to Diagram, Limited, or Infinity.
Declaration
public ScrollLimit ScrollLimit { get; set; }
Property Value
Gets or sets the vertical offset of the scroller.
Declaration
public Nullable<double> VerticalOffset { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Double> |
|
Declaration
public Nullable<double> ViewPortHeight { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Double> |
|
Declaration
public Nullable<double> ViewPortWidth { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Double> |
|
Methods
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type |
Name |
Description |
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder |
__builder |
|
Declaration
public override void Dispose()
Overrides
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension.Dispose()
Declaration
public string GetJSNamespace()
Returns
Type |
Description |
System.String |
Get the parent namespaces
|
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
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
|
Declaration
public void updateChildProperties(string key, object value)
Parameters
Type |
Name |
Description |
System.String |
key |
|
System.Object |
value |
|