ChartDirector 5.1 (PHP Edition)

phpchartdir.RegularSpacingFilter


Usage

RegularSpacingFilter([ labelStep [, initialMargin ]])

Description

Creates a data filter that matches 1 out of every N elements.

This method is typically used in Axis.setMultiFormat and Axis.setMultiFormat2 to select specific elements for formatting as axis labels.

Arguments

ArgumentDefaultDescription
labelStep1Picks 1 out of every "labelStep" number of elements. For example, if this argument is 3, only 1 of every 3 elements will be selected.
initialMargin0Adds an offset when determining the elements to be selected. For example, if the labelStep is 3, the selected indexes should be 0, 3, 6, 9, .... If initialMargin is set to 1, the indexes becomes 1, 4, 7, 10, ....

Return Value

An integer filter id representing the filter.