dg.control {dynamicGraph}R Documentation

Options of dynamicGraphMain and simpleGraphtoGraph

Description

Allow the user to set some characteristics of 'dynamicGraphMain' and 'DynamicGraph'.

Usage

dg.control(label = "dynamicGraph", 
           width = 400, height = 400, w = 6, margin = 100, 
           closeenough = 2, background = "white", transformation = NULL, 
           permitZoom = TRUE, UserMenus = NULL, constrained = FALSE, 
           vertexColor = "red", extraVertexColor = "white", 
           edgeColor = "black", 
           factorVertexColor = "default", factorEdgeColor = "brown", 
           blockEdgeColor = "default", blockColors = NULL, 
           extraEdgeColor = "peru", 
           drawblocks = TRUE, right.to.left = FALSE, 
           nested.blocks = FALSE, overlaying = TRUE, 
           fixedFactorPositions = FALSE, diagonal = TRUE, N = 3, 
           vertexClasses = validVertexClasses(), 
           factorClasses = validFactorClasses(), 
           edgeClasses = validEdgeClasses(), 
           viewClasses = validViewClasses(), 
           drawBlockFrame = TRUE, drawBlockBackground = FALSE, 
           useNamesForLabels = TRUE, namesOnEdges = TRUE, 
           updateEdgeLabels = TRUE, enterLeaveUpdate = TRUE, 
           updateAllViews = TRUE, 
           saveTkReferences = TRUE, saveFunctions = TRUE, 
           returnNull = FALSE, hasMethods = TRUE, variableFrame = TRUE,
           debug.strata = FALSE, debug.edges = FALSE, 
           debug.position = FALSE, debug.update = FALSE, ...)

Arguments

