dg.Block-class {dynamicGraph}R Documentation

Class "dg.Block"

Description

The class for the blocks.

Usage

newBlock(stratum = 0, index = 0, position = matrix(rep(0, 6), ncol = 3),
         closed = FALSE, visible = TRUE, color = "Grey", label = "Label",
         label.position = c(0, 0, 0), ancestors = NULL)

Arguments

stratum Integer for the stratum of the block.
index Integer for the index of the block.
position Numeric vector for the position of the block, the two diagonal opposite corners.
closed Logical, if TRUE then the block is drawn as a "vertex".
visible Logical, if TRUE then the block is drawn.
color Text string for the color of the block.
label Text string for the label of the block.
label.position Numeric vector for the label.position of the block label.
ancestors Integer vector for the ancestor blocks of the block. The slot with the descendant blocks is set after the creation of the block.

Slots

stratum:
Object of class "numeric", the stratum of the block.
index:
Object of class "numeric" with (minus) the index of the block, the position of the block in a block list.
ancestors:
Object of class "numeric". Integer vector for the ancestor blocks of the block.
descendants:
Object of class "numeric". Integer vector for the descendants blocks of the block. The slot with the descendant blocks is set after the creation of the block.
position:
Object of class "matrix", the position of the block, the two diagonal opposite corners.
closed:
Object of class "logical", if TRUE then the block is closed, e.i. drawn as a "vertex".
visible:
Object of class "logical", if TRUE then the block is drawn, else it is hidden in a closed block.
color:
Object of class "character", see "dg.Node".
label:
Object of class "character", see "dg.Node".
label.position:
Object of class "numeric", see "dg.Node".

Extends

Class "dg.Node", directly.

Methods

ancestors<-
signature(x = "dg.Block"): ...
ancestors
signature(object = "dg.Block"): ...
closed<-
signature(x = "dg.Block"): ...
closed
signature(object = "dg.Block"): ...
descendants<-
signature(x = "dg.Block"): ...
descendants
signature(object = "dg.Block"): ...
draw
signature(object = "dg.Block"): Method for drawing the closed block.
index<-
signature(x = "dg.Block"): ...
index
signature(object = "dg.Block"): ...
name
signature(object = "dg.Block"): Extract the label of the block.
position<-
signature(x = "dg.Block"): ...
position
signature(object = "dg.Block"): ...
stratum<-
signature(x = "dg.Block"): ...
stratum
signature(object = "dg.Block"): ...
visible<-
signature(x = "dg.Block"): ...
visible
signature(object = "dg.Block"): ...

Note

The dg.Block class has the methods name, label, labelPosition, position, color, stratum, index, visible, ancestors, and descendants, for extracting values and the replacement methods label<-, labelPosition<-, position<-, color<-, stratum<-, index<-, visible<-, ancestors<-, and descendants<-. Items are added to the pop up menu of a block by the method addToPopups.

The method propertyDialog is also avaliable.

I have not yet had any use of a block name. Thus this slot is not available for the block, as neither for edges.

Author(s)

Jens Henrik Badsberg

See Also

setBlocks, setTreeBlocks, dg.Node-class.

Examples

b <- newBlock()
str(b)

color(b)
label(b)
labelPosition(b)
name(b)
index(b)
position(b)
stratum(b)
ancestors(b)
descendants(b)
visible(b)

color(b) <- "grey"
label(b) <- "NameAndLabel"
labelPosition(b) <- c(1, 2, 3)
# name(b) <- "NameAndLabel" # Not possible!!!
index(b) <- 3
position(b) <- matrix(c( 10,  20,  30,  40, 
                        110, 120, 130, 140), byrow = TRUE, ncol = 4)
stratum(b) <- 1
ancestors(b) <- c(1, 2)
descendants(b) <- c(4, 5)
visible(b) <- FALSE

str(b)

[Package Contents]