Interface UILegendBoxBuilder<BackgroundType>

Public interface for builder of LegendBox.

Type Parameters

BackgroundType extends InternalBackground = InternalBackground

Hierarchy

UIElementBuilder<LegendBox<BackgroundType>>
- UILegendBoxBuilder

Index

Methods

addStyler getAlignment setAlignment setBackground styleEntries styleTitle

Methods

addStyler

addStyler(styler: UIElementStyler<LegendBox<BackgroundType>>): UILegendBoxBuilder<BackgroundType>
Make new Builder with an additional styler.

Returns
New Builder
Parameters
- styler: UIElementStyler<LegendBox<BackgroundType>>
  
  UiElementStyler for specific type
Returns UILegendBoxBuilder<BackgroundType>

Inherited from UIElementBuilder.addStyler

getAlignment

getAlignment(): "horizontal" | "vertical"
Get alignment of LegendBoxBuilder.

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

Returns
Alignment for LegendBox

Returns "horizontal" | "vertical"

setAlignment

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

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

Returns
New LegendBoxBuilder
Parameters
- alignment: "horizontal" | "vertical"
  
  Alignment for LegendBox
Returns UILegendBoxBuilder<BackgroundType>

setBackground

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

Returns
New LegendBoxBuilder
Type Parameters
- NewBackgroundType extends InternalBackground<NewBackgroundType>
Parameters
- newBackground: BackgroundConstructor<NewBackgroundType>
  
  Constructor for Background
Returns UILegendBoxBuilder<NewBackgroundType>

styleEntries

styleEntries(value: Mutator<LegendBoxEntry<UIBackground>>): UILegendBoxBuilder<BackgroundType>
Make new LegendBoxBuilder with explicitly styled entries.

Returns
New LegendBoxBuilder
Parameters
- value: Mutator<LegendBoxEntry<UIBackground>>
  
  Styler function for a LegendBoxEntry.
Returns UILegendBoxBuilder<BackgroundType>

styleTitle

styleTitle(value: Mutator<UITextBox<UIBackground>>): UILegendBoxBuilder<BackgroundType>
Make new LegendBoxBuilder with explicitly styled title.

Returns
New LegendBoxBuilder
Parameters
- value: Mutator<UITextBox<UIBackground>>
  
  Styler function for a LegendBox title.
Returns UILegendBoxBuilder<BackgroundType>