Class UILegendBoxPanel <TitleType, DefaultEntryType >

Index

Properties

Methods

Properties

engine

engine: PublicEngine

pixelScale

pixelScale: Vec2<Scale>

uiScale

uiScale: Vec2<Scale>

Methods

add

add(value: Attachable | Chart | Dashboard, disposeOnClick: undefined | false | true, tag: undefined | string, builder: UIElementBuilder<EntryType>): EntryType | EntryType[] | EntryType[][]

Type parameters
- EntryType: LegendBoxEntry
Parameters
- value: Attachable | Chart | Dashboard
- Optional disposeOnClick: undefined | false | true
- Optional tag: undefined | string
- Optional builder: UIElementBuilder<EntryType>
Returns EntryType | EntryType[] | EntryType[][]

Entry attached to a Series or Collection of Entries in case of Chart or Dashboard

addLegendBox

addLegendBox(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addUIElement

addUIElement(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Default value builder: UIElementBuilder<UIElementType>
- Default value scale: Vec2<Scale>
Returns UIElementType & UIElement

Object that fulfills interfaces: UIElementType (typeparam) and UIElement

dispose

dispose(): this

Returns this

Object itself for fluent interface

getBackgroundFillStyle

getBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getBackgroundStrokeStyle

getBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getMinimumSize

getMinimumSize(): undefined

Returns undefined

Legendbox minimum x & y dimensions as Vec2.

offResize

offResize(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onResize

onResize(handler: function): Token

Parameters
- handler: function
  - - Parameters
      - obj: this
      - width: pixel
      - height: pixel
      - engineWidth: pixel
      - engineHeight: pixel
      Returns void
Returns Token

Token of subscription

saveToFile

saveToFile(fileName: string, type: undefined | string, encoderOptions: undefined | number): this

Parameters
- fileName: string
- Optional type: undefined | string
- Optional encoderOptions: undefined | number
Returns this

setBackgroundFillStyle

setBackgroundFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setBackgroundStrokeStyle

setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setMinimumSize

setMinimumSize(minimumSize: Point): this

Parameters
- minimumSize: Point
Returns this