Skip to content

100_060_General_Layout

Francois Vancoppenolle edited this page Nov 4, 2016 · 9 revisions

Previous Chapter          Previous Page          Next Page          Next Chapter          Table of content

General Layout

Contents

canvasBackgroundColor

Description : sets a color for the background of the canvas

Chart types : All

Values : See

Default value : when not defined, the background of the canvas is transparent.

Sample : canvasBackgroundColor : "white"

See also :

canvasBorders

Description: specifiy if a border as to be drawn around the canvas.

Chart types : All

Values : true or false

Default value : false

Sample : canvasBorders : true

See also : canvasBordersColor, canvasBordersWidth

canvasBordersColor

Description: specify the color of the canvas border

Chart types : All

Values : any allowed color

Default value : “black”

Sample : canvasColor : "black"

See also : canvasBorders, canvasBordersWidth

canvasBorderStyle

Description: specify the style of the canvas border

Chart types : All

Values : any predefined value or an array or a function

Default value : "solid"

Sample : canvasBordersStyle : "dotted"

See also : canvasBorders, canvasBordersColor

canvasBordersWidth

Description: specify the widh of the canvas border

Chart types : All

Values : any integer

Default value : 3

Sample : canvasBordersWidth : 3

See also : canvasBorders, canvasBordersColor

footNote

Description: specify a text that has to be displayed at the bottom of the canvas.

Chart types : All

Values : a text

Default value : none

Sample : footNote : "text to be displayed at the bottom of the canvas"

See also : graphTitle, graphSubTitle,footNoteFontColor, footNoteFontFamily, footNoteFontSize, footNoteFontStyle

footNoteAlign

Description: by default, the footnote will be displayed at the center of the canvas. To put it on the right or on the left, change option footNoteAlign.

Chart types : All

Values : "center", "left", "right"

Default value : "center"

Sample : footNoteAlign : "left"

See also : footNoteShift

footNoteFontColor

Description: specify the color of the footnote – see footNote option.

Graph types : All

Values : any color

Default value : “#666”

Sample : fontNoteFontColor : "black"

See also : footNote, footNoteFontFamily, footNoteFontSize, footNoteFontStyle

footNoteFontFamily

Description: specify the font family of the footnote – see footNote option.

Chart types : All

Values : any available font (see chapter “Font Family”)

Default value : "'Arial'"

Sample : fontNoteFontFamily : "'Arial'"

See also : footNote,footNoteFontColor, footNoteFontSize, footNoteFontStyle

footNoteFontSize

Description: specify the font size (in pixel) of the footnote – see footNote option.

Chart types : All

Values : positive integer

Default value : 8

Sample : footNoteFontSize : 8

See also : footNote,footNoteFontColor, footNoteFontFamily, footNoteFontStyle

footNoteFontStyle

Description: specify the font type of the footnote – see footNote option.

Chart types : All

Values : any available font style(see chapter “Font Style”)

Default value : "bold"

Sample : fontNoteFontStyle : "bold"

See also : footNote,footNoteFontColor, footNoteFontFamily, footNoteFontSize

footNoteShift

Description: when the foot note is not at the center (see option footNoteAlign) you can specify the amount of points to leave between the border and the sub-title through option footNoteShift.

Chart types : All

Values : any positive value

Default value : 10

Sample : footNoteShift: 25

See also : footNoteAlign

graphSubTitle

Description: specify a text that has to be displayed as sub-title at the top of the canvas (under the title).

Chart types : All

Values : a text

Default value : none

Sample : graphSubTitle : "text to be displayed as sub-title"

See also : footnote, graphTitle, graphSubTitleFontColor, graphSubTitleFontFamily, graphSubTitleFontSize, graphSubTitleFontStyle

graphSubTitleAlign

Description: by default, the sub-Title will be displayed at the center of the canvas. To put it on the right or on the left, change option graphSubTitleAlign.

Chart types : All

Values : "center", "left", "right"

Default value : "center"

Sample : graphSubTitleAlign : "left"

