A graph is visual representation or a diagram that represents data or values in an organized mode. With Francy, it is possible to build direct and indirect Graphs.
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 ShapeDefaults 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 LinkDefaults internal representation.
In this section we show all Francy Graph Operations.
‣ Graph( IsFrancyGraphType[, IsFrancyGraphDefaults] ) | ( operation ) |
Returns: Graph
Every object will be a subclass of this Graph. All the objects contain the same base information.
Examples:
Create a simple Graph of type GraphType.DIRECTED with simple Shape and 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 with simple Shape and 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 a graph.
‣ UnsetLinks( arg ) | ( operation ) |
Removes all nodes from a graph.
‣ 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 will be a subclass of Shape object. All the objects 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 a Menu to a specific Shape.
‣ Remove( IsShape[, IsMenu, List(IsMenu)] ) | ( operation ) |
Returns: Shape
Remove a Menu from a specific Shape.
‣ Add( IsShape[, IsCallback, List(IsCallback)] ) | ( operation ) |
Returns: Shape
Add a Callback to a specific Shape.
‣ Remove( IsShape[, IsCallback, List(IsCallback)] ) | ( operation ) |
Returns: Shape
Remove a Callback from a specific Shape.
‣ Add( IsShape[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation ) |
Returns: Shape
Add a Callback to a specific Shape.
‣ Remove( IsShape[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation ) |
Returns: Shape
Remove a Callback from a specific Shape.
‣ Link( IsShape, IsShape ) | ( operation ) |
Returns: Link
Creates a Link or edge between the two Shape.
‣ Links( List(IsShape), List(IsShape) ) | ( operation ) |
Returns: List(Link)
Creates a Link or edge between the Shape of the first list and the Shape of the second list.
‣ GetLink( IsFrancyGraph, IsString ) | ( operation ) |
Returns: Link
Gets a Link or edge from a graph by ID.
‣ GetLinks( IsFrancyGraph, IsString ) | ( operation ) |
Returns: List(Link)
Gets a Link or edge 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 Shape label title. Supports TeX syntax and will be Typeset, if supported by the client implementation.
‣ Title( arg1 ) | ( operation ) |
‣ SetTitle( IsRequiredArg, IsString ) | ( operation ) |
Sets the Shape label title.
‣ Color( arg ) | ( attribute ) |
Returns: IsInt
The Color of the current Shape. This should be an hexadecimal colour value, e.g.: #ff0000
‣ Color( arg1 ) | ( operation ) |
‣ SetColor( IsShape, IsString ) | ( operation ) |
Sets the Color value. This should be an hexadecimal colour value, e.g.: #ff0000
‣ PosX( arg ) | ( attribute ) |
Returns: IsInt
The Position in the X Axis of the Shape in the Canvas in pixels.
‣ PosX( arg1 ) | ( operation ) |
‣ SetPosX( IsShape, IsInt ) | ( operation ) |
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 ) | ( operation ) |
‣ SetPosY( IsShape, IsInt ) | ( operation ) |
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 in pixels.
‣ Size( arg1 ) | ( operation ) |
‣ SetSize( IsShape, IsPosInt ) | ( operation ) |
Sets the Size of the Shape in pixels.
‣ Layer( arg ) | ( attribute ) |
Returns: IsInt
The Layer level in which the node will be placed. This property might also be used to apply a different color depending on the layer level. Depends on the client implementation.
‣ Layer( arg1 ) | ( operation ) |
‣ SetLayer( IsShape, IsInt ) | ( operation ) |
Sets the Layer number on a Shape.
‣ ParentShape( arg ) | ( attribute ) |
Returns: IsShape
The ParentShape in which the node will be placed. This property might also be used to apply a different color depending on the parent level. Depends on the client implementation.
‣ ParentShape( arg1 ) | ( operation ) |
‣ SetParentShape( IsShape, IsShape ) | ( operation ) |
Sets the ParentShape on a Shape.
‣ 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 on the rendered GUI. Depends on the client implementation.
‣ Simulation( arg1 ) | ( operation ) |
‣ SetSimulation( IsCanvas, IsBool ) | ( operation ) |
Sets the Simulation behavior, as per de description above.
‣ Collapsed( arg ) | ( attribute ) |
Returns: IsBool True if enabled otherwise False
Collapsed is a property that sets Graph Tree structures to fold by default on the rendered GUI.
‣ Collapsed( arg1 ) | ( operation ) |
‣ SetCollapsed( IsCanvas, IsBool ) | ( operation ) |
Sets the Collapsed behavior, as per the description above.
‣ Selected( arg ) | ( attribute ) |
Returns: IsBool True if enabled otherwise False
Selected is a property that sets Shape objects as selected by default on the rendered GUI.
‣ Selected( arg1 ) | ( operation ) |
‣ SetSelected( IsCanvas, IsBool ) | ( operation ) |
Sets the Selected behavior, as per the description above.
‣ ConjugateId( arg ) | ( attribute ) |
Returns: IsBool True if enabled otherwise False
ConjugateId is a property that is used to group Shape objects by default on the rendered GUI.
‣ ConjugateId( arg1 ) | ( operation ) |
‣ SetConjugateId( IsCanvas, IsBool ) | ( operation ) |
Sets the Conjugate behavior, as per the description above.
‣ Weight( arg ) | ( attribute ) |
Returns: IsInt
The Weight of the current Link or edge.
‣ Weight( arg1 ) | ( operation ) |
‣ SetWeight( IsLink, IsInt ) | ( operation ) |
Sets the Weight value on a Link or edge.
‣ Length( arg ) | ( attribute ) |
Returns: IsInt
The Length of the current Link or edge.
‣ Length( arg1 ) | ( operation ) |
‣ SetLength( IsLink, IsInt ) | ( operation ) |
Sets the Length value on a Link or edge.
‣ Invisible( arg ) | ( attribute ) |
Returns: IsBoolean
The Invisible property of the current Link or edge.
‣ Invisible( arg1 ) | ( operation ) |
‣ SetInvisible( IsLink, IsBool ) | ( operation ) |
Sets the Invisible property value on a Link or edge.
‣ Color( arg ) | ( attribute ) |
Returns: IsInt
The Color of the current Link or edge.
‣ Color( arg1 ) | ( operation ) |
‣ SetColor( IsShape, IsString ) | ( operation ) |
Sets the Color value on a Link or edge.
‣ Title( arg ) | ( attribute ) |
Returns: IsInt
The Title of the current Link or edge.
‣ Title( arg1 ) | ( operation ) |
‣ SetTitle( IsShape, IsString ) | ( operation ) |
Sets the Title value on a Link or edge.
generated by GAPDoc2HTML