ChartDirector 5.1 (PHP Edition)

XYChart.setClipping


Usage

setClipping([ margin ])

Description

Enables clipping on the plot area.

In normal usage, ChartDirector will auto-scale the axis to ensure all the data points will be within the plot area.

However, if manual scaling is used (e.g. using Axis.setLinearScale), it is possible to choose an axis scale such that some data points will be outside the plot area. So some of the data representation (bars, lines, etc) will be outside the plot area.

This method can be used to clip the plot area, so that any data representation that is outside the plot area will not be drawn.

Arguments

ArgumentDefaultDescription
margin0Additional margin, measured in pixels, to be added to the 4 sides of the plot area for the purpose of clipping. A positive value means the clipping region will be larger than the plot area. A negative value means the clipping region will be smaller than the plot area. 0 means the clipping region is equal to the plot area.

Return Value

None