Gauge customizations

The gauge parameters that you specify tell the server how to draw the gauge image. These parameters specify that the gauge's needle is in the correct location.

When specifying parameters, note the following:

  • You must specify the location of the minimum and maximum scale.

    The tic locations for threshold one and threshold two must be consistent.

  • You must specify the sweep bounding box, which is the rectangle that defines the region in which the needle is drawn.
  • The needle moves clockwise when you specify larger values.
  • If you use the gauge defaults and maintain the ratios of gaugel.gif, you can change the image and not have to specify any options.
  • All parameters are relative to the actual size of the image.

This table shows each parameter that you can use to customize a gauge, its corresponding description, and the parameter's valid values.

Parameter Description Valid Values
img This parameter specifies the base name of the image. Any valid GIF or JPEG image.
dialType This parameter overrides the calculated image prefix name. This parameter is useful to display a table that is not the result of a condition.
  • rg
  • gr
  • gyr
  • ryg
  • rgr
  • grg
  • n
sVert This parameter specifies the orientation of the gauge. When you set this parameter to true, the gauge is displayed vertically, like a mercury thermometer.
  • true
  • false

The default is true if the image is higher than it is wide.

sweepWidth This parameter specifies the length of the needle. Integer in pixels.

The default is one-half of the image's height.

boxX This parameter specifies the X coordinate of the bounding box used to contain the sweep of the needle.

Integer in pixels

The default is zero.

boxY This parameter specifies the Y coordinate of the bounding box used to contain the sweep of the needle. Integer in pixels

The default is zero.

boxW This parameter specifies the width of the bounding box used to contain the sweep of the needle. Integer in pixels

The default is the image's width.

boxH This parameter specifies the height of the bounding box used to contain the sweep of the needle. Integer in pixels

The default is the sweepWidth.

debug If you set this value to true, the sweep box is drawn in magenta.

This parameter is useful when you are setting up a new image's options.

  • true
  • false

The default is false.