<!-- This is an automatically generated file. -->
<Chapter Label="Chapter_Francy_Canvas">
<Heading>Francy Canvas</Heading>
A <C>Canvas</C> is an area where the graphics representation of Francy live.
<P/>
Please see Francy-JS for client implementation.
<Section Label="Chapter_Francy_Canvas_Section_Categories">
<Heading>Categories</Heading>
In this section we show all Francy Canvas Categories.
<ManSection>
<Filt Arg="arg" Name="IsCanvas" Label="for IsFrancyObject"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Identifies <C>Canvas</C> objects.
</Description>
</ManSection>
In this section we show all Francy Canvas Representations.
<ManSection>
<Filt Arg="arg" Name="IsCanvasRep" Label="for IsComponentObjectRep"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Checks whether an <C>Object</C> has a <C>Canvas</C> internal representation.
</Description>
</ManSection>
<ManSection>
<Filt Arg="arg" Name="IsCanvasDefaultsRep" Label="for IsComponentObjectRep"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Checks whether an <C>Object</C> has a <C>CanvasDefaults</C> internal representation.
</Description>
</ManSection>
In this section we show all Francy Canvas Operations.
<ManSection>
<Oper Arg="IsString(title)[, IsCanvasDefaults]" Name="Canvas" Label="for IsString, IsCanvasDefaults"/>
<Returns><C>Canvas</C>
</Returns>
<Description>
A <C>Canvas</C> 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:
<P/>
Create a simple <C>Canvas</C>:
<#Include Label="Example_Create_Canvas_1">
<P/>
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsFrancyGraph, List(IsFrancyGraph)]" Name="Add" Label="for IsCanvas, IsFrancyGraph"/>
<Returns><C>Canvas</C>
</Returns>
<Description>
Adds a <C>FrancyGraph</C> to a specific <C>Canvas</C>.
Well, the api is abstract enough to allow Adding a list of <C>IsFrancyGraph</C>
to a canvas, but this results in setting the graph property only to the last
<C>IsFrancyGraph</C> in the list.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsFrancyGraph, List(IsFrancyGraph)]" Name="Remove" Label="for IsCanvas, IsFrancyGraph"/>
<Returns><C>Canvas</C>
</Returns>
<Description>
Removes a <C>FrancyGraph</C> from a <C>Canvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsChart, List(IsChart)]" Name="Add" Label="for IsCanvas, IsChart"/>
<Returns><C>Canvas</C>
</Returns>
<Description>
Adds a <C>Chart</C> to a specific <C>Canvas</C>.
Well, the api is abstract enough to allow Adding a list of <C>IsChart</C>
to a canvas, but this results in setting the graph property only to the last
<C>IsChart</C> in the list.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsChart, List(IsChart)]" Name="Remove" Label="for IsCanvas, IsChart"/>
<Returns><C>Canvas</C>
</Returns>
<Description>
Removes a <C>Chart</C> from a <C>Canvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsMenu, List(IsMenu)]" Name="Add" Label="for IsCanvas, IsMenu"/>
<Returns><C>Canvas</C>
</Returns>
<Description>
Adds a <C>Menu</C> to a specific <C>Canvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsMenu, List(IsMenu)]" Name="Remove" Label="for IsCanvas, IsMenu"/>
<Returns><C>Canvas</C>
</Returns>
<Description>
Removes a <C>Menu</C> from a <C>Canvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsFrancyMessage, List(IsFrancyMessage)]" Name="Add" Label="for IsCanvas, IsFrancyMessage"/>
<Returns><C>IsCanvas</C>
</Returns>
<Description>
Adds a <C>FrancyMessage</C> to a specific <C>IsCanvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsFrancyMessage, List(IsFrancyMessage)]" Name="Remove" Label="for IsCanvas, IsFrancyMessage"/>
<Returns><C>IsCanvas</C>
</Returns>
<Description>
Removes a <C>FrancyMessage</C> from a specific <C>IsCanvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsFrancyRenderer, List(IsFrancyRenderer)]" Name="Add" Label="for IsCanvas, IsFrancyRenderer"/>
<Returns><C>IsCanvas</C>
</Returns>
<Description>
Adds a <C>FrancyRenderer</C> to a specific <C>IsCanvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, [IsFrancyRenderer, List(IsFrancyRenderer)]" Name="Remove" Label="for IsCanvas, IsFrancyRenderer"/>
<Returns><C>IsCanvas</C>
</Returns>
<Description>
Removes a <C>FrancyRenderer</C> from a specific <C>IsCanvas</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas" Name="Draw" Label="for IsCanvas"/>
<Returns><C>rec</C> with the JSON metadata model representation of the <C>Canvas</C>
</Returns>
<Description>
Generates the JSON metadata model representation of the <C>Canvas</C> object and all children objects.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas" Name="DrawSplash" Label="for IsCanvas"/>
<Returns><C>IsString</C> with HTML generated
</Returns>
<Description>
Generates an HTML page with an offline version od Francy JS and opens it within the default browser of the system.
</Description>
</ManSection>
In this section we show the Francy Attributes.
<ManSection>
<Attr Arg="arg" Name="Width" Label="for IsCanvas"/>
<Returns><C>IsPosInt</C>
</Returns>
<Description>
The Width of the <C>Canvas</C> in pixels <C>IsPosInt</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, IsPosInt" Name="SetWidth" Label="for IsCanvas, IsPosInt"/>
<Description>
Sets the Width of the <C>Canvas</C> in pixels <C>IsPosInt</C>.
</Description>
</ManSection>
<ManSection>
<Attr Arg="arg" Name="Height" Label="for IsCanvas"/>
<Returns><C>IsPosInt</C>
</Returns>
<Description>
The Height of the <C>Canvas</C> in pixels <C>IsPosInt</C>.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, IsPosInt" Name="SetHeight" Label="for IsCanvas, IsPosInt"/>
<Description>
Sets the Height of the <C>Canvas</C> in pixels <C>IsPosInt</C>.
</Description>
</ManSection>
<ManSection>
<Attr Arg="arg" Name="ZoomToFit" Label="for IsCanvas"/>
<Returns><C>IsBool</C> True if enabled otherwise False
</Returns>
<Description>
<C>ZoomToFit</C> is a property that sets the objects within the <C>Canvas</C> to fit within the GUI visible area,
after rendering in the client implementation.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, IsBool" Name="SetZoomToFit" Label="for IsCanvas, IsBool"/>
<Description>
<C>ZoomToFit</C> is a property that sets the objects within the <C>Canvas</C> to fit within the GUI visible area.
</Description>
</ManSection>
<ManSection>
<Attr Arg="arg" Name="Title" Label="for IsCanvas"/>
<Returns><C>IsString</C> with the title of the object
</Returns>
<Description>
The <C>Canvas</C> title to show on the GUI.
</Description>
</ManSection>
<ManSection>
<Oper Arg="IsCanvas, IsString" Name="SetTitle" Label="for IsCanvas, IsString"/>
<Description>
Sets the title of the <C>Canvas</C>.
</Description>
</ManSection>
<ManSection>
<Attr Arg="arg" Name="TexTypesetting" Label="for IsCanvas"/>
<Returns><C>IsBool</C> with the title of the object
</Returns>
<Description>
Enables usage of TeX Typesetting on the client implementation, if supported.
</Description>
</ManSection>
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.
