HideElem function

The HideElem function marks an element, or a set of elements, at a given time stamp as invisible.

Syntax

HideElem(ts     TimeSeries, 
        tstamp datetime year to fraction(5),
        flags  integer default 0) 
returns TimeSeries;

HideElem(ts         TimeSeries, 
       multiset_tstamps multiset(datetime year to fraction(5) not null),
        flags       integer default 0) 
returns TimeSeries;

ts: The source time series.
tstamp: The time stamp to be made invisible.
multiset_tstamps: The multiset of time stamps to be made invisible.
flags: Valid values for the flags argument 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.

The API equivalent to this function is ts_hide_elem().

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

Returns

The modified time series.

Example

The following example hides the element at 2011-01-03 in the time series for IBM®:

select HideElem(stock_data, '2011-01-03 00:00:00.00000')
   from daily_stocks
   where stock_name = 'IBM';