effect-tree
    Preparing search index...

    Function row

    • Combine parts horizontally.

      Parameters

      • vAlign: "top" | "middle" | "bottom"

        we are combining parts horizontally, and they could be of different heights. But we must always produce a rectangular area. We need to fill the areas that are empty. But where do we place the vertical strut intended for this purpose: above or below the part we are aligning, or maybe both? This is set by this argument: how to align parts when they are shorter than the tallest part in the row.

      Returns (
          hAlign: "left" | "right" | "center",
      ) => (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

      A new part where all the given parts are arranged in a row layout.

        • (
              hAlign: "left" | "right" | "center",
          ): (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

        • The vertical struts we use to fill the rectangular area according to the given vertical alignment are given as a list of strings that could be 1 to N glyphs wide. This means they could leave space in the row. We fill it with the given horizontal strut and use this argument to determine the horizontal alignment of the single vertical strut. We add a vertical strut per each part that is shorter than the tallest part in the row.

          Parameters

          • hAlign: "left" | "right" | "center"

          Returns (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

    Index

    Properties

    bottom middle top

    Properties

    bottom: (
        hAlign: "left" | "right" | "center",
    ) => (cells: Draw.Part[], __namedParameters?: RowStruts) => Row & {
        center: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
        left: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
        right: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
    }

    Type Declaration

      • (
            hAlign: "left" | "right" | "center",
        ): (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

      • The vertical struts we use to fill the rectangular area according to the given vertical alignment are given as a list of strings that could be 1 to N glyphs wide. This means they could leave space in the row. We fill it with the given horizontal strut and use this argument to determine the horizontal alignment of the single vertical strut. We add a vertical strut per each part that is shorter than the tallest part in the row.

        Parameters

        • hAlign: "left" | "right" | "center"

        Returns (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

    middle: (
        hAlign: "left" | "right" | "center",
    ) => (cells: Draw.Part[], __namedParameters?: RowStruts) => Row & {
        center: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
        left: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
        right: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
    }

    Type Declaration

      • (
            hAlign: "left" | "right" | "center",
        ): (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

      • The vertical struts we use to fill the rectangular area according to the given vertical alignment are given as a list of strings that could be 1 to N glyphs wide. This means they could leave space in the row. We fill it with the given horizontal strut and use this argument to determine the horizontal alignment of the single vertical strut. We add a vertical strut per each part that is shorter than the tallest part in the row.

        Parameters

        • hAlign: "left" | "right" | "center"

        Returns (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

    top: (
        hAlign: "left" | "right" | "center",
    ) => (cells: Draw.Part[], __namedParameters?: RowStruts) => Row & {
        center: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
        left: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
        right: (cells: Draw.Part[], __namedParameters?: RowStruts) => Row;
    }

    Type Declaration

      • (
            hAlign: "left" | "right" | "center",
        ): (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

      • The vertical struts we use to fill the rectangular area according to the given vertical alignment are given as a list of strings that could be 1 to N glyphs wide. This means they could leave space in the row. We fill it with the given horizontal strut and use this argument to determine the horizontal alignment of the single vertical strut. We add a vertical strut per each part that is shorter than the tallest part in the row.

        Parameters

        • hAlign: "left" | "right" | "center"

        Returns (cells: Draw.Part[], __namedParameters?: RowStruts) => Row

    Settings

    Member Visibility

    On This Page

    Properties