HideRange function

The HideRange function marks as invisible a range of elements between a starting time stamp and an ending time stamp.

Syntax

HideRange(ts     TimeSeries, 
        start   datetime year to fraction(5), 
        end     datetime year to fraction(5),
        flags   integer default 0
) 
returns TimeSeries;

ts: The time series to act on.
start: The starting time stamp.
end: The ending time stamp.
flags: Valid values for the flags parameter are described in The flags argument values. The default is 0.

Description

After an element is hidden, reading that element returns NULL and writing it results in an error message. It is, however, possible to use ts_begin_scan() to read hidden elements, as described in The ts_begin_scan() function.

If the time stamp is not a valid timepoint in the time series, an error is raised.

Returns

The modified time series.