Skip to content
FVANCOP edited this page Oct 6, 2014 · 20 revisions

Previous Chapter          Previous Page          Next Page          Next Chapter          Table of content

Legend

Pie

Contents

legend

Description: At the bottom of the graph, it is possible to dispay a legend with a description of each color. Use option legend to draw the legend (legend : true) or to hide the legend (legend : false).

Graph Type : all

Values : true or false

Default Value : false

Sample : legend : true.

See also: inGraphDataDisplay

legendBlockSize

Description: the size of the blocks in the legend is defined with option legendBlockSize (in pixels). Remark : the height of the block is equal to the value of option legendFontSize.

Graph Type : all

Values : any positive value.

Default Value : 15

Sample : legendBlockSize : 20.

See also: legendFontSize

legendBorders

Description: If you want to surround the block with a border, set option legendBorders to true.

Graph Type : all

Values : true or false

Default Value : true

Sample : legendBorders : true

See also: legendBordersColors, legendBordersWidth

legendBordersColors

Description: set the color of the borders surrounding the block with option legendBordersColor

Graph Type : all

Values : any valid color

Default Value : "#666"

Sample :

See also: legendBorders, legendBordersWidth

legendBordersWidth

Description: set the width of the borders surrounding the block with option legendBordersColor

Graph Type : all

Values : any positive integer

Default Value : 1

Sample : legendBorderWidth : 3

See also:legendBorders, legendBordersColor

legendFontColor

Description: specify the color of the text in the legend

Graph Type : all

Values : any valid color

Default Value : "#666"

Sample : legendFontColor : “black”

See also: legend, legendFontSize, legendFontStyle, legendFontFamily

legendFontFamily

Description: specify the font of the text in the legend

Graph Type : all

Values : any valid font

Default Value : "'Arial'"

Sample :

See also: legend, legendFontSize, legendFontStyle, legendFontColor

legendFontSize

Description: specify the size of the text in the legend

Graph Type : all

Values : any positive integer

Default Value : 12

Sample : legendFontSize : 10

See also: legend, legendFontStyle, legendFontFamily, legendFontColor

legendFontStyle

Description: specify the style of the text in the legend

Graph Type : all

Values : any valid font style

Default Value : “normal”

Sample : legendFontStyle : “italic”

See also: legend, legendFontSize, legendFontFamily, legendFontColor

legendColorIndicatorStrokeWidth

Description: If you use the datasetFill:false option in line charts you may want to change the height of the legend color.

Graph Types: line

Values: integer (px)

Default value: datasetStrokeWidth

Sample: datasetStrokeWidth:10

See also: #68

legendFillColor

Description: By default, the background color of the legend is transparent; With option legendFillColor, you can specify a color for the background of the legend. A color should be specified when the legend is displayed over the graph.

Graph Types: All

Values: : any color

Default value: "rgba(0,0,0,0)

Sample: legendFillColor : "white"

See also: legendPosY, legendPosY

legendPosX

Description: with legendPosX, you can specify a horizontal position for the legend; By default, the legend is displayed in the middle of the canvas (legendPosX=-2). With legendPosX, you can set the legend at another place.

Graph Types: All

Values: : -2, 0, 1, 2, 3, or 4

-2 : the legend is displayed at the center of the canvas; 0 : the legend is displayed at the left part of the canvas; 1 : the legend is displayed at the left part of the graph; 2 : the legend is displayed at the center of the graph; 3 : the legend is displayed at the right part of the graph; 4 : the legend is displayed at the right part of the canvas.

Default value: -2

Sample: legendPosX : 3

See also: legendXPadding, legendPosY, maxLegendCols

legendPosY

Description: with legendPosY, you can specify a vertical position for the legend; By default, the legend is displayed in the bottom of the canvas (legendPosY=4). With legendPosY, you can set the legend at another place.

Graph Types: All

Values: : 0, 1, 2, 3, or 4

0 : the legend is displayed at the top part of the canvas (between the graph and the subtitle); 1 : the legend is displayed at the top part of the graph; 2 : the legend is displayed at the center of the graph; 3 : the legend is displayed at the bottom part of the graph (over the X scales); 4 : the legend is displayed at the bottom part of the canvas (between the graph and the footnote).

Default value: 4

Sample: legendPosY : 2

See also: legendXPadding, legendPosY, maxLegendCols

legendXPadding

Description: with legendPosX, you can specify a horizontal position for the legend; With legendXPadding, you can specify a displacement in point on the horizontal direction.

Graph Types: All

Values: any positive or negative integer

Default value: 0

Sample: legendXPadding : -10

See also: legendYPadding, legendPosX

legendYPadding

Description: with legendPosY, you can specify a vertical position for the legend; With legendYPadding, you can specify a displacement in point on the vertical direction.

Graph Types: All

Values: any positive or negative integer

Default value: 0

Sample: legendYPadding : 10

See also: legendXPadding, legendPosY

maxLegendCols

Description: specify the maximum number of columns for the legend.

Graph Types: All

Values: any positive integer

Default value: 999

Sample: mxLegendCols : 1

See also:

showSingleLegend

Description: If there is only one value in the legend, the legend is not displayed (in most of the case, poeple knows the signification of the unique displayed element in the graph). You can force the display of the legend even when there is only one value with option showSingleLegend.

Graph Types: All

Values: true or false

Default value: false

Sample: showSingleValue : true

See also:

Previous Chapter          Previous Page          Next Page          Next Chapter          Top of Page

Clone this wiki locally