Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The abstract chart expression is at the top of the hierarchy. Therefore, it follows that it contains properties that can be applied to all of the different chart types.

AbstractChartExpression Properties

Property Name

Data Type

Description

antiAlias

Boolean (true/false)

Anti-aliasing is a technique of minimizing aliasing (jagged or blocky patterns) when plotting images. Default is true.

backgroundColor

String

Sets the color of the background of the chart. It is a color in either HTML notation (like #80f000), or one of the w3c defined color names (like "cadet blue").

backgroundImage

String

Defines an image that's used in rendering the chart background. The image specified needs to be relative to the solution root. Example that loads an image from the test solution in the charts folder within that solution.
<property name="backgroundImage">test/charts/ChartBackground.jpg</property>

borderColor

String

Sets the color of the border, if showBorder is set to true. It is a color in either HTML notation (like #80f000), or one of the w3c defined color names (like "cadet blue").

chartHeight

Integer

Height of the chart graphic in pixels.

chartSectionOutline

Boolean (true/false)

If true, draws each chart section with an outline stroke. Default: false

webserver is used to serve up the chart images. |

chartWidth

Integer

Width of the chart graphic in pixels.

dataSource

A xxxSetCollector function - see above

Before the chart can be rendered, it must have data collected by one of the available collector functions. This needs to be the name of the xxxSetCollectorFunction in the report document.

drawLegendBorder

Boolean (true/false)

If showLegend is true, draws a border around the legend. Default: true

labelFont

String

Font for the labels. The format for the font is as follows:
fontfamilyname-style-pointsize
Style can be one of: BOLD, BOLDITALIC, or ITALIC
Example: Arial-BOLD-14
Default: SansSerif—8

legendFont

String

The font used on the legend. The format for the font is as follows:
fontfamilyname-style-pointsize
Style can be one of: BOLD, BOLDITALIC, or ITALIC
Example: Arial-BOLD-14
Default: SansSerif—8

legendLocation

String

Used for placing the legend, if showLegend is true. Valid values: left, west, right, east, top, north, bottom, south. Note that left and west are the same as are the other pairs. Default depends on the JFreeChart default settings.

showBorder

Boolean (true/false)

If true, the chart will have a border around it.

showLegend

Boolean (true/false)

If true, shows the legend on the chart.

threeD

Boolean (true/false)

If true, the chart is rendered in 3D (with shading and an apparent thickness). Default: false

title

String

The chart title.

titleFont

String

The font for the chart title. The format for the font is as follows:
fontfamilyname-style-pointsize
Style can be one of: BOLD, BOLDITALIC, or ITALIC
Example: Arial-BOLD-14
Default: SansSerif-BOLD-14

useDrawable

Boolean (true/false)

Determines how the chart gets returned to the JFreeReport engine. If false, then the chart image is rendered in a file for use with the image-url function in the chart. Note that with HTML reports, using drawable is not useful unless the HTML File System in place is something other than the StreamHTMLFileSystem (the default in Pentaho).

UPDATE: As of version 1.6, useDrawable should ALWAYS be true, as the image-url field no longer supports input from the chart expressions.
Default: true

chartDirectory
DEPRECATED as of 1.6

String

Specifies the folder into which the charts will be generated. Defaults to the system/tmp folder within the root solution.

chartFile
DEPRECATED as of 1.6

String

Provides the ability to tell the engine the name of the file to generate. By default, the engine generates a temporary file.

returnFileNameOnly
DEPRECATED as of 1.6

Boolean

If true, the function will only return the name of the file that was generated. Default: false

chartUrlMask
DEPRECATED as of 1.6

String

Specifies a URL containing a replaceable marker ({0}) for the file name. This is useful when the chart image is generated into a folder, and a different

Class Descendants

  • No labels