SetPlotAreaBgImage
Prev | PHPlot Function Reference | Next

## SetPlotAreaBgImage

SetPlotAreaBgImage — Set a graphic file to be used in the plot area background

## Synopsis

    $plot->SetPlotAreaBgImage($input_file, [$mode])

## Description

`SetPlotAreaBgImage` sets an image file to be used as the plot area background. The image can be scaled or tiled to fit.

## Parameters

`$input_file`

  Path to the file to be used. The file can be any type allowed by GD, which usually includes JPEG, GIF, and PNG.

`$mode`

  Optional display mode for the background image: one of the strings 'centeredtile', 'tile', or 'scale'. The default is 'tile'.

## Notes

If a background image has been set, background color (set with SetPlotBgColor) is ignored.

Scale mode scales the supplied background image file to fit the plot area. Tile and centeredtile modes repeat the supplied background image file as needed to fit the plot area. The difference is that centeredtile offsets the start position within the background image by half its size, which works better for some images.

SetPlotAreaBgImage sets a background for the plot area, while SetBgImage sets a background for the entire image area. If both are used, the plot area background overlays that portion of the overall background.

Prev | Up | Next
SetOutputFile | Home | SetPlotAreaPixels