Big Faceless Graph Library 2.3 Tag Documentation - Copyright © 2006 Big Faceless Organization

axesgraph

Description

The "axesgraph" tag is one of the two top level tags that can be used to create a graph (the others being "piegraph" and "dialgraph"). This tag and it's contents define a graph, which is replaced by an image in the resulting HTML document.

Many of the attributes that can be set on this tag are attributes that apply to the image rather than affecting the graph. For instance, setting the "border" attribute will have no effect on the graph that's generated, but will modify the HTML used to display the image. Additionally some of these attributes may not be applicable to a particular type of graph type.

Valid Children

label? key? axis* ( barseries | lineseries | stackedbarseries | multibarseries | bubbleseries | candleseries | boxwhiskerseries | functionseries areaseries splineseries )+

Examples

Example: Create the simplest Bar Graph possible
<axesgraph width="200" height="200">
  <barseries name="Fruit Consumption">
    <data x="Apples" y="20" />
    <data x="Oranges" y="15" />
  </barseries>
</axesgraph>

See Also

Attributes

backwallpaint Wallpaint optional XML / Tag Library

Description

What to paint the back wall of the AxesGraph with. The value may be a standard color, or it may use the stripe(...) syntax to paint the back wall with stripes or a grid pattern.

The syntax for stripe is stripe( paint*, axis=left|bottom|right|top [, line=color] [, altaxis=left|bottom|right|top] [,dash=[,n n..] [,linethickness=n] [,boxed=true|false]] ). In other words you can specify a list of zero or more paints which will be used to fill the back wall in alternating stripes. If no paint is specified the back wall is transparent. A "line=" attribute may also be added to set the color of the lines separating the stripes. These stripes will be aligned with the specified axis, and if an "altaxis" is specified then lines will also be drawn from that axis to form a grid. If lines are to be drawn, the "dash" attribute can be set to the dash array, and "linethickness" can be set to alter the thickness of the drawn lines. See some of the examples below for more detail.

Examples

Example: Paint the back wall in horizontal stripes of yellow and gray
<axesgraph backwallpaint="stripe(yellow,gray,axis=left)"> ... </axesgraph>
Example: Leave the back wall transparent except for a grid of black lines
<axesgraph backwallpaint="stripe(line=black,axis=left,altaxis=bottom)"> ... </axesgraph>
Example: Paint the back wall in vertical stripes, overlaid with a grid of black lines
<axesgraph backwallpaint="stripe(yellow,gray,line=black,axis=bottom,altaxis=left)"> ... </axesgraph>
horizontalscale Real[4] optional XML / Tag Library

Description

The horizontal scale can be set to control scaling when the graph has both a bottom and a top axis. The four parameters identify two control points on each axis which should be aligned.

See Also

verticalscale Real[4] optional XML / Tag Library

Description

The vertical scale can be set to control scaling when the graph has both a left and a right axis. The four parameters identify two control points on each axis which should be aligned.

See Also

xrotation Real optional XML / Tag Library

Description

How much to rotate the image around the X axis
yrotation Real optional XML / Tag Library

Description

How much to rotate the image around the Y axis
zrotation Real optional XML / Tag Library

Description

How much to rotate the image around the Z axis. A value of "NaN' may be used on piegraphs to auto-rotate the graph to give the largest visual appearance.
defaultcolors Paint[n] optional XML / Tag Library

Description

Defines a list of colors that should be used to paint the data objects (series or pie slices) in the graph. The list of colors should be at least one long and separated by commas. See the Colors section for more information on colors.

Examples

Example: To use bright primary colors to display the graph
<axesgraph defaultcolors="#FF0000, #00FF00, #0000FF, #FFFF00"> ... </axesgraph>
Example: To use a color and a texture as paints
<axesgraph defaultcolors="#FF0000, http://localhost/mytexture.png"> ... </axesgraph>

See Also

bordercolor Color optional XML / Tag Library

Description

The color to use as the border color for the specified object. May be "none" to not draw a border for this object.
backgroundcolor Paint optional Tag Library Only

Description

The background paint to give to the image. The default is "white", but "transparent" or another color can be used.

Examples

Example: To use a color and a texture as paints
<axesgraph backgroundcolor="transparent(red)"> ... </axesgraph>
numcolors Integer - 0 or a power of 2 optional Tag Library Only

Description

For bitmap image formats like PNG, the number of colors that the image should be reduced to. If the default of "0" is used, the returned PNG is a 24-bit truecolor image. Other values will cause the image to be "quantized" to a smaller number of colors, which takes longer but results in smaller images. Valid values are any power of 2 between 2 and 256
lightlevel Real from 0 to 100 optional XML / Tag Library

Description

How much shading to apply to the image when displayed in 3D
lightvector Real[3] optional XML / Tag Library

Description

The vector that the light is coming from. The three parameters represent the X, Y and Z components of a vector where (0,0,0) is in the center of the graph.

Examples

Example: To display the light coming from the right hand side of the graph
<axesgraph lightvector="1,0,0"> ... </axesgraph>
format png | flash | svg | rg1pdf optional Tag Library Only

Description

The format to create the image in. Currently allowed values include "svg", "flash" or "png" (the default). The value "rg1pdf" was added in 2.2.3 and can be used to embed a vector image graph into a PDF created with the Report Generator version 1.x.
fixedzoom Real optional XML / Tag Library

