Class SfOverview
It allows the user to see a preview or an overall view of the entire content of a diagram.
Inheritance
System.Object
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension
SfOverview
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfOverview : SfDiagramBaseExtension, IBaseInit, IOverview
Examples
<SfDiagram Nodes="@NodeCollection" Constraints="@DiagramConstraints" id="diagram" Height="600px">
<DiagramScrollSettings ScrollLimit = "@ScrollLimit.Infinity" />
< DiagramSnapSettings Constraints="@SnapConstraints.None"/>
<DiagramRulerSettings ShowRulers = "true" />
</ SfDiagram >
< SfOverview Width="100%" Height="150px" SourceID="diagram" />
@Code
{
//Defines diagram's nodes collection
public ObservableCollection<DiagramNode> NodeCollection = new ObservableCollection<DiagramNode>();
public DiagramConstraints DiagramConstraints = DiagramConstraints.Default;
protected override void OnInitialized()
{
DiagramNode Node = new DiagramNode()
{
Id = "group",
OffsetX = 200,
OffsetY = 200,
Width = 100,
Height = 100,
Annotations = new ObservableCollection<DiagramNodeAnnotation>()
{
new DiagramNodeAnnotation()
{
Content = "Node1",
Style = new AnnotationStyle()
{
Color = "white",
}
}
},
Style = new NodeShapeStyle() { Fill = "cornflowerblue", StrokeColor = "white" }
};
NodeCollection.Add(Node);
}
}
Constructors
SfOverview()
Declaration
Properties
ChildContent
Represents a segment of UI content, implemented.
Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.RenderFragment |
|
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Height
Defines the height of the overview
Declaration
public string Height { get; set; }
Property Value
Type |
Description |
System.String |
|
ID
Declaration
public override string ID { get; set; }
Property Value
Type |
Description |
System.String |
|
Overrides
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension.ID
jsProperty
Declaration
protected override string jsProperty { get; set; }
Property Value
Type |
Description |
System.String |
|
Overrides
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension.jsProperty
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }
Property Value
Type |
Description |
System.String |
|
nameSpace
Declaration
protected override string nameSpace { get; set; }
Property Value
Type |
Description |
System.String |
|
Overrides
Syncfusion.Blazor.Diagrams.Internal.SfDiagramBaseExtension.nameSpace
SourceID
Defines the ID of the overview
Declaration
public string SourceID { get; set; }
Property Value
Type |
Description |
System.String |
|
Width
Defines the width of the overview
Declaration
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|
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.Diagrams.Internal.SfDiagramBaseExtension.Dispose()
GetJSNamespace()
Declaration
public string GetJSNamespace()
Returns
Type |
Description |
System.String |
Get the parent namespaces
|
GetPersistData()
Get the properties to be maintained in the persisted state.
Declaration
public Task<string> GetPersistData()
Returns
Type |
Description |
System.Threading.Tasks.Task<System.String> |
|
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
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
|
UpdateHtmlLayer(Object)
Declaration
public Task UpdateHtmlLayer(object view)
Parameters
Type |
Name |
Description |
System.Object |
view |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Implements