| InstantCal API: |
|
InstantCal is configured using its API (Application Programming Interface).
The default configuration is generated by the Demo.
|
The API is organized into the following sections:
- Embedding - add InstantCal to a web page
- Data - access calendar data
- Display - control calendar format, style, and content
- User controls - allow users to set certain viewing options
|
The API is defined by a URI and a set of options.
The URI is generated by the Demo and is:
http://instantcal.com/isc/js/cv.js?
|
|
The options are listed under each API section. An option is specified by adding
its name and value to the API string as 'name=value'.
name1=value1&name2=value2...
|
|
Note: if multiple options are supported
by a particular option, an ampersand ('&') must be used to separate the option 'name=value' pairs:
|
|
Example:
http://instantcal.com/isc/js/cv.js?file=http://instantcal.com/categories.ics
|
| |
| 1. Embedding InstantCal |
|
Setup describes how to add (embed) InstantCal in a web page.
|
| |
| 2. Calendar Data |
Calendar data are specified by the file option, which has a URI as its value. The following types of data are supported:
- iCal - an iCalendar file
- Webcal - a webcal calendar
- RSS - an RSS feed
- ISCal - an ISCal 'internal' calendar
|
| API Data Options |
| Description |
Name |
Value |
| iCal | file | http://...iCal file... |
| Webcal | file | webcal://...Webcal file... |
| RSS | file | http://...RSS feed... |
| ISCal (internal) | file | http://instantcal.com/isc/cal/cal.php?
action=getfile&
uri=/instantcal.com/test/Calendar&
username=*
Note: this should be entered as a single line |
|
| |
| 3. Display |
| A) Organization |
|
Calendars are organized in one of two ways:
|
The Navigated organization has three levels of display; navigation (ntype option), group (gtype option), and item (itype option).
The navigation level allows a date to be selected, and a group of calendar events
displayed.
Currently, the only navigation level supported is a 'Date picker'.
|
|
The Grouped organization has two levels of display; group (gtype option), and item (itype option).
The group level displays a group of calendar events, and allows a single calendar event to be selected.
The item level displays a single calendar event.
|
|
A variety of formats (grid, table, list) and styles may be displayed at the group level.
Several of these also offer visual effects (scroll, fade).
|
| API Display Options (navigation/group/item) |
| Description |
Name |
Value |
| Date picker | ntype | cv_datepicker |
| Day | gtype | cv_dayGrid |
| 3 Day | gtype | cv_dayGrid3 |
| 5 Day | gtype | cv_dayGrid5 |
| 7 Day | gtype | cv_dayGrid7 |
| Preview | gtype | cv_simpleList |
| Preview (scroll) | gtype | cv_simpleList_scroller |
| Preview (fade) | gtype | cv_simpleList_fader |
| List - Summary | gtype | cv_listSummary |
| List - Summary (scroll) | gtype | cv_listSummary_scroller |
| List - Summary (fade) | gtype | cv_listSummary_fader |
| List - Time | gtype | cv_listTime |
| List - Time (scroll) | gtype | cv_listTime_scroller |
| List - Time (fade) | gtype | cv_listTime_fader |
| Labeled List - Summary | gtype | cv_labeledListSummary |
| Labeled List - Summary (scroll) | gtype | cv_labeledListSummary_scroller |
| Labeled List - Summary (fade) | gtype | cv_labeledListSummary_fader |
| Labeled List - Time | gtype | cv_labeledListTime |
| Labeled List - Time (scroll) | gtype | cv_labeledListTime_scroller |
| Labeled List - Time (fade | gtype | cv_labeledListTime_fader |
| Table | gtype | cv_listTable |
| Table (scroll) | gtype | cv_listTable_scroller |
| Table (fade) | gtype | cv_listTable_fader |
| Condensed Table | gtype | cv_listTableCondensed |
| Condensed Table (scroll) | gtype | cv_listTableCondensed_scroller |
| Condensed Table (fade) | gtype | cv_listTableCondensed_fader |
| Event | itype | cv_simpleEvent |
|
| B) Color Scheme |
|
Calendar color appearance may be set by the theme option.
|
| API Display Options |
| Description |
Name |
Value |
| Gray | theme | xgy |
| Red | theme | xre |
| Blue | theme | xbl |
| Yellow | theme | xye |
| Green | theme | xgr |
| Gray (flat) | theme | gy |
| Red (flat) | theme | re |
| Blue (flat) | theme | bl |
| Yellow (flat) | theme | ye |
| Green (flat) | theme | gr |
|
| |
| 4. Viewer controls |
|
InstantCal viewers may customize calendars, depending upon which options are specified
when a calendar is embedded.
|
|
If category options are specified,
a set of category choices is available.
|
|
If the timezone option is specified,
a set of timezone choices is available.
|
| API Viewer Control Options |
| Description |
Name |
Value |
| Category | category | category name
Note: multiple options are supported |
| Timezone | tz | --- |
|
