Paging and grouping URL parameters

The paging and grouping parameters are optional parameters that can be:

• Included in the url argument in the $Trumba.addSpud() method.
• Appended to the trumbaEmbed parameter in a URL-encoded query string.

Paging and grouping parameters control how events are grouped (for example, by month or week) and how many events display per page. Not all calendar views support all of the paging and grouping parameters. If you use a parameter a view doesn't support, the parameter is ignored.

I'd like to know more about how paging and grouping work.

In the Publishing Control Panel, when you set up and customize a main calendar view, you can set the paging and grouping options you want to use. Programmatic access to the paging and grouping parameters lets you provide alternative views.

For example, you might set up a main calendar Table view to group events by week and list 30 events per page. Using the URL parameters, you could also provide an alternate view that groups events by month, subgroups them by location, and lists only 15 events per page.

Paging and grouping URL parameters include:

• paging
• events
• groupby
• subgroupby
• groupspan

Each parameter is described in more detail below.

Work with

Main calendar spud

paging parameter

Application

The paging parameter works with the events parameter to control the number of events that make up one page.

Values

• smart

  Displays, as closely as possible, the number of events set in the Publishing Control Panel or the events parameter, while preventing events that occur within the same group from breaking across pages.

  For example, suppose events are grouped by week and the events parameter is set at 20. If 22 events occur in one week, all 22 will be listed on a single page.

• exact

  Displays exactly the number of events set in the Publishing Control Panel or the events parameter.

events parameter

Application

The events parameter specifies the number of events per page. The specific number of events that displays depends upon the paging setting in the Publishing Control Panel or the paging parameter.

Values

Any whole number between 1 and 1000.

groupby parameter

The groupby parameter specifies the time period by which events are grouped.

Values

subgroupby parameter

The subgroupby parameter specifies how events are organized within groups.

Values

Takes the same values as the groupby parameter, as well as the following:

groupspan parameter

The groupspan parameter controls how multi-day events appear within groups.

Values

• yes

  Displays multi-day events in all of the groups that include dates on which the events occur, even if the events started in the past.

• no

  Displays multi-day events only in the group that includes the dates on which the events start.

Examples