Description

A real number determining the zoom level to fix the image at. Normally the graph is sized to fit the image as best as possible, but where several identical images are to be produced (eg. for rollovers) then this value, along with "fixedx" and "fixedy" can be set to control the location of the image. The default value of "0" causes the image to be sized to fit as normal.

Examples

Example: an example of the fixedzoom attribute
<piegraph fixedzoom="100" fixedx="150" fixedy="150"> ... </piegraph>

See Also

fixedx Real optional XML / Tag Library

Description

A real number determining the X offset to add to the (0,0) position on the graph. See the "fixedzoom" tag for more info.

See Also

fixedy Real optional XML / Tag Library

Description

A real number determining the Y offset to add to the (0,0) position on the graph. See the "fixedzoom" tag for more info.

See Also

padding Integer[1..4] optional XML / Tag Library

Description

  • (for text) How much spacing to put around the text
  • (when used on an "axesgraph" or "piegraph" tag in the Tag Library only) how much spacing to put arund the graph as a whole
  • (when used on a "key") how much spacing to put inside the key around the interior items.
Padding is specified as in CSS - a single value can be used to specify the padding on all sides; two values specify top/bottom and left/right, three values specify top, bottom and left/right, and four values specify top, right, bottom and left.
paddingtop Integer optional XML / Tag Library

Description

Specify top padding only.
paddingright Integer optional XML / Tag Library

Description

Specify right padding only.
paddingbottom Integer optional XML / Tag Library

Description

Specify bottom padding only.
paddingleft Integer optional XML / Tag Library

Description

Specify left padding only.
dpi integer optional Tag Library Only

Description

The DPI that should be used to embed a PNG graph image into the Report Generator. Should not be used in other circumstances. The default value is 72, and a typical value for a PDF intended for printing would be 200.
urlprefix String optional Tag Library Only

Description

The prefix that should be applied to the URL used to retrieve the image. This will obly be required when the XML created is not parsed on the client browser but on the server (as in when a graph is embedded in the Report Generator). An example value would be "https://user:password@localhost", which will be prefixed to any requests.
autocolors Paint[2] optional XML / Tag Library

Description

Can specify two colors which are used to auto-color the Graph. The series or pie slices have colors chosen for them in the range from the first to the second color.

Examples

Example: To use shades of blue to color the graph
<axesgraph autocolors="#0000A0, #D0D0FF"> ... </axesgraph>

See Also

colorordering String optional XML / Tag Library

Description

Controls the order of auto-generated colors, this can be set to the value "value" or left at the default.
options String optional XML / Tag Library

Description

Comma separated list of options to pass into the setOption method, for example markerPriority=true
align box? (top | middle | bottom) (left | center | right) optional Tag Library Only

Description

How to align the graph image relative to it's "control point". The "align" value is one or two words, specifying a horizontal alignment, vertical alignment or both. For example, to specify just a horizontal alignment do align="center" (the vertical alignment is undefined). To align horizontally and vertically, do align="center middle". As in HTML, "middle" refers to vertical alignment and "center" refers to horizontal. The special value "box" can be used in an <axes> to require all the items in the axis are aligned as a group, rather than individually.
alt Text optional Tag Library Only

Description

The "alt" attribute of the image
border Pixels optional Tag Library Only

Description

The "border" attribute of the image
height Integer mandatory Tag Library Only

Description

The "height" attribute of the image. Since graphs do not have an implied width or height, these parameters are mandatory and must be absolute values - ie width="50" not width="50%".

See Also

hspace Pixels optional Tag Library Only

Description

The "hspace" attribute of the image
longdesc URI optional Tag Library Only

Description

The "longdesc" attribute of the image
vspace Pixels optional Tag Library Only

Description

The "vspace" attribute of the image
width Integer mandatory Tag Library Only

Description

The "width" attribute of the image. Since graphs do not have an implied width or height, these parameters are mandatory and must be absolute values - ie width="50" not width="50%".

See Also

wmode window | opaque | transparent optional Tag Library Only

Description

The "wmode" attribute of the flash movie, which sets the flash movie to run in an opaque or transparent window
id Name optional Tag Library Only

Description

The "id" attribute of the graph image

See Also

htmlclass CDATA-list optional Tag Library Only

Description

The "class" attribute of the graph image.

See Also

title Text optional Tag Library Only

Description

The "title" attribute of the image
style Style optional Tag Library Only

Description

The "style" attribute of the image
lang Language-code optional Tag Library Only

Description

The "lang" attribute of the image
onclick script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the click event occurs on a region of the graph
ondblclick script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the dblclick event occurs on a region of the graph
onkeydown script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the keydown event occurs on a region of the graph
onkeypress script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the keypress event occurs on a region of the graph
onkeyup script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the keyup event occurs on a region of the graph
onmousedown script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the mousedown event occurs on a region of the graph
onmousemove script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the mousemove event occurs on a region of the graph
onmouseout script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the mouseout event occurs on a region of the graph
onmouseover script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the mouseover event occurs on a region of the graph
onmouseup script optional Tag Library Only

Description

Used in interactive graphs to set what happens when the mouseup event occurs on a region of the graph
Big Faceless Graph Library 2.3 Tag Documentation - Copyright © 2006 Big Faceless Organization