A Canvas
is an area where the graphics representation of Francy live.
Please see Francy-JS for client implementation.
In this section we show all Francy Canvas Categories.
‣ IsCanvas ( arg ) | ( filter ) |
Returns: true
or false
Identifies Canvas
objects.
‣ IsCanvasDefaults ( arg ) | ( filter ) |
Returns: true
or false
Identifies CanvasDefaults
objects.
In this section we show all Francy Canvas Families.
In this section we show all Francy Canvas Representations.
‣ IsCanvasRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a Canvas
internal representation.
‣ IsCanvasDefaultsRep ( arg ) | ( filter ) |
Returns: true
or false
Checks whether an Object
has a CanvasDefaults
internal representation.
In this section we show all Francy Canvas Operations.
‣ Canvas ( IsString(title)[, IsCanvasDefaults] ) | ( operation ) |
Returns: Callback
Canvas represents a base element to draw graphics on. 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);
‣ 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.
‣ Remove ( IsCanvas[, IsFrancyGraph, List(IsFrancyGraph)] ) | ( operation ) |
Returns: Canvas
Removes a FrancyGraph
from a Canvas
.
‣ 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.
‣ Remove ( IsCanvas[, IsChart, List(IsChart)] ) | ( operation ) |
Returns: Canvas
Removes a Chart
from a Canvas
.
‣ Add ( IsCanvas[, IsMenu, List(IsMenu)] ) | ( operation ) |
Returns: Canvas
Adds a Menu
to a specific Canvas
.
‣ Remove ( IsCanvas[, IsMenu, List(IsMenu)] ) | ( operation ) |
Returns: Canvas
Removes a Menu
from a Canvas
.
‣ Add ( IsCanvas[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation ) |
Returns: IsCanvas
Adds a FrancyMessage
to a specific IsCanvas
.
‣ Remove ( IsCanvas[, IsFrancyMessage, List(IsFrancyMessage)] ) | ( operation ) |
Returns: IsCanvas
Removes a FrancyMessage
from a specific IsCanvas
.
‣ Draw ( IsCanvas ) | ( operation ) |
Returns: rec
with json representation of the canvas
Generates the JSON representation of the canvas and children objects
‣ DrawSplash ( IsCanvas ) | ( operation ) |
Returns: rec
with html generated
Generates an HTML page and opens it within the default browser of the system
In this section we show all Global Francy Canvas Records for multi purpose.
In this section we show the Francy Attributes
‣ Width ( arg ) | ( attribute ) |
Returns: IsPosInt
The Width of the canvas in pixels
‣ Width ( arg1 ) | ( operation ) |
‣ SetWidth ( IsCanvas, IsPosInt ) | ( operation ) |
Sets the Width of the canvas in pixels
‣ Height ( arg ) | ( attribute ) |
Returns: IsPosInt
The Height of the canvas in pixels
‣ Height ( arg1 ) | ( operation ) |
‣ SetHeight ( IsCanvas, IsPosInt ) | ( operation ) |
Sets the Height of the canvas in pixels
‣ ZoomToFit ( arg ) | ( attribute ) |
Returns: IsBool
True if enabled otherwise False
ZoomToFit
is a property that sets the zoom to fit behavior on change in the client implementation.
‣ ZoomToFit ( arg1 ) | ( operation ) |
‣ SetZoomToFit ( IsCanvas, IsBool ) | ( operation ) |
ZoomToFit
is a property that sets the zoom to fit behavior on change in the client.
‣ Title ( arg ) | ( attribute ) |
Returns: IsString
with the title of the object
A title on a required arg is used to ask the user what is expected from his input.
‣ Title ( arg1 ) | ( operation ) |
‣ SetTitle ( IsCanvas, IsString ) | ( operation ) |
Sets the title of the required arg.
‣ TexTypesetting ( arg ) | ( attribute ) |
Returns: IsBool
with the title of the object
Enables usage of Tex typestting on the client implementation, if supported.
‣ TexTypesetting ( arg1 ) | ( operation ) |
‣ SetTexTypesetting ( IsCanvas, IsBool ) | ( operation ) |
Sets Tex typestting on the canvas objects
generated by GAPDoc2HTML