See also : graphSubTitleShift

graphSubTitleFontColor

Description: specify the color of the sub-title – see graphSubTitle option.

Chart types : All

Values : any color

Default value : "#666"

Sample : graphSubTitleFontColor : "#666"

See also : graphSubTitle, graphSubTitleFontFamily, graphSubTitleFontSize, graphSubTitleFontStyle

graphSubTitleFontFamily

Description: : specify the font family of the sub-title – see graphSubTitle option.

Chart types : All

Values : any available font (see chapter “Font Family”)

Default value : "'Arial'"

Sample : graphSubTitleFontFamily : "'Arial'"

See also : graphSubTitle, graphSubTitleFontColor, graphSubTitleFontSize, graphSubTitleFontStyle

graphSubTitleFontSize

Description: specify the font size (in pixel) of the sub-title – see graphSubTitle option.

Chart types : All

Values : positive integer

Default value : 18

Sample : graphSubTitleFontSize : 18

See also : graphSubTitle, graphSubTitleFontColor, graphSubTitleFontFamily, graphSubTitleFontStyle

graphSubTitleFontStyle

Description: specify the font type of the sub-title – see graphSubTitle option.

Chart types : All

Values : any available font style(see chapter “Font Style”)

Default value : "normal"

Sample : graphSubTitleFontStyle : "normal"

See also : graphSubTitle, graphSubTitleFontColor, graphSubTitleFontFamily, graphSubTitleFontSize

graphSubTitleShift

Description: when the sub-title is not at the center (see option graphSubTitleAlign) you can specify the amount of points to leave between the border and the sub-title through option graphSubTitleShift.

Chart types : All

Values : any positive value

Default value : 10

Sample : graphSubTitleShift : 25

See also : graphSubTitleAlign

graphTitle

Description: specify a text that has to be displayed as title at the top of the canvas.

Chart types : All

Values : a text

Default value : none

Sample : graphTitle : "text to be displayed as title"

See also : footnote, graphSubTitle, graphTitleFontColor, graphTitleFontFamily, graphTitleFontSize, graphTitleFontStyle

graphTitleAlign

Description: by default, the title will be displayed at the center of the canvas. To put it on the right or on the left, change option graphTitleAlign.

Chart types : All

Values : "center", "left", "right"

Default value : "center"

Sample : graphTitleAlign : "left"

See also : graphTitleShift

graphTitleFontColor

Description: specify the color of the title – see graphTitle option.

Chart types : All

Values : any color

Default value : "#666"

Sample : graphTitleFontColor : "#666"

See also : graphTitle, graphTitleFontFamily, graphTitleFontSize, graphTitleFontStyle

graphTitleFontFamily

Description: : specify the font family of the title – see graphTitle option.

Chart types : All

Values : any available font (see chapter “Font Family”)

Default value : “’Arial’”

Sample : graphTitleFontFamily : "'Arial'"

See also : graphTitle, graphTitleFontColor, graphTitleFontSize, graphTitleFontStyle

graphTitleFontSize

Description: specify the font size (in pixel) of the sub-title – see graphTitle option.

Chart types : All

Values : positive integer

Default value : 24

Sample : graphTitleFontSize : 18

See also : graphTitle, graphTitleFontColor, graphTitleFontFamily, graphTitleFontStyle

graphTitleFontStyle

Description: specify the font type of the sub-title – see graphTitle option.

Chart types : All

Values : any available font style(see chapter “Font Style”)

Default value : "bold"

Sample : graphTitleFontStyle : "bold"

See also : graphTitle, graphTitleFontColor, graphTitleFontFamily, graphTitleFontSize, Chart Layout

graphTitleShift

Description: when the title is not at the center (see option graphTitleAlign) you can specify the amount of points to leave between the border and the title through option graphTitleShift.

Chart types : All

Values : any positive value

Default value : 10

Sample : graphTitleShift : 25

See also : graphTitleAlign

Previous Chapter          Previous Page          Next Page          Next Chapter          Top of Page

Clone this wiki locally