ChartDirector 7.0 (Perl Edition)

ArrayMath.shift


Usage

shift([ offset [, fillValue ]])

Description

Shifts the array "rightwards".

If the array does not have any NoValue data points, this method will shift the point at position "n" to "n + offset". On the "right" side of the array (the side with the largest index), points that are shifted outside the array will be discarded. On the "left" side of the array, fillValue data points will be shifted in.

If the array contains NoValue data points, these points are not shifted. Conceptually, one can imagine the non-NoValue points being shifted to the next non-NoValue positions, and the process repeats offset number of times.

Arguments

ArgumentDefaultDescription
offset1The number of positions to shift the array "rightwards."
fillValueNoValueThe new value to be shifted into the array.

Return Value

The current ArrayMath object.