Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UILegendBoxBuilder<BackgroundType, TitleType, EntryType>

Public interface for builder of LegendBox.

Index

Methods

addStyler

  • Make new Builder with an additional styler.

    Parameters

    Returns this

    New Builder

setAlignment

  • setAlignment(alignment: "horizontal" | "vertical"): UILegendBoxBuilder<BackgroundType, TitleType>
  • Make new LegendBoxBuilder with different alignment of entries.

    Eq. "Horizontal" meaning that the LegendBox progresses in the X-direction, and aligns its groups downwards.

    Parameters

    • alignment: "horizontal" | "vertical"

      Alignment for LegendBox

    Returns UILegendBoxBuilder<BackgroundType, TitleType>

    New LegendBoxBuilder

setBackground

  • setBackground(newBackground: BackgroundConstructor<NewBackgroundType>): UILegendBoxBuilder<NewBackgroundType, TitleType>
  • Make new LegendBoxBuilder with different background

    Type parameters

    • NewBackgroundType: BackgroundType

    Parameters

    • newBackground: BackgroundConstructor<NewBackgroundType>

      Constructor for Background

    Returns UILegendBoxBuilder<NewBackgroundType, TitleType>

    New LegendBoxBuilder

setEntry

  • Make new LegendBoxBuilder with different entries

    Type parameters

    • NewEntryType: EntryType

    Parameters

    Returns UILegendBoxBuilder<BackgroundType, TitleType, NewEntryType>

    New LegendBoxBuilder

setTitle

  • Make new LegendBoxBuilder with different titles

    Type parameters

    • NewTitleType: TitleType

    Parameters

    • value: UIElementBuilder<NewTitleType> | Mutator<TitleType>

      Either builder for new title (extends TextBox) or styler for current title type

    Returns UILegendBoxBuilder<BackgroundType, NewTitleType>

    New LegendBoxBuilder