Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LegendBoxOptions<TitleType, EntryType>

Interface specifies the options for creating a LegendBox inside a Dashboard.

Example usage:

// Create a Horizontal LegendBox
{ legendBoxBuilder: UIElementBuilders.HorizontalLegendBox }

Index

Properties

columnIndex

columnIndex : number

Column index on dashboard (X location, 0 = left)

Optional columnSpan

columnSpan : undefined | number

Column span (X width), default = 1

Optional legendBoxBuilder

legendBoxBuilder : UILegendBoxBuilder<UIEmptyBackground, TitleType, EntryType>

Builder that specifies functionality of created LegendBox.

rowIndex

rowIndex : number

Row index on dashboard (Y location, 0 = top)

Optional rowSpan

rowSpan : undefined | number

Row span (Y height), default = 1

Optional theme

theme : Theme