label Text string with the title set on the graph window. (dynamicGraphMain)
width Integer with the width of the plot canvas. (dynamicGraphMain)
height Integer with the height of the plot canvas. (dynamicGraphMain)
w The radius of the vertices. Send as argument to the draw method for vertices, and edges are shortened by the quantity in each end. (dynamicGraphMain)
margin Integer, the width of the margin round the canvas. (dynamicGraphMain)
closeenough Parameter for whether the mouse is close enough when clicking an object of the graph window, see tkcanvas. (dynamicGraphMain)
background The color of the canvas of the graph window, default: "white". (dynamicGraphMain)
transformation NULL, or rotation matrix for projecting the positions of the vertices, blocks, etc. onto the canvas. (dynamicGraphMain)
permitZoom Logical. If FALSE then zooming is disabled, and no margin around the canvas is set. (dynamicGraphMain)
vertexColor Single text string. Colors of new vertices created in dynamicGraphMain (by newVertex). The colors of the vertices of vertexList are given in this list. vertexColor is given as argument to the draw method of vertices, but this argument are by default not used in the draw method.
extraVertexColor Single text string. As vertexColor, but for the vertices of extraList.
edgeColor Single text string. edgeColor is similar to vertexColor.
factorVertexColor Single text string. factorVertexColor is similar to vertexColor. If factorVertexColor is "default" then the color of a factor vertex will depend on the type of the generator of the factor.
factorEdgeColor Single text string. factorEdgeColor is similar to edgeColor.
blockEdgeColor "default", or list with two text strings for colors. blockEdgeColor is similar to edgeColor. The two colors are used for respectively edges between two blocks and for edges between blocks and vertices.
blockColors List of colors of blocks. Similar to vertexColor: Only used when creating new blocks, else the colors set in blockList and blockTree are used.
extraEdgeColor Single text string. extraEdgeColor is similar to edgeColor.
drawblocks Logical. If drawblocks is set to FALSE, then the blocks are not drawn. The strata of the vertices are then not updated when the vertices are moved. (simpleGraphToGraph)
right.to.left Logical. If right.to.left is set to TRUE then the explanatory blocks are drawn to the right. See setBlocks. (simpleGraphToGraph)
nested.blocks Logical. If nested.blocks is set to TRUE then the blocks are drawn nested. See setBlocks. (simpleGraphToGraph)
overlaying Logical. If overlaying is set to FALSE then children of a block are not drawn inside the block. See setTreeBlocks. (simpleGraphToGraph)
fixedFactorPositions Logical. If fixedFactorPositions is set to TRUE then the factor vertices will not follow the moved vertices. (simpleGraphToGraph)
diagonal Logical. If diagonal is set to TRUE then the extra vertices are by default positioned along a diagonal. (simpleGraphToGraph)
N The number, N > 1, of coordinates for the positions of the vertices and block corners. (simpleGraphToGraph)
vertexClasses Returned value from validVertexClasses, or extension of this matrix. Used when creating new vertices in dynamicGraphMain.
factorClasses Returned value from validFactorClasses, or extension of this matrix. Used when creating new factor vertices in dynamicGraphMain.
edgeClasses Returned value from validEdgeClasses, or extension of this matrix. Used when creating new edges in dynamicGraphMain.
viewClasses Returned value from validViewClasses, or extension of this matrix. Used when creating new views in dynamicGraphMain.
drawBlockFrame Logical. If TRUE then frames are drawn around blocks. (dynamicGraphMain)
drawBlockBackground Logical. If TRUE then a block canvas is drawn, with color set by blockColors. (dynamicGraphMain)
useNamesForLabels Logical. If useNamesForLabels is TRUE then names are sued for labels. (dynamicGraphMain)
namesOnEdges Logical. If FALSE then the names of the vertices are not set on the edge as label. (dynamicGraphMain)
updateEdgeLabels Logical. If FALSE then the edge labels are not cleared when the model is updated. (dynamicGraphMain)
enterLeaveUpdate Logical. If FALSE then the graph window is not redrawn when the mouse enters and leaves the graph window. (dynamicGraphMain)
UserMenus List with user defined menu items for main menu and pop up menus. See dg.graphedges-class for an example of a user specified menu. (dynamicGraphMain)
constrained Logical. If constrained is then the vertices can not be dragged out of blocks.
hasMethods Logical. If TRUE then the object should have the methods modifyModel and testEdge. (I do not know why the R-function hasMethod does not work on objects (defined outside the package dynamicGraph) inside dynamicGraphMain). (dynamicGraphMain)
saveTkReferences Logical, if saveTkReferences is TRUE then references to Tk-variables of the dynamic graph window are saved in environments in the returned object of dynamicGraphMain (if not returnNull is TRUE). (dynamicGraphMain)
saveFunctions Logical, if saveFunctions is TRUE then draw and update functions of the dynamic graph window are saved in environments in the returned object of dynamicGraphMain (if not returnNull is TRUE). (dynamicGraphMain)
returnNull Logical, if returnNull is TRUE then NULL is returned. (dynamicGraphMain)
updateAllViews Logical. If TRUE then all windows are updated when one is changed. (dynamicGraphMain)
variableFrame Logical. If variableFrame is TRUE the a frame/box/panel for variables is made left in the graph window. (dynamicGraphMain)
debug.strata Logical for tracing the strata of the vertices (also in plot). (dynamicGraphMain)
debug.edges Logical for tracing edges (also by labels in plot). (dynamicGraphMain)
debug.position Logical for tracing positions of the vertices. (dynamicGraphMain)
debug.update Logical for tracing redrawing of the graph window. (dynamicGraphMain)
... Additional deprecated arguments, e.g., returnLink.

Value

A 'list' with components with meanings as explained under 'Arguments'.

Note

The arguments of dg.control can also be given to dynamicGraphMain and DynamicGraph (for backward compatibility). But if the argument control is used for dynamicGraphMain or DynamicGraph then these arguments are ignored.

Author(s)

Jens Henrik Badsberg

See Also

dynamicGraphMain and DynamicGraph

Examples

require(dynamicGraph)
str(dg.control())

[Package dynamicGraph version 0.2.2.4 Index]