This article describes the CalendarAnything LWC URL and Component parameters that enable you to customize calendar characteristics such as appearance, grouping, sorting, default views, and so on. To make it easier to find a given parameter, the parameters are grouped as follows:
Note: This document focuses on customizing CalendarAnything LWC parameters. A separate document exists for Classic.
URL parameters
CalendarAnything LWC URL parameters can be passed in a URL.
| Parameter | Description | Example |
| c_t | Current Date title / button; 0 – disable | c_t=0 |
| cid | Defines one or more calendars to load when CalendarAnything starts. The calendar friendly name can be used instead of the ID. | cid=Event_Cal |
| date | Start date | date=2013-11-30 |
| filter | Defines the list of calendars to apply dynamic filters (pv[1-10]) to. Calendar id or friendly name can be used. | filter=Tasks |
| g_p | Gantt View period – number of months to display; 0 – no limits; | g_p=12 // one year; |
| g_v | Gantt View mode. Options include: – hour – day – week – month – quarter | g_v=hour |
| ht | disable CA header panel. | ht=1 |
| l_dl | CA Logo; 0 – disable | l_dl=0 |
| l_dp | Print Button; 0 – disable | l_dp=0 |
| l_ds | All ways to settings – My Calendars button, Settings, Quick Settings; 0 – disable | l_ds=0 |
| l_n | Right button; 0 – disable | l_n=0 |
| l_p | Left button; 0 – disable | l_p=0 |
| l_t | Today button; 0 – disable | l_t=0 |
| ps(1-10) | Filter value for dynamic filters in Custom Grouping. Each number is the filter criteria number to which this value will be applied. This list of filters can be applied to Custom Group By for Swimlane, Gantt and Day Grouping views. | ps1=AAA&ps2={!Contact.ID} |
| pv[1-10] | Filter value for dynamic filters. Each number is linked to some filter for some calendar. List of applied filters define as “filter” parameter | pv1=ABC&pv2={!User.UserID} |
| r_a | Agenda View / button; 0 – disable | r_a=0 |
| r_d | Day Vew / button; 0 – disable | r_d=0 |
| r_dg | Day With Grouping View / button; 0 – disable | r_dg=0 |
| r_g | Gantt View / button; 0 – disable | r_g=0 |
| r_m | Month View / button; 0 – disable | r_m=0 |
| r_s | Swimlane View / button; 0 – disable | r_s=0 |
| r_w | Week View / button; 0 – disable | r_w=0 |
| restPrefix | Prefix for Subpages (like Community) | restPrefix=/somesubpage |
| restV | API Version for REST Calls | restV=41.0 |
| sb | Display / hide left panel. Options include: 0 – visible calendar sidebar (even if URL contains “cid=…” 1 – hide full calendar sidebar, display collapsed calendar side bar 2 – hide all calendar sidebars | sb=0 |
| site | Define that CA shows on a public site. This means that connect.js is not usable and certain functionality that is not available to site users will be locked. | site=1 |
| tz | Time Zone ID | tz=Asia/Shanghai |
| url | Set the default external URL for “event bar details” behavior. The URL can include the \[id\] substring; This will be replaced with the element ID at runtime. | url=/apex/detailpage/[id] |
| v | Starting view. Options include: a – agenda d – day dg – day with grouping g – gantt m – month w – week s – swimlane | v=a |
Component parameters
Component parameters can be view specific or for general use among various views. Date literals can be used within component parameters.
Note: n – number of Days/Weeks/Months/Years
Date literals
The CalendarAnything LWC Date Literals are not parameters. They are literal values you can place into component parameters for which it makes sense to have CalendarAnything dynamically generate the actual parameter values. The table below shows available Date Literals you can use.
| Days | Weeks | Months | Years | Quarters | Fiscal Years | Fiscal Quarters |
| YESTERDAY | LAST_WEEK | LAST_MONTH | LAST_YEAR | LAST_QUARTER | LAST_FISCAL_YEAR | LAST_FISCAL_QUARTER |
| THIS_WEEK | THIS_MONTH | THIS_YEAR | THIS_QUARTER | THIS_FISCAL_YEAR | THIS_FISCAL_QUARTER | |
| TOMORROW | NEXT_WEEK | NEXT_MONTH | NEXT_YEAR | NEXT_QUARTER | NEXT_FISCAL_YEAR | NEXT_FISCAL_QUARTER |
| N_DAYS_AGO:n | N_WEEKS_AGO:n | N_MONTHS_AGO:n | N_YEARS_AGO:n | N_QUARTERS_AGO:n | N_FISCAL_YEARS_AGO:n | N_FISCAL_QUARTERS_ AGO:n |
| LAST_N_DAYS:n | LAST_N_WEEKS:n | LAST_N_MONTHS:n | LAST_N_YEARS:n | LAST_N_QUARTERS:n | LAST_N_FISCAL_YEARS:n | LAST_N_FISCAL_ QUARTERS:n |
| NEXT_N_DAYS:n | NEXT_N_WEEKS:n | NEXT_N_MONTHS:n | NEXT_N_YEARS:n | NEXT_N_QUARTERS:n | N_FISCAL_YEARS_AGO:n | NEXT_N_FISCAL_ QUARTERS:n |
Example use case
- Use case requirement: User needs the start date of the calendar to be 6 months from the current date.
- Use case solution: Use the parameter LAST_N_MONTHS:n where n is the number of months for this use case. The date literal value would be Date=LAST_N_MONTHS:6
Component parameters: view-specific
Component parameters allow you to specify CalendarAnything Settings at the component level. These will be the default Settings launched each time you open CalendarAnything. The parameters listed in the group below pertain to specific calendar views and are sub-grouped by view.
| Parameter | Description | Possible Values |
|---|---|---|
| Agenda View | ||
| agendaAdditionalFields | LWC Agenda View – show additional fields | true | false |
| agendaEmptyDays | Show Empty Days in Agenda View | true | false |
| agendaFieldLabels | Display field labels in Agenda View | true | false |
| Day View | ||
| dayAdditionalFields | LWC Day View – show additional fields | true | false |
| dayFieldLabels | LWC Day View – show additional fields labels | true | false |
| dayGroupingAdditionalFields | LWC DayGrouping View – show additional fields | true | false |
| dayGroupingFieldLabels | LWC DayGrouping View – show additional fields labels | true | false |
| dayModeArea | Set the visibility and size of Hourly and All-Day Areas 0_1 – Hours Only 1_9 – 10% All-Day_90% Hours 1_2 – 33% All-Day_67% Hours 1_1 – 50% All-Day_50% Hours 1_0 -All-Day Only | 0_1 | 1_9 | 1_2 | 1_1 | 1_0 |
| Gantt View | ||
| ganttAdditionalFields | Gantt View show additional fields | true | false |
| ganttCell | Gantt View Day Cell Width | 20 | 40 | 60 | 80 | 100 |
| ganttCollapseFullLine | Collapse Grouping One Line | true | false |
| ganttCollapseGroupingByDefault | Collapse Grouping by Default | true | false |
| ganttFieldLabels | Show field labels for Additional Fields | true | false |
| ganttHideAdditionalFields | Auto collapse Additional Fields | true | false |
| ganttPeriod | Gantt View period : number of months + all time ; 0.1 – one day, 0.7 – one week | 0.1 | 0.7 | 1 | 3 | 6 | 12 | 36 | 120 | 0 |
| ganttRespectHours | Respect working hours in Gantt View. | true | false |
| ganttShowStartWeek | Mark Start Week Day | true | false |
| ganttShowUnvisible | Respect Working Hours in Gantt View | true | false |
| ganttSplit | Starting mode of Gantt View | day | week | month | quarter |
| ganttWideTitle | Open wide title by default | true | false |
| Month View | ||
| extendedRange | Query extended date range in month view – one month before and one month after | true | false |
| monthAdditionalFields | LWC Month View – show additional fields | true | false |
| monthFieldLabels | LWC Month View – show additional fields labels | true | false |
| monthOnlyOne | Show only one month | true | false |
| monthShowMonth | Show Month names on cells | true | false |
| monthShowWeek | Show year week number in week row | true | false |
| monthWeeks | 0 – Auto height of week rows on Month View 6 – display 6 week rows | 0 | 6 |
| Swimlane View | ||
| pinCurrentUser | Show current user at first position (also applies to Day Grouping views) | true | false |
| swimlaneAdditionalFields | LWC Swimlane View – show additional fields | true | false |
| swimlaneCell | Swimlane cell width for Day View | 25 | 50 | 100 | 200 | 300 |
| swimlaneDefaultGroupBy | Default Swimlane grouping field or user list view | empty or some field or some UserList ID (18 chars) |
| swimlaneDefaultPeriod | Default Swimlane period type | day | hour |
| swimlaneDisplayStartEndDate | Display Date in the Datetime fields for viewed date | true | false |
| swimlaneEnableGroupBy | Display Group by fields option | true | false |
| swimlaneEnableGroups | Show Public Groups in Swimlane Selector | true | false |
| swimlaneEnableListViews | Display User Listview option | true | false |
| swimlaneEnablePresets | Display Custom Grouping option | true | false |
| swimlaneEnableQueue | Show Queue in Swimlane / Day with Grouping | true | false |
| swimlaneFieldLabels | LWC Swimlane View – show additional fields labels | true | false |
| swimlaneGroupHierarchy | Use Hierarchy in Public Groups | true | false |
| swimlaneGroupIncludeRole | Load Roles users in Public Groups | true | false |
| swimlaneGroupIncludeSubgroup | Load Subgroups users in Public Groups | true | false |
| swimlaneOneDayAllDay | If FALSE, do not display the Date in the Event Bar if it is an All-Day Event for one day. | true | false |
| swimlanePreset | Preset Swimlane value with Quick Creation; set value for assign to / owner id field | true | false |
| swimlaneScrolling | Enable swimlane scrolling (change date when getting end of the timeline) | true | false |
| swimlaneShowFilter | Whether to show the Group filter in Swimlane View | true | false |
| swimlaneShowWeekDay | Display Day of Week | true | false |
| Week View | ||
| weekAdditionalFields | LWC Week mode – show additional fields | true | false |
| weekFieldLabels | LWC Week mode – show additional fields labels | true | false |
Component parameters: general
These component parameters are not specific to just one view. They pertain to CalendarAnything LWC calendars in general or to more than one calendar view.
| Parameter | Description | Possible Values |
|---|---|---|
| addons | List of enabled addons separated by comma | chatter, invite, attach, zoom, slack, teams |
| alwaysBrowserTab | In Lightning Open Records in New Browser Tab | true | false |
| alwaysFilterSets | Load data with enabled filter set only | true | false |
| apiCache | API caching (hours / lazy – means postloading ) | 0 | 1 | 3 | 8 | 24 | 168 | lazy |
| applyFilterSets | Apply filter criteria to QC form | true | false |
| autoRefresh | turn on data synchronization with the help of Streaming API | nine | api_sobject |
| barLabelTime | Add Start / End date – time on the event label | ‘no’ – no start / end, ‘start’ – start time only, ‘end’ – start + end |
| cacheTime | Data caching time (seconds) | 0 – 300 |
| companyLogo | Print mode Logo (URL) | String |
| confirmDelete | Show popup for user to confirm deletion before deleting item | true | false |
| displayTimeZone | Display Time Zone selector | true | false |
| fastStart | When set to true, CalendarAnything loads only visible calendar object information on page load. | true | false |
| fullDaySortBy | Sort Day Details Popup Events: date – By Date and Title calendar_sorting – By Calendar, Sorting Field and Title | date | calendar_sorting | |
| gradient | Display event bars with gradient (requires more resources from browser) | on | off |
| hideNotify | Hide all (errors + notifications) or just notifications | “all” | “message” |
| lang | CalendarAnything LWC UI language | String; ‘en’,’ru’,’uk’ |
| loadLastPeriod | Load only last selected period. When the user rapidly clicks on “prev” or “next” this will wait until the user stops clicking and only load the last period. | true | false |
| minMinutePeriod | Size of one cell in timing area | 60 | 30 | 15 | 10 | 5 |
| mode | Starting view | month | week | day | custom | agenda| gantt | swimlane | dayGrouping |
| multiContactsInEvent | Enable Multi Contacts Events | true | false |
| noleft | No display settings | true | false |
| nonWorkingHoursDisplay | How to display non-working hours. | hide | show | paint |
| orFilterSets | Show And Or selector for filter sets | true | false |
| parallelRequests | Parallel requests to server; number of requests for events | 1 thru 10 |
| qcAutoEnable | Enable Calendar after Quick Creation | ‘auto’ | ‘off’ | ‘on’ |
| rememberLastView | Save last Selected View as Default Calendar view (except when defined with URL or as a component property) and restore it the next time during CalendarAnything startup. | true | false |
| requestTimeout | Request timeout in seconds | 1 – 300 |
| showAdditionalFields | Show additional fields in the Calendar Edit form | true | false |
| showMultipleColor | Allow multiple color condition | off | corner | line |
| showThirdLevel | Show third level fields | true | false |
| showTitles | 0 – No Titles 1 – Compact (title only) 2 – Detailed (title start & end) 3 – Full Agenda (all fields defined in step 10) 4 – Detail Dialog (displays Details dialog as if you clicked on hover) | 0 | 1 | 2 | 3 | 4 |
| showWeekEnds | Display week ends (5 – up to Friday, 6 – also Saturday, 7 – all week) Note: 5 and 6 only available with startWeekDay=0 | 5 | 6 | 7 |
| size | Size of event bars (height and font size) | small | middle | large |
| startHourPeriod | Start hour for timing area | 0-23 |
| startWeekDay | Starting day of a week | 0-6 (from Sun to Sat) |
| stopHourPeriod | End of timing area | 0-23 |
| uiFilter | Display Filter Panel | true | false |
| uiFilterSets | Display Filter Sets panel | true | false |
| uiSearch | Display search field | true | false |
| uiShowAvl | Show Availability Calendars block | true | false |
| uiShowDesktopCreate | Show Create Button on Desktop | true | false |
| uiShowGroup | Show Grouped Calendars block | true | false |
| uiShowSF | Show Standard Calendars block | true | false |
| uiShowWeb | Show Web Calendars block | true | false |
| uiToday | Display Today button | true | false |
| useSFTimeZone | Use Server TZ | true | false |