Ignite UI API Reference

ig.excel.RelativeDateRangeFilter

Represents a filter which can filter date cells based on dates relative to the when the filter was applied.

Remarks

The RelativeDateRangeFilter allows you to filter in dates which are in the previous, current, or next time period relative to the date when the filter was applied. The time periods available are day, week, month, quarter, year. So when using the previous filter type with a day duration, a 'yesterday' filter is created. Or when using a current filter type with a year duration, a 'this year' filter is created. However, these filters compare the data against the date when the filter was created. So a 'this year' filter created in 1999 will filter in all cells containing dates in 1999, even if the workbook is opened in 2012.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • duration

    .duration( );

    Gets the duration of the full range of accepted dates.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the RelativeDateRangeDuration enumeration.

    See Also

  • duration

    .duration( value:ig.excel.RelativeDateRangeDuration );

    Sets the duration of the full range of accepted dates.

    • value
    • Type:ig.excel.RelativeDateRangeDuration

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the RelativeDateRangeDuration enumeration.

    See Also

  • offset

    .offset( );

    Gets the offset of relative filter (previous, current, or next).

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the RelativeDateRangeOffset enumeration.

    Remarks

    Type combined with RelativeDateRangeFilter.duration determines the relative date range to filter.

    See Also

  • offset

    .offset( value:ig.excel.RelativeDateRangeOffset );

    Sets the offset of relative filter (previous, current, or next).

    • value
    • Type:ig.excel.RelativeDateRangeOffset

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the RelativeDateRangeOffset enumeration.

    Remarks

    Type combined with RelativeDateRangeFilter.duration determines the relative date range to filter.

    See Also

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.

#