Interface LegendBoxEntry <BackgroundType >

Index

Properties

Methods

Properties

dispose

dispose: function

- Returns this

isDisposed

isDisposed: function

- Returns boolean

restore

restore: function

- Returns this

Methods

getBackground

getBackground(): BackgroundType

Returns BackgroundType

Background object

getButtonOffFillStyle

getButtonOffFillStyle(): FillStyle

Returns FillStyle

Fill style object

getButtonOffFillStyleHighlight

getButtonOffFillStyleHighlight(): FillStyle | undefined

Returns FillStyle | undefined

Fill style object or undefined for auto assignment

getButtonOffSize

getButtonOffSize(): Point

Returns Point

Size of button as Point

getButtonOffStrokeStyle

getButtonOffStrokeStyle(): LineStyle

Returns LineStyle

Line style object

getButtonOnFillStyle

getButtonOnFillStyle(): FillStyle

Returns FillStyle

Fill style object

getButtonOnFillStyleHighlight

getButtonOnFillStyleHighlight(): FillStyle | undefined

Returns FillStyle | undefined

Fill style object or undefined for auto assignment

getButtonOnSize

getButtonOnSize(): Point

Returns Point

Size of button as Point

getButtonOnStrokeStyle

getButtonOnStrokeStyle(): LineStyle

Returns LineStyle

Line style object

getFont

getFont(): FontSettings

Returns FontSettings

FontSettings

getHighlighted

getHighlighted(): boolean

Returns boolean

True for highlighted state of object and false for basic

getLocked

getLocked(): boolean

Returns boolean

State of isLocked boolean flag

getMargin

getMargin(): Margin

Returns Margin

Margin datastructure

getMouseInteractions

getMouseInteractions(): boolean

Returns boolean

Mouse interactions state

getMouseStyle

getMouseStyle(): UIMouseStyle

Returns UIMouseStyle

Interface for defining how mouse should look when hovering over UI object

getOn

getOn(): boolean

Returns boolean

State as boolean flag

getPadding

getPadding(): Margin

Returns Margin

Margin datastructure

getText

getText(): string

Returns string

The entire text string.

getTextFillStyle

getTextFillStyle(): FillStyle

Returns FillStyle

Current text fill style object

getTextFillStyleHighlight

getTextFillStyleHighlight(): FillStyle | undefined

Returns FillStyle | undefined

Current text fill style object when highlighted or undefined for auto assignment

offMouseClick

offMouseClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDoubleClick

offMouseDoubleClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDown

offMouseDown(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDrag

offMouseDrag(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDragStart

offMouseDragStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDragStop

offMouseDragStop(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseEnter

offMouseEnter(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseLeave

offMouseLeave(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseMove

offMouseMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseUp

offMouseUp(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseWheel

offMouseWheel(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offSwitch

offSwitch(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offTouchEnd

offTouchEnd(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offTouchMove

offTouchMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offTouchStart

offTouchStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

onMouseClick

onMouseClick(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseDoubleClick

onMouseDoubleClick(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseDown

onMouseDown(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseDrag

onMouseDrag(listener: MouseDragEventHandler<this>): Token

Parameters
- listener: MouseDragEventHandler<this>
Returns Token

Token of subscription

onMouseDragStart

onMouseDragStart(listener: MouseDragStartEventHandler<this>): Token

Parameters
- listener: MouseDragStartEventHandler<this>
Returns Token

Token of subscription

onMouseDragStop

onMouseDragStop(listener: MouseDragStopEventHandler<this>): Token

Parameters
- listener: MouseDragStopEventHandler<this>
Returns Token

Token of subscription

onMouseEnter

onMouseEnter(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseLeave

onMouseLeave(listener: AbruptMouseEventHandler<this>): Token

Parameters
- listener: AbruptMouseEventHandler<this>
Returns Token

Token of subscription

onMouseMove

onMouseMove(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseUp

onMouseUp(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseWheel

onMouseWheel(listener: MouseWheelEventHandler<this>): Token

Parameters
- listener: MouseWheelEventHandler<this>
Returns Token

Token of subscription

onSwitch

onSwitch(listener: function): Token

Parameters
- listener: function
  - - Parameters
      - obj: this
      - state: boolean
      Returns void
Returns Token

Token of subscription

onTouchEnd

onTouchEnd(listener: TouchEventHandler<this>): Token

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchMove

onTouchMove(listener: TouchEventHandler<this>): Token

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchStart

onTouchStart(listener: TouchEventHandler<this>): Token

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

setBackground

setBackground(mutator: Mutator<BackgroundType>): this

Parameters
- mutator: Mutator<BackgroundType>
Returns this

Object itself for fluent interface

setButtonOffFillStyle

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

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

Object itself for fluent interface

setButtonOffFillStyleHighlight

setButtonOffFillStyleHighlight(value: FillStyle | ImmutableMutator<FillStyle> | undefined): this

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

setButtonOffSize

setButtonOffSize(size: Point | pixel): this

Parameters
- size: Point | pixel
Returns this

Object itself

setButtonOffStrokeStyle

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

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

Object itself for fluent interface

setButtonOnFillStyle

setButtonOnFillStyle(value: FillStyle | Mutator<FillStyle>): this

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

Object itself for fluent interface

setButtonOnFillStyleHighlight

setButtonOnFillStyleHighlight(style: FillStyle | ImmutableMutator<FillStyle> | undefined): this

Parameters
- style: FillStyle | ImmutableMutator<FillStyle> | undefined
Returns this

setButtonOnSize

setButtonOnSize(size: Point | pixel): this

Parameters
- size: Point | pixel
Returns this

Object itself

setButtonOnStrokeStyle

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

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

Object itself for fluent interface

setFont

setFont(value: FontSettings | ImmutableMutator<FontSettings>): this

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

Object itself

setHighlighted

setHighlighted(isHighlighted: boolean): this

Parameters
- isHighlighted: boolean
Returns this

Object itself for fluent interface

setLocked

setLocked(isLocked: boolean): this

Parameters
- isLocked: boolean
Returns this

State as boolean flag

setMargin

setMargin(margin: Partial<MMargin> | number): this

Parameters
- margin: Partial<MMargin> | number
Returns this

Object itself

setMouseInteractions

setMouseInteractions(state: boolean): this

Parameters
- state: boolean
Returns this

Object itself for fluent interface

setMouseStyle

setMouseStyle(mouseStyle: UIMouseStyle): this

Parameters
- mouseStyle: UIMouseStyle
Returns this

Object itself

setOn

setOn(isOn: boolean): this

Parameters
- isOn: boolean
Returns this

Object itself for fluent interface

setPadding

setPadding(padding: Partial<Margin> | number): this

Parameters
- padding: Partial<Margin> | number
Returns this

Object itself

setText

setText(text: string): this

Parameters
- text: string
Returns this

Object itself for fluent interface.

setTextFillStyle

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

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

Object itself for fluent interface

setTextFillStyleHighlight

setTextFillStyleHighlight(value: FillStyle | ImmutableMutator<FillStyle> | undefined): this

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

Object itself for fluent interface