Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LegendBoxOptions <TitleType, EntryType >

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

Example usage:

Desired result Value
Create a Horizontal LegendBox { legendBoxBuilder: UIElementBuilders.HorizontalLegendBox }

Index

Properties

columnIndex

columnIndex: number

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

columnSpan

columnSpan: number

Column span (X width)

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)

rowSpan

rowSpan: number

Row span (Y height)

Optional theme

theme: Theme