Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ButtonSegmentGroup

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

$el

  • get $el(): any

  • DOM element associated with the view.

    readonly
    memberof

    View

    Returns any

data

  • get data(): any

  • Data used when rendering the view, if any.

    readonly
    memberof

    View

    Returns any

id

  • get id(): string

  • Returns string

isMounted

  • get isMounted(): boolean

  • Returns boolean

isRendered

  • get isRendered(): boolean

  • Returns boolean

opts

parentId

  • get parentId(): string

  • Returns string

segments

  • Returns ButtonSegment[]

state

  • Current component state.

    readonly
    memberof

    Component

    Returns ComponentState

title

  • get title(): string

  • Returns string

ui

  • get ui(): {}

  • Interface DOM targets, which are only available after the view has been rendered to the DOM.

    readonly
    memberof

    View

    Returns {}

    • [key: string]: any

value

  • get value(): string | Array<string>

  • Returns string | Array<string>

Methods

addTo

  • addTo(target: HTMLElement | string, replace?: boolean, index?: number): boolean

  • Adds the view's element to the DOM by appending it to the specified target.

    memberof

    View

    Parameters

    • target: HTMLElement | string

      DOM target in which the view will be appended

    • Default value replace: boolean = false
    • Default value index: number = -1

    Returns boolean

bounds

  • bounds(absolute?: boolean, relative?: any): Bounds

  • Parameters

    • Default value absolute: boolean = false
    • Default value relative: any = null

    Returns Bounds

clear

  • clear(triggerEvents?: boolean): void

  • Parameters

    • Default value triggerEvents: boolean = true

    Returns void

el

  • el(selector: string): any

  • Parameters

    • selector: string

    Returns any

getState

  • getState(key: string): any

  • Parameters

    • key: string

    Returns any

has

  • has(type: string): boolean

  • Returns whether the listeners are registered for the specified event name.

    memberof

    EventDispatcher

    Parameters

    • type: string

    Returns boolean

hide

  • hide(): void

  • Hides the view.

    memberof

    View

    Returns void

index

  • index(): number

  • Returns number

initialize

  • initialize(data?: any): void

  • Parameters

    • Optional data: any

    Returns void

layout

  • layout(): void

  • Returns void

moveTo

  • moveTo(position: Point, offset?: { x: number; y: number }): void

  • Updates the view's position to the specified x and y values with optional offsets. The view must be configured with absolute positioning.

    memberof

    View

    Parameters

    • position: Point
    • Default value offset: { x: number; y: number } = { x: 0, y: 0 }
      • x: number
      • y: number

    Returns void

off

  • Removes a registered listener function for the specified event.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to remove the listener for.

    • callback: Function

      Handler function to remove so it won't be executed next time the event is triggered.

    • Default value scope: any = null

    Returns EventDispatcher

offAll

on

  • on(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher

  • Registers a listener function to be executed each time an event occurs

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

once

  • once(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher

  • Registers a listener function to be executed the first time an event occurs.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

parent

  • parent(): any

  • Parent DOM target, if any. Parent will be null if the view has not been added to the DOM.

    memberof

    View

    Returns any

pinTo

  • pinTo(position: AnchorType, offset?: { x: number; y: number }): void

  • Positions the view by pinning it relative to its parent container. The view must be configured with absolute positioning.

    memberof

    View

    Parameters

    • position: AnchorType

      Anchor position of the view within its container

    • Optional offset: { x: number; y: number }
      • x: number
      • y: number

    Returns void

remove

  • remove(removeEvents?: boolean): void

  • Removes the view from the DOM.

    memberof

    View

    Parameters

    • Default value removeEvents: boolean = false

    Returns void

selectedSegments

  • Returns ButtonSegment[]

setIndex

  • setIndex(index: number): void

  • Parameters

    • index: number

    Returns void

setSegments

  • Parameters

    Returns void

setSize

  • setSize(width: number, height: number): void

  • Parameters

    • width: number
    • height: number

    Returns void

setState

  • setState(state: any): void

  • Updates the component state with the provided properties. Only those state properties provided will be updated, while all other state properties will retain their existing values.

    memberof

    Component

    Parameters

    • state: any

    Returns void

setUI

  • setUI(mapping: {}): void

  • Assigns the UI targets according to the view's configured interface selectors.

    Note that this method should only be called after the view has been rendered and added to the DOM.

    memberof

    View

    Parameters

    • mapping: {}
      • [key: string]: string

    Returns void

show

  • show(): void

  • Shows the view.

    memberof

    View

    Returns void

size

  • Returns the view's current size.

    memberof

    View

    Returns Size

trigger

  • Triggers the specified event so that all registered listeners will be executed with the specified parameters.

    memberof

    EventDispatcher

    Parameters

    • type: any

      Event name to trigger

    • Default value data: any = null

    Returns EventDispatcher

update

  • update(data?: any, replace?: boolean): void

  • Parameters

    • Optional data: any
    • Default value replace: boolean = true

    Returns void

Generated using TypeDoc