GAP (Francy) - Chapter 9: Francy Renderers

Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 Ind
[Top of Book] [Contents] [Previous Chapter] [Next Chapter]

[MathJax off]

9 Francy Renderers
9.1 Categories
9.1-1 IsFrancyRenderer
9.1-2 IsFrancyRendererType
9.2 Families
9.3 Representations
9.3-1 IsFrancyRendererRep
9.3-2 IsFrancyRendererTypeRep
9.4 Operations
9.4-1 FrancyRenderer
9.5 Global
9.6 Attributes
9.6-1 Value
9.6-2 Value
9.6-3 SetValue

### 9 Francy Renderers

`FrancyRenderer` is an object that holds the renderer name to be used by the client to display the graphics.

Francy JS allows users to switch between renderers in runtime, but if the renderer is specified in the GAP code, then the user won't be able to switch between renderers on the client side.

This implementation knows only about the official supported renderers: `D3`, `Vis` and `Graphviz`. Please see Francy-JS for client implementation.

#### 9.1 Categories

In this section we show all Francy FrancyRenderer Categories.

##### 9.1-1 IsFrancyRenderer

`‣ IsFrancyRenderer`( arg ) | ( filter )

Returns: `true` or `false`

Identifies `FrancyRenderer` objects.

##### 9.1-2 IsFrancyRendererType

`‣ IsFrancyRendererType`( arg ) | ( filter )

Returns: `true` or `false`

Identifies `FrancyRendererType` objects.

#### 9.2 Families

In this section we show all Francy FrancyRenderer Families.

#### 9.3 Representations

In this section we show all Francy FrancyRenderer Representations.

##### 9.3-1 IsFrancyRendererRep

`‣ IsFrancyRendererRep`( arg ) | ( filter )

Returns: `true` or `false`

Checks whether an `Object` has a `FrancyRenderer` internal representation.

##### 9.3-2 IsFrancyRendererTypeRep

`‣ IsFrancyRendererTypeRep`( arg ) | ( filter )

Returns: `true` or `false`

Checks whether an `Object` has a `FrancyRendererType` internal representation.

#### 9.4 Operations

In this section we show all Francy FrancyRenderer Operations.

##### 9.4-1 FrancyRenderer

`‣ FrancyRenderer`( IsFrancyRendererType ) | ( operation )

Returns: `FrancyRenderer`

Adds an info label with the format "label: value"

Examples:

Configure `FrancyRendererType.VIS` as the renderer for a specific canvas:

    gap> canvas := Canvas("Example Canvas / Shape with Messages");
    gap> graph := Graph(GraphType.UNDIRECTED);
    gap> Add(canvas, graph);
    gap> vis := FrancyRenderer(FrancyRendererType.VIS);
    gap> Add(canvas, vis);

#### 9.5 Global

In this section we show all Global FrancyRendererType records for multi purpose.

#### 9.6 Attributes

In this section we show all FrancyRenderer Core Attributes

##### 9.6-1 Value

`‣ Value`( arg ) | ( attribute )

Returns: `IsString` with the renderer of the object

A value on a `FrancyRenderer` is used to specify which renderer will be used to draw the graphics on the client.

##### 9.6-2 Value

`‣ Value`( arg1 ) | ( operation )

##### 9.6-3 SetValue

`‣ SetValue`( IsFrancyRenderer, IsString ) | ( operation )

Sets the actual renderer `FrancyRenderer`.

[Top of Book] [Contents] [Previous Chapter] [Next Chapter]
Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 Ind

generated by GAPDoc2HTML