GAP (Francy) - Chapter 3: Francy Canvas

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

[MathJax on]

3 Francy Canvas
3.1 Categories
3.1-1 IsCanvas
3.1-2 IsCanvasDefaults
3.2 Families
3.3 Representations
3.3-1 IsCanvasRep
3.3-2 IsCanvasDefaultsRep
3.4 Operations
3.4-1 Canvas
3.4-2 Add
3.4-3 Remove
3.4-4 Add
3.4-5 Remove
3.4-6 Add
3.4-7 Remove
3.4-8 Add
3.4-9 Remove
3.4-10 Add
3.4-11 Remove
3.4-12 Draw
3.4-13 DrawSplash
3.5 Global
3.6 Attributes
3.6-1 Width
3.6-2 Width
3.6-3 SetWidth
3.6-4 Height
3.6-5 Height
3.6-6 SetHeight
3.6-7 ZoomToFit
3.6-8 ZoomToFit
3.6-9 SetZoomToFit
3.6-10 Title
3.6-11 Title
3.6-12 SetTitle
3.6-13 TexTypesetting
3.6-14 TexTypesetting
3.6-15 SetTexTypesetting

### 3 Francy Canvas

A `Canvas` is an area where the graphics representation of Francy live.

Please see Francy-JS for client implementation.

#### 3.1 Categories

In this section we show all Francy Canvas Categories.

##### 3.1-1 IsCanvas

`‣ IsCanvas`( arg ) | ( filter )

Returns: `true` or `false`

Identifies `Canvas` objects.

##### 3.1-2 IsCanvasDefaults

`‣ IsCanvasDefaults`( arg ) | ( filter )

Returns: `true` or `false`

Identifies `CanvasDefaults` objects.

#### 3.2 Families

In this section we show all Francy Canvas Families.

#### 3.3 Representations

In this section we show all Francy Canvas Representations.

##### 3.3-1 IsCanvasRep

`‣ IsCanvasRep`( arg ) | ( filter )

Returns: `true` or `false`

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

##### 3.3-2 IsCanvasDefaultsRep

`‣ IsCanvasDefaultsRep`( arg ) | ( filter )

Returns: `true` or `false`

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

#### 3.4 Operations

In this section we show all Francy Canvas Operations.

##### 3.4-1 Canvas

`‣ Canvas`( IsString(title)[, IsCanvasDefaults] ) | ( operation )

Returns: `Canvas`

A `Canvas` represents the base element where rendering happens. This object is inspired by the HTML canvas tag element, which is used to draw graphics in runtime via JavaScript. Examples:

Create a simple `Canvas`:

    gap> canvas := Canvas("");
    gap> Id(canvas);
    gap> SetTitle(canvas, "Quaternion Group Subgroup Lattice");
    gap> Title(canvas);
    gap> SetHeight(canvas, 400); # default 600
    gap> Height(canvas);
    gap> SetWidth(canvas, 400); # default 800
    gap> Width(canvas);
    gap> SetZoomToFit(canvas, false); # default true
    gap> ZoomToFit(canvas);
    gap> Draw(canvas);

##### 3.4-2 Add

`‣ Add`( IsCanvas[, IsFrancyGraph, List(IsFrancyGraph)] ) | ( operation )

Returns: `Canvas`

Adds a `FrancyGraph` to a specific `Canvas`. Well, the api is abstract enough to allow Adding a list of `IsFrancyGraph` to a canvas, but this results in setting the graph property only to the last `IsFrancyGraph` in the list.

##### 3.4-3 Remove

`‣ Remove`( IsCanvas[, IsFrancyGraph, List(IsFrancyGraph)] ) | ( operation )

Returns: `Canvas`

Removes a `FrancyGraph` from a `Canvas`.

##### 3.4-4 Add

`‣ Add`( IsCanvas[, IsChart, List(IsChart)] ) | ( operation )

Returns: `Canvas`

Adds a `Chart` to a specific `Canvas`. Well, the api is abstract enough to allow Adding a list of `IsChart` to a canvas, but this results in setting the graph property only to the last `IsChart` in the list.

##### 3.4-5 Remove

`‣ Remove`( IsCanvas[, IsChart, List(IsChart)] ) | ( operation )

Returns: `Canvas`

Removes a `Chart` from a `Canvas`.

##### 3.4-6 Add

