Class PageSettings
Defines the size and appearance of diagram page.
Inherited Members
Namespace: Syncfusion.JavaScript.DataVisualization.Models.Diagram
Assembly: Syncfusion.EJ.dll
Syntax
public class PageSettings : EJTagHelper
Constructors
PageSettings()
Declaration
public PageSettings()
Properties
AutoScrollBorder
Gets or sets the maximum distance to be left between the object and the scroll bar to trigger auto scrolling
Declaration
[JsonProperty("autoScrollBorder")]
public AutoScrollBorder AutoScrollBorder { get; set; }
Property Value
Type | Description |
---|---|
AutoScrollBorder | AutoScrollBorder |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.AutoScrollBorder = new AutoScrollBorder() { Left = 10, Right = 10, Bottom = 10, Top = 10 };
BoundaryConstraints
Gets or sets the draggable region of diagram elements.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("boundaryConstraints")]
public BoundaryConstraints BoundaryConstraints { get; set; }
Property Value
Type | Description |
---|---|
BoundaryConstraints | ScrollLimit.Infinity |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.ScrollLimit = ScrollLimit.Diagram
MultiplePage
Gets or sets whether multiple pages can be created to fit all nodes and connectors
Declaration
[JsonProperty("multiplePage")]
public bool MultiplePage { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | false |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.MultiplePage = false;
PageBackgroundColor
Gets or sets the background color of diagram pages
Declaration
[JsonProperty("pageBackgroundColor")]
public string PageBackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | "#ffffff" |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.PageBackgroundColor = "red";
PageBorderColor
Gets or sets the page border color
Declaration
[JsonProperty("pageBorderColor")]
public string PageBorderColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | "#565656" |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.PageBorderColor = "red";
Model.PageSettings.PageBorderWidth = 2;
PageBorderWidth
Gets or sets the border width of diagram pages
Declaration
[JsonProperty("pageBorderWidth")]
public double PageBorderWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double | 0 |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.PageBorderColor = "red";
Model.PageSettings.PageBorderWidth = 2;
PageHeight
Gets or sets the height of a page
Declaration
[JsonProperty("pageHeight")]
public double PageHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Double | null |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.PageHeight = 300;
PageMargin
Gets or sets the page margin
Declaration
[JsonProperty("pageMargin")]
public double PageMargin { get; set; }
Property Value
Type | Description |
---|---|
System.Double | 24 |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.PageMargin = 30;
PageOrientation
Gets or sets the orientation of the page.
Declaration
[JsonProperty("pageOrientation")]
[JsonConverter(typeof(StringEnumConverter))]
public PageOrientation PageOrientation { get; set; }
Property Value
Type | Description |
---|---|
PageOrientation | PageOrientations.Portrait |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.PageOrientation = PageOrientation.Landscape;
PageWidth
Gets or sets the height of a diagram page
Declaration
[JsonProperty("pageWidth")]
public double PageWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double | null |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.PageWidth = 400;
ScrollableArea
Gets or sets the scrollable area of diagram. Applicable, if the scroll limit is "limited".
Declaration
[JsonProperty("scrollableArea")]
public ScrollableArea ScrollableArea { get; set; }
Property Value
Type | Description |
---|---|
ScrollableArea | null |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.ScrollableArea = new ScrollableArea() { Height = 800, Width = 2000, X = 0, Y = 0 };
ScrollLimit
Gets or sets the scrollable region of diagram.
Declaration
[JsonProperty("scrollLimit")]
[JsonConverter(typeof(StringEnumConverter))]
public ScrollLimit ScrollLimit { get; set; }
Property Value
Type | Description |
---|---|
ScrollLimit | ScrollLimit.Infinity |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.ScrollLimit = ScrollLimit.Diagram
ShowPageBreak
Gets or sets the page breaks
Declaration
[JsonProperty("showPageBreak")]
public bool ShowPageBreak { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | false |
Examples
DiagramProperties Model = new DiagramProperties();
Model.PageSettings.ShowPageBreak = false;