English:

The Free and Open Productivity Suite
Help us Help the World

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: sheet ::

constants group DataPilotFieldGroupBy
Description
These constants select different types for grouping members of a DataPilot field by date or time.
See also
DataPilotFieldGroupInfo

Constants
SECONDS Groups all members of a DataPilot field containing a date/time value by their current value for seconds.  
MINUTES Groups all members of a DataPilot field containing a date/time value by their current value for minutes.  
HOURS Groups all members of a DataPilot field containing a date/time value by their current value for hours.  
DAYS Groups all members of a DataPilot field containing a date/time value by their calendar day, or by ranges of days.  
MONTHS Groups all members of a DataPilot field containing a date/time value by their month.  
QUARTERS Groups all members of a DataPilot field containing a date/time value by their quarter.  
YEARS Groups all members of a DataPilot field containing a date/time value by their year.  
Constants' Details
SECONDS
const long SECONDS = 1;
Description
Groups all members of a DataPilot field containing a date/time value by their current value for seconds.

Example: The group :02 will contain all members that contain a time with a seconds value of 2, regardless of the date, hours and minutes of the member, e.g. 2002-Jan-03 00:00:02 or 1999-May-02 12:45:02.

MINUTES
const long MINUTES = 2;
Description
Groups all members of a DataPilot field containing a date/time value by their current value for minutes.

Example: The group :02 will contain all members that contain a time with a minutes value of 2, regardless of the date, hours and seconds of the member, e.g. 2002-Jan-03 00:02:00 or 1999-May-02 12:02:45.

HOURS
const long HOURS = 4;
Description
Groups all members of a DataPilot field containing a date/time value by their current value for hours.

Example: The group 02 will contain all members that contain a time with a hour value of 2, regardless of the date, minutes and seconds of the member, e.g. 2002-Jan-03 02:00:00 or 1999-May-02 02:12:45.

DAYS
const long DAYS = 8;
Description
Groups all members of a DataPilot field containing a date/time value by their calendar day, or by ranges of days.

Examples:

  • Calendar day grouping: The group Jan 03 will contain all members that contain the january 3rd, regardless of the year or time of the member, e.g. 2002-Jan-03 00:00:00 or 1999-Jan-03 02:12:45.
  • Day range grouping: The group 2002-Jan-03 - 2002-Jan-09 will contain all members with a date/time in the range from 2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.

See descriptions for XDataPilotFieldGrouping::createDateGroup for more details about day grouping.

MONTHS
const long MONTHS = 16;
Description
Groups all members of a DataPilot field containing a date/time value by their month.

Example: The group Jan will contain all members with a date in the month january, regardless of the year, day, or time of the member, e.g. 2002-Jan-03 00:00:00 or 1999-Jan-02 02:12:45.

QUARTERS
const long QUARTERS = 32;
Description
Groups all members of a DataPilot field containing a date/time value by their quarter.

Example: The group Q1 will contain all members with a date in the first quarter of a year (i.e. the months january, february, and march), regardless of the year, day, or time of the member, e.g. 2002-Jan-03 00:00:00 or 1999-Mar-02 02:12:45.

YEARS
const long YEARS = 64;
Description
Groups all members of a DataPilot field containing a date/time value by their year.

Example: The group 1999 will contain all members with a date in the year 1999, regardless of the month, day, or time of the member, e.g. 1999-Jan-03 00:00:00 or 1999-May-02 02:12:45.

Top of Page

Apache Feather

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.