Layout - AccordionBuilder

Layout.AccordionBuilder

Add an

AccordionBuilder to display in the UI.

Param

the

AccordionBuilder to embed.

Example

  // use a DictType stream
  const stream = Stream(
      "My Stream",
      DictType(
          StringType,
          StructType({
              string: StringType,
              date: DateTimeType,
          })
      )
  );
  
  // create a table in a layout
  const layout = new LayoutBuilder("My Layout")
      .accordion(builder => builder
          .group("Group One", builder => 
              .item("Item One", builder => builder
                  .table("My Table", builder => builder
                      .fromStream(stream)
                      .date("Date", fields => fields.date)
                      .string("String", fields => fields.string)
                  )
              )
              .item("Item Two", builder => builder
                  .table("My Other Table", builder => builder
                      .fromStream(stream)
                      .columns()
                  )
              )
          )
      )
      .toTemplate()

Hierarchy

• Builder

  ↳ AccordionBuilder

Layout

disableNumbering

▸ disableNumbering():

AccordionBuilder

Disable the numbering displayed in an Accordion in the UI.

Returns

AccordionBuilder

Example

  // use a DictType stream
  const stream = Stream(
      "My Stream",
      DictType(
          StringType,
          StructType({
              string: StringType,
              date: DateTimeType,
          })
      )
  );
  
  // create a table in a layout
  const layout = new LayoutBuilder("My Layout")
      .accordion(builder => builder
          .group("Group One", builder => 
              .item("Item One", builder => builder
                  .table("My Table", builder => builder
                      .fromStream(stream)
                      .date("Date", fields => fields.date)
                      .string("String", fields => fields.string)
                  )
              )
              .item("Item Two", builder => builder
                  .table("My Other Table", builder => builder
                      .fromStream(stream)
                      .columns()
                  )
              )
          )
      )
      .disableNumbering()
      .toTemplate()

---

group

▸ group(name, def):

AccordionBuilder

Add an

AccordionGroupBuilder within an AccordionBuilder to display in the UI.

Parameters

Name	Type	Description
name	string	-
def	(panel: AccordionGroupBuilder) => AccordionGroupBuilder	the AccordionGroupBuilder to embed.

Returns

AccordionBuilder

Example

  // use a DictType stream
  const stream = Stream(
      "My Stream",
      DictType(
          StringType,
          StructType({
              string: StringType,
              date: DateTimeType,
          })
      )
  );
  
  // create a table in a layout
  const layout = new LayoutBuilder("My Layout")
      .accordion(builder => builder
          .group("Group One", builder => 
              .item("Item One", builder => builder
                  .table("My Table", builder => builder
                      .fromStream(stream)
                      .date("Date", fields => fields.date)
                      .string("String", fields => fields.string)
                  )
              )
              .item("Item Two", builder => builder
                  .table("My Other Table", builder => builder
                      .fromStream(stream)
                      .columns()
                  )
              )
          )
      )
      .toTemplate()

---

toTemplate

▸ toTemplate():

Template

Convert the built layout into an

Template, for usage in an EDK project.

Returns

Template

Example

  // use a DictType stream
  const stream = Stream(
      "My Stream",
      DictType(
          StringType,
          StructType({
              string: StringType,
              date: DateTimeType,
          })
      )
  );
  
  // add a form to a tab
  const layout = new LayoutBuilder("My Layout")
     .table(50, "My Table", builder => builder
         .fromStream(stream)
         .date("Date", fields => fields.date)
         .string("String", fields => fields.string)
     )
     .toTemplate()

Overrides

Builder.toTemplate