Meter=Image displays either an image defined by a measure value, or any named image. If
H are included in the meter options, the image will be scaled to fit the meter size.
Supported image formats are .png, .jpg, .bmp, .gif (no animation supported), .tif, .webP, and .ico.
Note: If no file extension is included, .png is assumed.
- General meter options
All general meter options are valid.
- General image options
All general image options are valid for
Name(s) of the measure(s) bound to the meter. The value of a measure or measures will define the image file to be used in the meter. The value can define a full path and name of any supported image file, or just the name if the ImagePath option is used or the image file is in the current skin folder.
Name of an image file. This can be a full path and name of any supported image file, or just the name of the file if the ImagePath option is used or the image file is in the current skin folder.
Note: If aThe exceptions are when
MeasureNameNoption is defined, it will override any named file in the
ImageNamewill not be used together in the same meter.
MeasureNamereturns a file name with no extension, and the default .png is not desired, or when
ImageNameis being used to define an image based on the combined values of the measures in
MeasureNameNand uses the
%Nsyntax as follows:
; %1 and %2 will be replaced by the string values of SomeMeasure and
; SomeMeasure2, respectively.
ImageNameis hard-coded with an image file name, the image will be loaded and "cached", to avoid reloading the image from disk on every meter update. If there is an external process that is changing the image file, while leaving the name the same, use
DynamicVariables=1on the meter to force the image to be reloaded from disk on every meter update.
Hscale the image when
Tile=0. Valid values are:
0: The image is scaled to exactly fit the bounds specified by
Hwithout regard to aspect ratio.
1: The image is scaled to fit within the bounds specified by
Hwhile preserving the aspect ratio.
2: The image is scaled and cropped to fill the bounds specified by
Hwhile preserving the aspect ratio.
Note: If only one of either
His defined, then PreserveAspectRatio will default to
Left, Top, Right, Bottom
Margins of the image to exclude from scaling when
ScaleMargins=10, 50, 10, 50
If set to
1, the image is tiled (repeated) within the bounds defined by
However, no manipulations can be done to the resulting square, rectangle or line with any general image options. Only actual images loaded from a file can be manipulated. (e.g. ImageRotate)
The following options have been deprecated and should not be used. They are still supported, but may be removed in future versions.
The Path option to define the location of images is replaced by the ImagePath option in general image options.
Note: This MaskImage functionality is better done with the far more powerful and flexible Container option. MaskImage will continue to be supported, but is no longer recommended.
Name of an image file to use as a mask for the primary image defined with MeasureName or ImageName. The size and shape of MaskImageName will be used to mask and define the size and shape of the primary image.
MaskImageName can be a full path and name of any supported image file, or just the name of the file if the MaskImagePath option is used, or the image file is in the current skin folder.
If MaskImageName is defined, then
Hdefine the size of the mask image, and the size of the meter. Whatever is defined as the primary image with ImageName or MeasureName is then masked into the mask image, displaying in any non-transparent areas of MaskImageName using a "fill" method that sizes and crops the image to fit while preserving the aspect ratio.
If either the primary image or mask image has areas of transparency or partial transparency, those "alpha channel" values are applied to the final image. When both images have a shared area with full or partial transparency, the "most transparent" value is applied.
MaskImageName cannot be bound to the meter from a measure with MeasureNameN and %1, %2 etc.
Folder path where an image is located. (e.g.
Flips the image. Valid values are
Rotates the image by the specified angle in degrees. Negative angles can be used for counter-clockwise rotation.