Page settings in React Diagram component
30 Jan 202324 minutes to read
Page settings enable to customize the appearance, width, and height of the diagram page.
Page size and appearance
-
The size and appearance of the diagram pages can be customized with the page settings property.
-
The
widthandheightproperties of page settings define the size of the page and based on the size, theorientationwill be set for the page. In addition to that, the appearance of the page can be customized withsourceand set of appearance specific properties. -
The
colorproperty is used to customize the background color and border color of the page. -
The
marginproperty is used to define the page margin. -
To explore those properties, refer to
Page Settings.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { DiagramComponent } from "@syncfusion/ej2-react-diagrams";
let connector = [{
id: 'connector1',
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7',
strokeWidth: 2
},
targetDecorator: {
style: {
fill: '#6BA5D7',
strokeColor: '#6BA5D7'
}
},
sourceID: 'node1',
targetID: 'node2',
}];
let node = [{
id: 'node1',
width: 100,
height: 100,
offsetX: 100,
offsetY: 100,
annotations: [{
content: 'Node1'
}]
}, {
id: 'node2',
width: 100,
height: 100,
offsetX: 300,
offsetY: 350,
annotations: [{
content: 'Node3'
}]
}];
function App() {
return (<DiagramComponent id="container" width={'100%'} height={'600px'} getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}} nodes={node} connectors={connector}
// Defines the pageSettings for the diagram
pageSettings={{
// Sets the PageOrientation for the diagram to page
orientation: 'Landscape',
// Sets the Page Break for diagram
showPageBreaks: true,
// Defines the background color and image of diagram
background: {
color: 'grey',
},
// Sets the width for the Page
width: 300,
// Sets the height for the Page
height: 300,
// Sets the space to be left between an annotation and its parent node/connector
margin: {
left: 10,
top: 10,
bottom: 10,
},
}}/>);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);import * as React from "react";
import * as ReactDOM from "react-dom";
import {
Diagram,
DiagramComponent,
ConnectorModel,
NodeModel
} from "@syncfusion/ej2-react-diagrams";
let connector: ConnectorModel[] = [{
id: 'connector1',
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7',
strokeWidth: 2
},
targetDecorator: {
style: {
fill: '#6BA5D7',
strokeColor: '#6BA5D7'
}
},
sourceID: 'node1',
targetID: 'node2',
}];
let node: NodeModel[] = [{
id: 'node1',
width: 100,
height: 100,
offsetX: 100,
offsetY: 100,
annotations: [{
content: 'Node1'
}]
}, {
id: 'node2',
width: 100,
height: 100,
offsetX: 300,
offsetY: 350,
annotations: [{
content: 'Node3'
}]
}];
function App() {
return (
<DiagramComponent
id="container"
width={'100%'}
height={'600px'}
getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}}
nodes={node}
connectors={connector}
// Defines the pageSettings for the diagram
pageSettings={{
// Sets the PageOrientation for the diagram to page
orientation: 'Landscape',
// Sets the Page Break for diagram
showPageBreaks: true,
// Defines the background color and image of diagram
background: {
color: 'grey',
},
// Sets the width for the Page
width: 300,
// Sets the height for the Page
height: 300,
// Sets the space to be left between an annotation and its parent node/connector
margin: {
left: 10,
top: 10,
bottom: 10,
},
}}
/>
);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);Set background image
Stretch and align the background image anywhere over the diagram area. The source property of background allows you to set the path of the image. The scale and the align properties help to stretch/align the background images.
The following code illustrates how to stretch and align the background image.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { DiagramComponent } from "@syncfusion/ej2-react-diagrams";
function App() {
return (<DiagramComponent id="container" width={'100%'} height={'600px'} getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}} nodes={node} connectors={connector}
// Defines the pageSettings for the diagram
pageSettings={{
orientation: 'Landscape',
showPageBreaks: true,
// Defines the background Image source
background: {
source: 'https://www.w3schools.com/images/w3schools_green.jpg',
// Defines the scale values for the background image
scale: 'Meet',
// Defines the align values for the background image
align: 'XMinYMin'
},
width: 300,
height: 300,
margin: {
left: 10,
top: 10,
bottom: 10
},
}}/>);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);import * as React from "react";
import * as ReactDOM from "react-dom";
import {
Diagram,
DiagramComponent
} from "@syncfusion/ej2-react-diagrams";
function App() {
return (
<DiagramComponent
id="container"
width={'100%'}
height={'600px'}
getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}}
// Defines the pageSettings for the diagram
pageSettings = {
{
orientation: 'Landscape',
showPageBreaks: true,
// Defines the background Image source
background: {
source: 'https://www.w3schools.com/images/w3schools_green.jpg',
// Defines the scale values for the background image
scale: 'Meet',
// Defines the align values for the background image
align: 'XMinYMin'
},
width: 300,
height: 300,
margin: {
left: 10,
top: 10,
bottom: 10
},
}
}
/>
);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);Multiple page and page breaks
When multiple page is enabled, the size of the page dynamically increases or decreases in multiples of page width and height and completely fits diagram within the page boundaries. Page breaks is used as a visual guide to see how pages are split into multiple pages.
The multiplePage and showPageBreak properties of page settings allow you to enable/disable multiple pages and page breaks respectively. The following code illustrates how to enable multiple page and page break lines.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { DiagramComponent } from "@syncfusion/ej2-react-diagrams";
let connector = [{
id: 'connector1',
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7',
strokeWidth: 2
},
targetDecorator: {
style: {
fill: '#6BA5D7',
strokeColor: '#6BA5D7'
}
},
sourceID: 'node1',
targetID: 'node2',
}];
let node = [{
id: 'node1',
width: 100,
height: 100,
offsetX: 100,
offsetY: 100,
annotations: [{
content: 'Node1'
}]
},
{
id: 'node2',
width: 100,
height: 100,
offsetX: 300,
offsetY: 350,
annotations: [{
content: 'Node2'
}]
}
];
function App() {
return (<DiagramComponent id="container" width={'100%'} height={'600px'} getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}} nodes={node} connectors={connector}
// Defines the pageSettings for the diagram
pageSettings={{
orientation: 'Landscape',
// Sets the Multiple page for diagram
multiplePage: true,
// Sets the Page Break for diagram
showPageBreaks: true,
width: 300,
height: 300,
margin: {
left: 10,
top: 10,
bottom: 10
},
}}/>);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);import * as React from "react";
import * as ReactDOM from "react-dom";
import {
Diagram,
DiagramComponent,
ConnectorModel,
NodeModel
} from "@syncfusion/ej2-react-diagrams";
let connector: ConnectorModel[] = [{
id: 'connector1',
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7',
strokeWidth: 2
},
targetDecorator: {
style: {
fill: '#6BA5D7',
strokeColor: '#6BA5D7'
}
},
sourceID: 'node1',
targetID: 'node2',
}];
let node: NodeModel[] = [{
id: 'node1',
width: 100,
height: 100,
offsetX: 100,
offsetY: 100,
annotations: [{
content: 'Node1'
}]
},
{
id: 'node2',
width: 100,
height: 100,
offsetX: 300,
offsetY: 350,
annotations: [{
content: 'Node2'
}]
}
];
function App() {
return (
<DiagramComponent
id="container"
width={'100%'}
height={'600px'}
getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}}
nodes={node}
connectors={connector}
// Defines the pageSettings for the diagram
pageSettings = {
{
orientation: 'Landscape',
// Sets the Multiple page for diagram
multiplePage: true,
// Sets the Page Break for diagram
showPageBreaks: true,
width: 300,
height: 300,
margin: {
left: 10,
top: 10,
bottom: 10
},
}
}
/>
);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);Boundary constraints
The diagram provides support to restrict/customize the interactive region, out of which the elements cannot be dragged, resized, or rotated. The boundaryConstraints property of page settings allows you to customize the interactive region. To explore the boundary constraints, refer to Boundary Constraints.
The following code example illustrates how to define boundary constraints with respect to the page.
import * as React from "react";
import * as ReactDOM from "react-dom";
import { DiagramComponent } from "@syncfusion/ej2-react-diagrams";
let connector = [{
id: 'connector1',
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7',
strokeWidth: 2
},
targetDecorator: {
style: {
fill: '#6BA5D7',
strokeColor: '#6BA5D7'
}
},
sourcePoint: {
x: 300,
y: 100
},
targetPoint: {
x: 400,
y: 100
}
}];
let node = [{
id: 'node1',
width: 150,
height: 100,
offsetX: 100,
offsetY: 100,
}, {
id: 'node2',
width: 80,
height: 130,
offsetX: 200,
offsetY: 200,
}];
function App() {
return (<DiagramComponent id="container" width={'100%'} height={'600px'} getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}} nodes={node} connectors={connector}
// Defines the pageSettings for the diagram
pageSettings={{
// Sets the BoundaryConstraints to page
boundaryConstraints: 'Page',
background: {
color: 'grey'
},
width: 400,
height: 400,
showPageBreaks: true,
}}/>);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);import * as React from "react";
import * as ReactDOM from "react-dom";
import {
Diagram,
DiagramComponent,
ConnectorModel,
NodeModel,
BoundaryConstraints
} from "@syncfusion/ej2-react-diagrams";
let connector: ConnectorModel[] = [{
id: 'connector1',
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7',
strokeWidth: 2
},
targetDecorator: {
style: {
fill: '#6BA5D7',
strokeColor: '#6BA5D7'
}
},
sourcePoint: {
x: 300,
y: 100
},
targetPoint: {
x: 400,
y: 100
}
}];
let node: NodeModel[] = [{
id: 'node1',
width: 150,
height: 100,
offsetX: 100,
offsetY: 100,
}, {
id: 'node2',
width: 80,
height: 130,
offsetX: 200,
offsetY: 200,
}];
function App() {
return (
<DiagramComponent
id="container"
width={'100%'}
height={'600px'}
getNodeDefaults={(node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
}}
nodes={node}
connectors={connector}
// Defines the pageSettings for the diagram
pageSettings = {
{
// Sets the BoundaryConstraints to page
boundaryConstraints: 'Page',
background: {
color: 'grey'
},
width: 400,
height: 400,
showPageBreaks: true,
}
}
/>
);
}
const root = ReactDOM.createRoot(document.getElementById('diagram'));
root.render(<App />);