`‣ Add`( IsCanvas[, IsMenu, List(IsMenu)] ) | ( operation )

Returns: `Canvas`

Adds a `Menu` to a specific `Canvas`.

##### 3.4-7 Remove

`‣ Remove`( IsCanvas[, IsMenu, List(IsMenu)] ) | ( operation )

Returns: `Canvas`

Removes a `Menu` from a `Canvas`.

##### 3.4-8 Add

`‣ Add`( IsCanvas[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation )

Returns: `IsCanvas`

Adds a `FrancyMessage` to a specific `IsCanvas`.

##### 3.4-9 Remove

`‣ Remove`( IsCanvas[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation )

Returns: `IsCanvas`

Removes a `FrancyMessage` from a specific `IsCanvas`.

##### 3.4-10 Add

`‣ Add`( IsCanvas[, IsFrancyRenderer, List(IsFrancyRenderer)] ) | ( operation )

Returns: `IsCanvas`

Adds a `FrancyRenderer` to a specific `IsCanvas`.

##### 3.4-11 Remove

`‣ Remove`( IsCanvas[, IsFrancyRenderer, List(IsFrancyRenderer)] ) | ( operation )

Returns: `IsCanvas`

Removes a `FrancyRenderer` from a specific `IsCanvas`.

##### 3.4-12 Draw

`‣ Draw`( IsCanvas ) | ( operation )

Returns: `rec` with the JSON metadata model representation of the `Canvas`

Generates the JSON metadata model representation of the `Canvas` object and all children objects.

##### 3.4-13 DrawSplash

`‣ DrawSplash`( IsCanvas ) | ( operation )

Returns: `IsString` with HTML generated

Generates an HTML page with an offline version od Francy JS and opens it within the default browser of the system.

#### 3.5 Global

In this section we show all Global Francy Canvas Records for multi purpose.

#### 3.6 Attributes

In this section we show the Francy Attributes.

##### 3.6-1 Width

`‣ Width`( arg ) | ( attribute )

Returns: `IsPosInt`

The Width of the `Canvas` in pixels `IsPosInt`.

##### 3.6-2 Width

`‣ Width`( arg1 ) | ( operation )

##### 3.6-3 SetWidth

`‣ SetWidth`( IsCanvas, IsPosInt ) | ( operation )

Sets the Width of the `Canvas` in pixels `IsPosInt`.

##### 3.6-4 Height

`‣ Height`( arg ) | ( attribute )

Returns: `IsPosInt`

The Height of the `Canvas` in pixels `IsPosInt`.

##### 3.6-5 Height

`‣ Height`( arg1 ) | ( operation )

##### 3.6-6 SetHeight

`‣ SetHeight`( IsCanvas, IsPosInt ) | ( operation )

Sets the Height of the `Canvas` in pixels `IsPosInt`.

##### 3.6-7 ZoomToFit

`‣ ZoomToFit`( arg ) | ( attribute )

Returns: `IsBool` True if enabled otherwise False

`ZoomToFit` is a property that sets the objects within the `Canvas` to fit within the GUI visible area, after rendering in the client implementation.

##### 3.6-8 ZoomToFit

`‣ ZoomToFit`( arg1 ) | ( operation )

##### 3.6-9 SetZoomToFit

`‣ SetZoomToFit`( IsCanvas, IsBool ) | ( operation )

`ZoomToFit` is a property that sets the objects within the `Canvas` to fit within the GUI visible area.

##### 3.6-10 Title

`‣ Title`( arg ) | ( attribute )

Returns: `IsString` with the title of the object

The `Canvas` title to show on the GUI.

##### 3.6-11 Title

`‣ Title`( arg1 ) | ( operation )

##### 3.6-12 SetTitle

`‣ SetTitle`( IsCanvas, IsString ) | ( operation )

Sets the title of the `Canvas`.

##### 3.6-13 TexTypesetting

`‣ TexTypesetting`( arg ) | ( attribute )

Returns: `IsBool` with the title of the object

Enables usage of TeX Typesetting on the client implementation, if supported.

##### 3.6-14 TexTypesetting

`‣ TexTypesetting`( arg1 ) | ( operation )

##### 3.6-15 SetTexTypesetting

`‣ SetTexTypesetting`( IsCanvas, IsBool ) | ( operation )

Sets TeX Typesetting on the canvas objects.

[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