The "Table" Panel, Panel.Table, arranges objects in rows and columns.
See samples that make use of tables in the samples index.
In these simplistic demonstrations, the code programmatically creates a Part and adds it to the Diagram. Once you learn about models and data binding you will generally not create parts (nodes or links) programmatically.
Each object in a Table Panel is put into the cell indexed by the value of GraphObject.row and GraphObject.column. The panel will look at the rows and columns for all of the objects in the panel to determine how many rows and columns the table should have.
diagram.add(
// all Parts are Panels
new go.Part(go.Panel.Table) // or "Table"
.add(
new go.TextBlock("row 0\ncol 0",
{ row: 0, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 0\ncol 1",
{ row: 0, column: 1, margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 0",
{ row: 1, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 2",
{ row: 1, column: 2, margin: 2, background: "lightgray" })
));
Note that not every "cell" of the table needs to have a GraphObject in it.
If there are multiple objects in a cell, they will probably overlap each other in the cell. By default objects are center-aligned in each cell.
diagram.add(
new go.Part("Table")
.add(
new go.TextBlock("row 0\ncol 0",
{ row: 0, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 0 col 1\nyellow background",
// first object in the cell (row: 0, col: 1)
{ row: 0, column: 1, margin: 2,
background: "yellow", stroke: "orange" }),
new go.TextBlock("row 0\ncol 1",
// second object in that cell overlaps the first one,
// the bigger yellow TextBlock
{ row: 0, column: 1, margin: 2,
background: "transparent", stroke: "blue" }),
new go.TextBlock("row 1\ncol 0",
{ row: 1, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 2",
{ row: 1, column: 2, margin: 2, background: "lightgray" })
));
If a column or a row has no objects in it, that column or row is ignored.
diagram.add(
new go.Part("Table")
.add(
new go.TextBlock("row 0\ncol 0",
{ row: 0, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 0\ncol 11", // column 11 -- nothing in columns 1-10
{ row: 0, column: 11, margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 0",
{ row: 1, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 12", // column 12
{ row: 1, column: 12, margin: 2, background: "lightgray" })
));
The height of each row is normally determined by the greatest height of all of the objects in that row. Similarly, the width of each column is normally determined by the greatest width of all of the objects in that column. However you can provide row height or column width information for any row or column independent of any individual object by setting properties of the desired RowColumnDefinition of the Table panel.
To fix a column width or a row height in code you can call Panel.getColumnDefinition or Panel.getRowDefinition and then set RowColumnDefinition.width or RowColumnDefinition.height. If you want to limit the width or height to certain ranges, set the RowColumnDefinition.minimum or RowColumnDefinition.maximum. If the maximum and the width or height conflict, the maximum takes precedence. For example, if the maximum is 70 but the natural value is 80, the actual value is limited to 70. If that value conflicts with the minimum, the minimum takes precedence. For example, if the minimum is 50 but the natural value is 40, the actual value is 50.
This example demonstrates how the column width may be controlled.
diagram.add(
new go.Part("Table", { defaultAlignment: go.Spot.Left })
.addColumnDefinition(0, { width: 100 })
.addColumnDefinition(1, { width: 100, minimum: 150 })
.addColumnDefinition(2, { width: 100, maximum: 50 })
.addColumnDefinition(3, { width: 100, minimum: 150, maximum: 50 })
.add(
new go.TextBlock("Text Block",
{ row: 0, column: 0, background: "green" }),
new go.TextBlock("Text Block",
{ row: 0, column: 1, background: "red" }),
new go.TextBlock("Text Block",
{ row: 0, column: 2, background: "yellow" }),
new go.TextBlock("Text Block",
{ row: 0, column: 3, background: "red" }),
new go.Panel("Auto", { row: 1, column: 0 })
.add(
new go.Shape("RoundedRectangle", { fill: "green" }),
new go.TextBlock("Auto Panel")
),
new go.Panel("Auto", { row: 1, column: 1 })
.add(
new go.Shape("RoundedRectangle", { fill: "red" }),
new go.TextBlock("Auto Panel")
),
new go.Panel("Auto", { row: 1, column: 2 })
.add(
new go.Shape("RoundedRectangle", { fill: "yellow" }),
new go.TextBlock("Auto Panel")
),
new go.Panel("Auto", { row: 1, column: 3 })
.add(
new go.Shape("RoundedRectangle", { fill: "red" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("width: 100", { row: 2, column: 0 }),
new go.TextBlock("min: 150", { row: 2, column: 1 }),
new go.TextBlock("max: 50", { row: 2, column: 2 }),
new go.TextBlock("min & max", { row: 2, column: 3 })
));
Note how the column with a minimum of 150 has a lot of extra space in it, and how the column with a maximum of 50 results in its elements being clipped.
The size of a GraphObject in a Panel is determined by many factors. The GraphObject.stretch property specifies whether the width and/or height should take up all of the space given to it by the Panel. When the width and/or height is not stretched to fill the given space, the GraphObject.alignment property controls where the object is placed if it is smaller than available space. One may also stretch the width while aligning vertically, just as one may also stretch vertically while aligning along the X axis.
The alignment value for a GraphObject, if not given by the value of GraphObject.alignment, may be inherited. If the object is in a Table Panel, the value may inherit from the RowColumnDefinition.alignments of the row and of the column that the object is in. Finally the value may be inherited from the Panel.defaultAlignment property.
The same inheritance is true for the stretch value for a GraphObject: GraphObject.stretch, RowColumnDefinition.stretch, and finally Panel.defaultStretch.
diagram.add(
new go.Part("Table", { defaultAlignment: go.Spot.Left })
.addColumnDefinition(0, { width: 200 })
.addColumnDefinition(1, { width: 15 })
.add(
new go.Panel("Auto",
{ row: 0, column: 0, alignment: go.Spot.Left })
.add(
new go.Shape("RoundedRectangle", { fill: "lightblue" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("alignment: Left", { row: 0, column: 2 }),
new go.Panel("Auto",
{ row: 1, column: 0, alignment: go.Spot.Center})
.add(
new go.Shape("RoundedRectangle", { fill: "lightblue" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("alignment: Center", { row: 1, column: 2 }),
new go.Panel("Auto",
{ row: 2, column: 0, alignment: go.Spot.Right })
.add(
new go.Shape("RoundedRectangle", { fill: "lightblue" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("alignment: Right", { row: 2, column: 2 }),
new go.Panel("Auto",
{ row: 3, column: 0, stretch: go.Stretch.Horizontal })
.add(
new go.Shape("RoundedRectangle", { fill: "yellow" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("stretch: Horizontal", { row: 3, column: 2 })
));
diagram.add(
new go.Part("Table", { defaultAlignment: go.Spot.Top })
.addRowDefinition(0, { height: 50 })
.addRowDefinition(1, { height: 15 })
.add(
new go.Panel("Auto",
{ row: 0, column: 0, alignment: go.Spot.Top })
.add(
new go.Shape("RoundedRectangle", { fill: "lightblue" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("alignment:\nTop", { row: 2, column: 0 }),
new go.Panel("Auto",
{ row: 0, column: 1, alignment: go.Spot.Center})
.add(
new go.Shape("RoundedRectangle", { fill: "lightblue" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("alignment:\nCenter", { row: 2, column: 1 }),
new go.Panel("Auto",
{ row: 0, column: 2, alignment: go.Spot.Bottom })
.add(
new go.Shape("RoundedRectangle", { fill: "lightblue" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("alignment:\nBottom", { row: 2, column: 2 }),
new go.Panel("Auto",
{ row: 0, column: 3, stretch: go.Stretch.Vertical })
.add(
new go.Shape("RoundedRectangle", { fill: "yellow" }),
new go.TextBlock("Auto Panel")
),
new go.TextBlock("stretch:\nVertical", { row: 2, column: 3 })
));
An element in a Table Panel cell can cover more than one cell if you set the GraphObject.rowSpan or GraphObject.columnSpan properties. For example, if the value of GraphObject.columnSpan is greater than one, it specifies how many columns that object may cover, starting with the value of GraphObject.column, but excluding the column indexed by column + columnSpan.
diagram.add(
new go.Part("Table")
.add(
new go.TextBlock("Three Col Header", // spans all three columns
{ row: 0, column: 0, columnSpan: 3, stretch: go.Stretch.Horizontal,
margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 0",
{ row: 1, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 1",
{ row: 1, column: 1, margin: 2, background: "lightgray" }),
new go.TextBlock("row 2\ncol 0",
{ row: 2, column: 0, margin: 2, background: "lightgray" }),
new go.TextBlock("row 2\ncol 2",
{ row: 2, column: 2, margin: 2, background: "lightgray" })
));
Here is an example that includes both column spanning and row spanning.
diagram.add(
new go.Part("Table")
.add(
new go.TextBlock("Greetings",
{ row: 0, column: 0, columnSpan: 3, stretch: go.Stretch.Horizontal,
margin: 2, background: "lightgray" }),
new go.TextBlock("numbers",
{ row: 1, column: 0, rowSpan: 2, stretch: go.Stretch.Vertical,
margin: 2, background: "lightgray", angle: 270 }),
new go.TextBlock("row 1\ncol 1",
{ row: 1, column: 1, margin: 2, background: "lightgray" }),
new go.TextBlock("row 1\ncol 2",
{ row: 1, column: 2, margin: 2, background: "lightgray" }),
new go.TextBlock("row 2\ncol 1",
{ row: 2, column: 1, margin: 2, background: "lightgray" }),
new go.TextBlock("row 2\ncol 3",
{ row: 2, column: 3, margin: 2, background: "lightgray" }),
new go.TextBlock("Signature",
{ row: 3, column: 2, columnSpan: 2, stretch: go.Stretch.Horizontal,
margin: 2, background: "lightgray" })
));
Table Panels also support the optional drawing of lines between rows or columns. The RowColumnDefinition.separatorStrokeWidth property controls the extra space that comes before a particular row or column. The RowColumnDefinition.separatorStroke and RowColumnDefinition.separatorDashArray control if and how a line is drawn.
For example, if you want to treat the first row and the first column as "headers", you can separate them from the rest of the table by drawing a black line before row 1 and column 1.
diagram.add(
new go.Part("Auto")
.add(
new go.Shape({ fill: "white", stroke: "gray", strokeWidth: 3 }),
new go.Panel("Table")
// drawn before row 1:
.addRowDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
// drawn before column 1:
.addColumnDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
.add(
new go.TextBlock("Header 1",
{ row: 0, column: 1, font: "bold 10pt sans-serif", margin: 2 }),
new go.TextBlock("Header 2",
{ row: 0, column: 2, font: "bold 10pt sans-serif", margin: 2 }),
new go.TextBlock("One", { row: 1, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 1 col 1", { row: 1, column: 1, margin: 2 }),
new go.TextBlock("row 1 col 2", { row: 1, column: 2, margin: 2 }),
new go.TextBlock("Two", { row: 2, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 2 col 1", { row: 2, column: 1, margin: 2 }),
new go.TextBlock("row 2 col 2", { row: 2, column: 2, margin: 2 }),
new go.TextBlock("Three", { row: 3, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 3 col 1", { row: 3, column: 1, margin: 2 }),
new go.TextBlock("row 3 col 2", { row: 3, column: 2, margin: 2 })
)
));
If you want to have a default separator between each row, set the default separator properties of the Panel. These properties are:
Any separator properties set on a particular RowColumnDefinition will take precedence over the default values provided on the Panel. This permits keeping the special black line separating the header row and header column from the rest.
diagram.add(
new go.Part("Auto")
.add(
new go.Shape({ fill: "white", stroke: "gray", strokeWidth: 3 }),
new go.Panel("Table",
// Set defaults for all rows and columns:
{ defaultRowSeparatorStroke: "gray",
defaultColumnSeparatorStroke: "gray" })
// specify separator before first row and first column
.addRowDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
.addColumnDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
.add(
new go.TextBlock("Header 1",
{ row: 0, column: 1, font: "bold 10pt sans-serif", margin: 2 }),
new go.TextBlock("Header 2",
{ row: 0, column: 2, font: "bold 10pt sans-serif", margin: 2 }),
new go.TextBlock("One", { row: 1, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 1 col 1", { row: 1, column: 1, margin: 2 }),
new go.TextBlock("row 1 col 2", { row: 1, column: 2, margin: 2 }),
new go.TextBlock("Two", { row: 2, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 2 col 1", { row: 2, column: 1, margin: 2 }),
new go.TextBlock("row 2 col 2", { row: 2, column: 2, margin: 2 }),
new go.TextBlock("Three", { row: 3, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 3 col 1", { row: 3, column: 1, margin: 2 }),
new go.TextBlock("row 3 col 2", { row: 3, column: 2, margin: 2 })
)
));
RowColumnDefinitions also have a RowColumnDefinition.separatorPadding property, which can be used to add extra space to rows or columns. When a RowColumnDefinition.background is set, it includes the padding in its area.
diagram.add(
new go.Part("Auto")
.add(
new go.Shape({ fill: "white", stroke: "gray", strokeWidth: 3 }),
new go.Panel("Table",
// Set defaults for all rows and columns:
{ padding: 1.5,
defaultRowSeparatorStroke: "gray",
defaultColumnSeparatorStroke: "gray",
defaultSeparatorPadding: new go.Margin(18, 0, 8, 0) })
// Override the panel's default padding on the first row
.addRowDefinition(0, { separatorPadding: 0 })
.addRowDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
.addRowDefinition(2, { background: 'lightblue' })
.addColumnDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
.add(
new go.TextBlock("Header 1",
{ row: 0, column: 1, font: "bold 10pt sans-serif", margin: 2 }),
new go.TextBlock("Header 2",
{ row: 0, column: 2, font: "bold 10pt sans-serif", margin: 2 }),
new go.TextBlock("One", { row: 1, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 1 col 1", { row: 1, column: 1, margin: 2 }),
new go.TextBlock("row 1 col 2", { row: 1, column: 2, margin: 2 }),
new go.TextBlock("Two", { row: 2, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 2 col 1", { row: 2, column: 1, margin: 2 }),
new go.TextBlock("row 2 col 2", { row: 2, column: 2, margin: 2 }),
new go.TextBlock("Three", { row: 3, column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 3 col 1", { row: 3, column: 1, margin: 2 }),
new go.TextBlock("row 3 col 2", { row: 3, column: 2, margin: 2 })
)
));
To avoid having to specify the row for each object, you can make use of a special Panel that can only be used in Table Panels, the Panel.TableRow panel type. Put all of the objects for each row into a TableRow Panel. You will still need to specify the column for each object in each row.
diagram.add(
new go.Part("Auto")
.add(
new go.Shape({ fill: "white", stroke: "gray", strokeWidth: 3 }),
new go.Panel("Table",
// Set defaults for all rows and columns:
{ defaultRowSeparatorStroke: "gray",
defaultColumnSeparatorStroke: "gray" })
.addRowDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
.addColumnDefinition(1, { separatorStrokeWidth: 1.5, separatorStroke: "black" })
.add(
new go.Panel("TableRow", { row: 0 })
.add(
new go.TextBlock("Header 1",
{ column: 1, font: "bold 10pt sans-serif", margin: 2 }),
new go.TextBlock("Header 2",
{ column: 2, font: "bold 10pt sans-serif", margin: 2 })
),
new go.Panel("TableRow", { row: 1 })
.add(
new go.TextBlock("One", { column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 1 col 1", { column: 1, margin: 2 }),
new go.TextBlock("row 1 col 2", { column: 2, margin: 2 })
),
new go.Panel("TableRow", { row: 2 })
.add(
new go.TextBlock("Two", { column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 2 col 1", { column: 1, margin: 2 }),
new go.TextBlock("row 2 col 2", { column: 2, margin: 2 })
),
new go.Panel("TableRow", { row: 3 })
.add(
new go.TextBlock("Three", { column: 0, stroke: "green", margin: 2 }),
new go.TextBlock("row 3 col 1", { column: 1, margin: 2 }),
new go.TextBlock("row 3 col 2", { column: 2, margin: 2 })
)
)
));
TableRow panels are particularly useful when used as an Panel.itemTemplate.
The same kind of organization is also possible with columns by using Panel.TableColumn Panels.
In this example the first column spans two rows, because GraphObject.rowSpan is 2 on the Picture.
The second column (column #1) has a RowColumnDefinition.minimum width of 100, so that column is at least that wide even if the elements in that column's cells are narrower.
The first column only takes as much width as it naturally needs and any excess width is given to the second column. This occurs because the RowColumnDefinition for column #0 has RowColumnDefinition.sizing set to None. The same is true for the first row -- any extra height is given to the second row.
There is a column separator line just before the second column, and there is a row separator just before the second row because the respective RowColumnDefinition.separatorStroke properties have been set to a color. But the row separator is not visible in the first column because that column's definition sets RowColumnDefinition.background to "white" and sets RowColumnDefinition.coversSeparators to true.
diagram.nodeTemplate =
new go.Node("Auto", { resizable: true, minSize: new go.Size(162, 62) })
.add(
new go.Shape({ fill: "white" }),
new go.Panel("Table", { stretch: go.Stretch.Fill, margin: 0.5 })
.addColumnDefinition(0, { sizing: go.Sizing.None, background: "white", coversSeparators: true })
.addColumnDefinition(1, { minimum: 100, background: "white", separatorStroke: "black" })
.addRowDefinition(0, { sizing: go.Sizing.None })
.addRowDefinition(1, { separatorStroke: "black" })
.add(
new go.Picture({ row: 0, column: 0,
rowSpan: 2, width: 48, height: 48, margin: 6 })
.bind("source", "pic"),
new go.TextBlock({ row: 0, column: 1,
stretch: go.Stretch.Horizontal, margin: 2, textAlign: "center" })
.bind("text", "text1"),
new go.TextBlock({ row: 1, column: 1,
stretch: go.Stretch.Fill, margin: 2, textAlign: "center" })
.bind("text", "text2")
)
);
diagram.model.nodeDataArray = [
{
pic: "../samples/images/hs1.jpg",
text1: "top",
text2: "bottom gets extra space"
},
{
pic: "../samples/images/hs2.jpg",
text1: "top has more description that wraps",
text2: "node is taller due to more text"
}
]