Layout - CalendarBuilder

Layout.CalendarBuilder

Define a UI Calendar from a

Stream within a LayoutBuilder.

Example

  // use a DictType stream
  const stream = Stream(
      "My Stream",
      DictType(
          StringType,
          StructType({
              label: StringType,
              start: DateTimeType,
              end: DateTimeType,
          })
      )
  );
  
  // create a calendar
  const layout = new LayoutBuilder("My Layout")
     .calendar("calendar", builder =>
         builder
             .fromStream(stream.outputStream())
             .events((fields) => Struct({
                 label: fields.label,
                 start: fields.start,
                 end: fields.end,
             }))
     )
     .toTemplate()

Layout

constructor

• new CalendarBuilder(name, module):

CalendarBuilder

Define a UI planning related component, such as Calendar, Timeline or Gantt from a

Stream within a LayoutBuilder.

Parameters

Name	Type
name	string
module	ModulePath

Returns

CalendarBuilder

Example

  // use a DictType stream
   *   // use a DictType stream
  const stream = Stream(
      "My Stream",
      DictType(
          StringType,
          StructType({
              label: StringType,
              start: DateTimeType,
              end: DateTimeType,
          })
      )
  );
  
  // create a calendar
  const layout = new LayoutBuilder("My Layout")
     .planner("calendar", builder =>
         builder
             .fromStream(stream.outputStream())
             .calendar({
                 label: (fields) => fields.label,
                 start: (fields) => fields.start,
                 end: (fields) => fields.end,
             })
     )
     .toTemplate()

---

fromStream

▸ fromStream(stream):

CalendarFinalizer

Define the

Stream to build a CalendarBuilder within a LayoutBuilder.

Type parameters

Name	Type
T	extends DictType

Parameters

Name	Type	Description
stream	Stream	the DictType Stream to build the table from

Returns

CalendarFinalizer

Example

  // use a DictType stream
   *   // use a DictType stream
  const stream = Stream(
      "My Stream",
      DictType(
          StringType,
          StructType({
              label: StringType,
              start: DateTimeType,
              end: DateTimeType,
          })
      )
  );
  
  // create a calendar
  const layout = new LayoutBuilder("My Layout")
     .planner("calendar", builder =>
         builder
             .fromStream(stream.outputStream())
             .calendar({
                 label: (fields) => fields.label,
                 start: (fields) => fields.start,
                 end: (fields) => fields.end,
             })
     )
     .toTemplate()