Event source (query)

Provide a SQL query that returns a row for each event. Then describe how to make an event from the row.

Ingredient Family: calendarIngredients

Outline Display: Add an event source, pulling events from {{query}}.

Details

The SQL query returns one row per calendar event. Formulas extract event properties (id, title, start time, end time, all-day flag, background flag, text color, background color) from each row. Multiple EventSource ingredients can be added to the same Calendar concept to show events from different queries overlaid on the same calendar view.

Local scope

Names introduced within this component’s knobs:

• queryTab – result columns of query (referenceable as a virtual table)

Settings

Required

• query : SQL query
  A query that generates rows, each of which represents an event

  Scope: none – this query does not accept [Username] or handler parameters. Use only table/column references and literal values.

• id : formula (returns text; required, non-nullable)
  The id for the event
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])

• allDay : formula (returns bool; required, non-nullable)
  Whether the event is all day
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])

• startTime : formula (returns time; required, non-nullable)
  When the event starts
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])

• title : formula (returns text; required, non-nullable)
  The title for the event
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])

• isBackground : formula (returns bool; required, non-nullable)
  Is this a background event?
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])

Optional

• endTime : formula (returns time; optional)
  When the event ends. If the event is all day, this can be omitted.
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])

• color : formula (returns text; optional)
  A custom text color for this event, if desired
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])

• backgroundColor : formula (returns text; optional)
  A custom background color for this event, if desired
  Scope: all columns of queryTab (reference as [ColumnName], e.g., [Name], [Price])