It is possible to build Graphs
, direct or indirect.
Please see examples section.
Please see Francy-JS for client implementation.
In this section we show all Francy Graph Categories.
‣ IsFrancyGraph ( arg ) | ( filter ) |
Returns: true
or false
Identifies Graph
objects.
‣ IsFrancyGraphType ( arg ) | ( filter ) |
Returns: true
or false
Identifies GraphType
objects.
‣ IsFrancyGraphDefaults ( arg ) | ( filter ) |
Returns: true
or false
Identifies GraphDefaults
objects.
‣ IsShape ( arg ) | ( filter ) |
Returns: true
or false
Identifies Shape
objects.
‣ IsShapeType ( arg ) | ( filter ) |
Returns: true
or false
Identifies ShapeType
objects.
‣ IsShapeDefaults ( arg ) | ( filter ) |
Returns: true
or false
Identifies ShapeDefaults
objects.
‣ IsLink ( arg ) | ( filter ) |
Returns: true
or false
Identifies Link
objects.
‣ IsLinkDefaults ( arg ) | ( filter ) |
Returns: true
or false
Identifies LinkDefaults
objects.
In this section we show all Francy Graph Families.
In this section we show all Francy Graph Representations.
‣ IsFrancyGraphRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a Graph
internal representation.
‣ IsFrancyGraphDefaultsRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a GraphDefaults
internal representation.
‣ IsFrancyGraphTypeRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a GraphType
internal representation.
‣ IsShapeRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a Shape
internal representation.
‣ IsShapeDefaultsRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a ShapeDeafults
internal representation.
‣ IsShapeTypeRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a ShapeType
internal representation.
‣ IsLinkRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a Link
internal representation.
‣ IsLinkDefaultsRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a LinkDeafults
internal representation.
In this section we show all Francy Graph Operations.
‣ Graph ( IsFrancyGraphType[, IsFrancyGraphDefaults] ) | ( operation ) |
Returns: Graph
Every object to draw will be a subclass of this object. This will allow all the objects to contain the same base information.
Examples:
Create a simple Graph
of type GraphType.DIRECTED
and simple Shapes
connected with Links
:
gap> graph := Graph(GraphType.DIRECTED); gap> SetSimulation(graph, false); gap> shape1 := Shape(ShapeType.SQUARE); gap> shape1!.layer := 1; gap> shape2 := Shape(ShapeType.TRIANGLE); gap> shape2!.layer := 3; gap> link := Link(shape1, shape2); gap> Add(graph, link); gap> Add(graph, [shape1, shape2]);
Create a simple Graph
of type GraphType.UNDIRECTED
and a simple Shape
with a TriggerEvent.RIGHT_CLICK
Callback
:
gap> graph := Graph(GraphType.UNDIRECTED); gap> shape := Shape(ShapeType.SQUARE); gap> MyFunction := function() Add(graph, Shape(ShapeType.Circle)); return graph; end; gap> callback := Callback(TriggerType.RIGHT_CLICK, MyFunction); gap> Add(shape, callback); gap> Add(graph, shape);
‣ UnsetNodes ( arg ) | ( operation ) |
Removes all nodes from gaph
‣ UnsetLinks ( arg ) | ( operation ) |
Removes all nodes from gaph
‣ Add ( IsFrancyGraph[, IsLink, List(IsLink)] ) | ( operation ) |
Returns: Graph
Add IsLink
to a specific Graph
.
‣ Remove ( IsFrancyGraph[, IsLink, List(IsLink)] ) | ( operation ) |
Returns: Graph
Remove IsLink
from a specific Graph
.
‣ Add ( IsFrancyGraph[, IsShape, List(IsShape)] ) | ( operation ) |
Returns: Graph
Add IsShape
to a specific Graph
.
‣ Remove ( IsFrancyGraph[, IsShape, List(IsShape)] ) | ( operation ) |
Returns: Graph
Remove IsShape
from a specific Graph
.
‣ Shape ( IsShapeType[, IsString(title), IsShapeDefaults] ) | ( operation ) |
Returns: Shape
Every object to draw will be a subclass of this object. This will allow all the objects to contain the same base information.
‣ GetShape ( IsFrancyGraph, IsString ) | ( operation ) |
Returns: Shape
Gets a Shape
node from a graph by ID.
‣ GetShapes ( IsFrancyGraph, IsString ) | ( operation ) |
Returns: List(Shape)
Gets a Shape
node from a graph by ID.
‣ Add ( IsShape[, IsMenu, List(IsMenu)] ) | ( operation ) |
Returns: Shape
Add Menu
to a specific Shape
.
‣ Remove ( IsShape[, IsMenu, List(IsMenu)] ) | ( operation ) |
Returns: Shape
Remove Menu
from a specific Shape
.
‣ Add ( IsShape[, IsCallback, List(IsCallback)] ) | ( operation ) |
Returns: Shape
Add Callback
to a specific Shape
.
‣ Remove ( IsShape[, IsCallback, List(IsCallback)] ) | ( operation ) |
Returns: Shape
Remove Callback
from a specific Shape
.
‣ Add ( IsShape[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation ) |
Returns: Shape
Add Callback
to a specific Shape
.
‣ Remove ( IsShape[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation ) |
Returns: Shape
Remove Callback
from a specific Shape
.
‣ Link ( IsShape, IsShape ) | ( operation ) |
Returns: Link
Creates a Link
between the two Shape
.
‣ Links ( List(IsShape), List(IsShape) ) | ( operation ) |
Returns: List(Link)
Creates a Link
between the Shape
of the first list and the second list.
‣ GetLink ( IsFrancyGraph, IsString ) | ( operation ) |
Returns: Link
Gets a Link
from a graph by ID.
‣ GetLinks ( IsFrancyGraph, IsString ) | ( operation ) |
Returns: List(Link)
Gets a Link
from a graph.
In this section we show all Global Callback Francy Records for multi purpose.
In this section we show all Francy Core Attributes
‣ Title ( arg ) | ( attribute ) |
Returns: IsString
with the title of the object
Sets the title on the Shape. Supports LaTex syntax that gets translated, if enabled on the client.
‣ Title ( arg1 ) | ( function ) |
‣ SetTitle ( IsRequiredArg, IsString ) | ( function ) |
Sets the title of the Shape.
‣ Color ( arg ) | ( attribute ) |
Returns: IsInt
The Color
of the current shape.
‣ Color ( arg1 ) | ( function ) |
‣ SetColor ( IsShape, IsString ) | ( function ) |
Sets the Color
value.
‣ PosX ( arg ) | ( attribute ) |
Returns: IsInt
The Position in the X Axis of the Shape in the Canvas in pixels
‣ PosX ( arg1 ) | ( function ) |
‣ SetPosX ( IsShape, IsInt ) | ( function ) |
Sets the Position in the X Axis of the Shape in the Canvas in pixels
‣ PosY ( arg ) | ( attribute ) |
Returns: IsInt
The Position in the Y Axis of the Shape in the Canvas in pixels
‣ PosY ( arg1 ) | ( function ) |
‣ SetPosY ( IsShape, IsInt ) | ( function ) |
Sets the Position in the Y Axis of the Shape in the Canvas in pixels
‣ Size ( arg ) | ( attribute ) |
Returns: IsPosInt
The Size
of the Shape
‣ Size ( arg1 ) | ( function ) |
‣ SetSize ( IsShape, IsPosInt ) | ( function ) |
Sets the Size of the Shape
‣ Layer ( arg ) | ( attribute ) |
Returns: IsInt
The Layer
in which the node will be placed. This property is also used to apply a color based on a scale
‣ Layer ( arg1 ) | ( function ) |
‣ SetLayer ( IsShape, IsInt ) | ( function ) |
Sets the Layer
number.
‣ ParentShape ( arg ) | ( attribute ) |
Returns: IsShape
The ParentShape
in which the node will be placed. This property is also used to apply a color based on a scale
‣ ParentShape ( arg1 ) | ( function ) |
‣ SetParentShape ( IsShape, IsShape ) | ( function ) |
Sets the ParentShape
.
‣ Simulation ( arg ) | ( attribute ) |
Returns: IsBool
True if enabled otherwise False
Simulation
is a property that sets the simulation behavior by applying forces to organize the graphics, without the need to provide custom positions, in the client implementation.
‣ Simulation ( arg1 ) | ( function ) |
‣ SetSimulation ( IsCanvas, IsBool ) | ( function ) |
Sets the Simulation
behavior.
‣ Collapsed ( arg ) | ( attribute ) |
Returns: IsBool
True if enabled otherwise False
Collapsed
is a property that sets to collapsed the graphic structure by default
‣ Collapsed ( arg1 ) | ( function ) |
‣ SetCollapsed ( IsCanvas, IsBool ) | ( function ) |
Sets the Collapsed
behavior.
‣ Selected ( arg ) | ( attribute ) |
Returns: IsBool
True if enabled otherwise False
Collapsed
is a property that sets to collapsed the graphic structure by default
‣ Selected ( arg1 ) | ( function ) |
‣ SetSelected ( IsCanvas, IsBool ) | ( function ) |
Sets the Collapsed
behavior.
‣ ConjugateId ( arg ) | ( attribute ) |
Returns: IsBool
True if enabled otherwise False
Collapsed
is a property that sets to collapsed the graphic structure by default
‣ ConjugateId ( arg1 ) | ( function ) |
‣ SetConjugateId ( IsCanvas, IsBool ) | ( function ) |
Sets the Collapsed
behavior.
‣ Weight ( arg ) | ( attribute ) |
Returns: IsInt
The Weight
of the current link.
‣ Weight ( arg1 ) | ( function ) |
‣ SetWeight ( IsLink, IsInt ) | ( function ) |
Sets the Weight
value.
‣ Length ( arg ) | ( attribute ) |
Returns: IsInt
The Length
of the current link.
‣ Length ( arg1 ) | ( function ) |
‣ SetLength ( IsLink, IsInt ) | ( function ) |
Sets the Length
value.
‣ Invisible ( arg ) | ( attribute ) |
Returns: IsBoolean
The Invisible
of the current link.
‣ Invisible ( arg1 ) | ( function ) |
‣ SetInvisible ( IsLink, IsBool ) | ( function ) |
Sets the Invisible
value.
‣ Color ( arg ) | ( attribute ) |
Returns: IsInt
The Color
of the current link.
‣ Color ( arg1 ) | ( function ) |
‣ SetColor ( IsShape, IsString ) | ( function ) |
Sets the Color
value.
‣ Title ( arg ) | ( attribute ) |
Returns: IsInt
The Title
of the current link.
‣ Title ( arg1 ) | ( function ) |
‣ SetTitle ( IsShape, IsString ) | ( function ) |
Sets the Title
value.
generated by GAPDoc2HTML