Localist | Building widgets

Building widgets

Last Updated: Jan 08, 2014 10:19AM EST

Find your own platform's widget builder at http://your_calendar_url/help/widget 
 

These are some additional parameters that can be used for the widget, in addition to those available on the widget builder. Each parameter should be passed in as standard parameter in the widget URL.
 

Parameters marked as array can be specified as array parameters (example: venues[]=1&venues[]=2) or comma separated values (venues=1,2). The two forms cannot be mixed.
 

Boolean parameters are true for values of 1, y, yes, true. In many cases, the presence of the parameter is all that is required. (When in doubt, don't include false parameters)

 

Filtering

Parameter Description Type Default
num Number of events to return (1-50) number 10
days Number of days in the future to look at (1-365) number 7
start Date that the widget should start from (YYYY-MM-DD) date today's date
venues Only return events at these venues (ID or username) array none
cities Only return events in these cities (ID or urlname) array platform specific
neighborhoods Only return events in these neighborhoods (ID or urlname) array platform specific
schools Only return events assigned to these schools (ID or urlname) array platform specific
campuses Only return events assigned to these campuses (ID or urlname) array platform specific
groups Only return events assigned to these groups (ID or urlname) array none
skip_recurring Do not include recurring events boolean false
all_instances Show all instances of recurring events (instead of only the next) boolean false
age_limit Minimum age limit (0, 18, or 21) number 0
picks Only include featured events boolean false
sponsored Only include events marked as “sponsored” boolean false
  Note: sponsored can also be set to never to hide sponsored events from the results
tags Return events with any of these tags or keywords (also see match) array (string) none
types Return events with any of these filter values (also see match) array (tag IDs) none
exclude_types Exclude events matching these filters values array (tag IDs) none
  The possible values for exclude_types are identical to the types parameter.
require_all Deprecated, same as match=all when true boolean false
match Controls matching requirements for tags and types parameters string none
  When not set (default), matches events that have at least one of the listed tags and one of the listed types
When all, matches events that have all the listed tags and types
When any, matches events that have at least one of the listed tags and types

 

 

Output Parameters

Parameter Description Type Default
hidedesc Hide descriptions boolean false
hideimage Hide images boolean false
image_size Image thumbnail size to return (tiny (20×20), small (50×50), medium (80×80), big (200×150), big_300 (300×225) string small
show_keywords Show keywords assigned to events boolean false
show_times Show event start times boolean false
show_year Show the year on the event date boolean false
show_types Show event types below the event description boolean false
style Suppress default style string none
target_blank Open event and venue links in new window boolean false
       
html_descriptions

Output the raw HTML in event descriptions (default is plain-text)

boolean false 

Contact Us

desksupport@localist.com
http://assets02.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete