Nodes in the graph always have a title, and can optionally contain free text or column data. Nodes with content can be opened (for example the Template node) and closed (for example the TemplateDocument node).
The initial call made when the component is loaded.
Type of graph to generate.
Possible value | Description |
---|---|
ER | Entity-Relationship. Nodes are entities and connections are relationships. |
Height of the canvas the nodes are placed on. The canvas will, if possible, expand to fit the browser window, so specifying size is only necessary if you want an even larger canvas.
Width of the canvas the nodes are placed on. The canvas will, if possible, expand to fit the browser window, so specifying size is only necessary if you want an even larger canvas.
The node's ID.
Where to show the node. The top left corner of the component is 0,0.
Where to show the node. The top left corner of the component is 0,0.
The node's title.
The node's subtitle.
Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.
Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.
Whether the user is allowed to create connections from this node.
Whether the user is allowed to create connections to this node.
If the user is allowed to move the box.
The name of a system icon to show in the box.
Named color or hex code to assign to the icon.
Whether the node starts expanded. Not used by nodes that do not have any content to show by expanding them.
Additional columns can be referenced by links of the "Graph node link" type.
This optional table is used to display columns in a node's body. Its columns use field information from the menu item's field tables to get their label, alignment, etc..
Node to attach these columns to. This node must not have used the BodyHtml or BodyText columns when it was declared. Multiple rows may refer to the same NodeId.
Column value to show in the node.
The connection's ID.
Node the connection goes from.
Node the connection goes to.
How the part where the connection touches the from-node is drawn.
Possible value | Description |
---|---|
Arrow | An arrow head. |
Crow | A crow's foot (to-many relationship). |
NULL | No decoration. |
How the line is drawn.
Possible value | Description |
---|---|
Dashed | |
Solid |
How the part where the connection touches the to-node is drawn.
Possible value | Description |
---|---|
Arrow | An arrow head. |
Crow | A crow's foot (to-many relationship). |
NULL | No decoration. |
Additional columns can be referenced by links of the "Graph connection link" type.
Made when the user has moved nodes. This call will receive a temporary table with the new coordinates.
CREATE TABLE #MovedNode
(
NodeId varchar(MAX) NOT NULL,
X int NOT NULL,
Y int NOT NULL,
)
Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.
Displays a user friendly message to the user.
This call will receive a temporary table with the nodes that changed their expand state. You can use this call, in combination with the IsExpanded column in the Get Graph call to preserve a user's node expansion state.
CREATE TABLE #ExpandedNode
(
NodeId varchar(MAX) NOT NULL,
IsExpanded bit NOT NULL
)
The user has created a connection between two nodes. You can either create a connection directly, or forward to NewEdit menu item to get more information about the connection.
If you do not forward then you should perform a partial update of the page, by at least returning the created connection.
Any nodes that need to be updated because of the created connection. Usually you will not need to update any nodes.
The node's ID.
Where to show the node. The top left corner of the component is 0,0.
Where to show the node. The top left corner of the component is 0,0.
The node's title.
The node's subtitle.
Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.
Extra HTML to show in the node. At most one of BodyHtml and BodyText can contain a value.
Whether the user is allowed to create connections from this node.
Whether the user is allowed to create connections to this node.
If the user is allowed to move the box.
The name of a system icon to show in the box.
Named color or hex code to assign to the icon.
Whether the node starts expanded. Not used by nodes that do not have any content to show by expanding them.
Additional columns can be referenced by links of the "Graph node link" type.
If you are using node fields, and node that was returned in the Updated nodes table will also need its node fields.
Node to attach these columns to. This node must not have used the BodyHtml or BodyText columns when it was declared. Multiple rows may refer to the same NodeId.
Column value to show in the node.
This table should contain the created connection.
The connection's ID.
Node the connection goes from.
Node the connection goes to.
How the part where the connection touches the from-node is drawn.
Possible value | Description |
---|---|
Arrow | An arrow head. |
Crow | A crow's foot (to-many relationship). |
NULL | No decoration. |
How the line is drawn.
Possible value | Description |
---|---|
Dashed | |
Solid |
How the part where the connection touches the to-node is drawn.
Possible value | Description |
---|---|
Arrow | An arrow head. |
Crow | A crow's foot (to-many relationship). |
NULL | No decoration. |
Additional columns can be referenced by links of the "Graph connection link" type.
Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.
Displays a user friendly error message to the user.
Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and Validate parameters is checked.
Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.
Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.
The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.
If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.