Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KanbanBoard

A kanban board.

Hierarchy

  • DisposableBase
    • KanbanBoard

Implements

  • Disposable

Index

Properties

Accessors

Methods

Properties

Protected _DISPOSABLES

_DISPOSABLES: vscode.Disposable[]

Stores disposable sub objects.

Protected _INTERVALS

_INTERVALS: Timer[]

Stores intervals.

Protected _TIMEOUTS

_TIMEOUTS: Timer[]

Stores timeouts.

Private _openOptions

_openOptions: OpenBoardOptions

Private _panel

_panel: vscode.WebviewPanel

Private _saveBoardEventListeners

_saveBoardEventListeners: SaveBoardEventListener[]

Private _saveBoardFilterEventListeners

_saveBoardFilterEventListeners: SaveBoardFilterEventListener[]

isDisposed

isDisposed: boolean

Gets if object has been disposed or not.

isDisposing

isDisposing: boolean

Gets if the 'dispose()' method is currently executed or not.

isInFinalizeState

isInFinalizeState: boolean

Gets if the object is disposed or currently disposing.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

file

  • get file(): vscode.Uri

  • Gets the board file to use.

    Returns vscode.Uri

openOptions

panel

  • get panel(): vscode.WebviewPanel

  • Gets the underlying panel.

    Returns vscode.WebviewPanel

view

  • get view(): vscode.Webview

  • Gets the underlying web view.

    Returns vscode.Webview

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected cleanupIntervals

  • cleanupIntervals(): void

  • Cleansup all timeouts.

    Returns void

Protected cleanupTimeouts

  • cleanupTimeouts(): void

  • Cleansup all timeouts.

    Returns void

dispose

  • dispose(): void
  • inheritdoc

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

Private generateHTML

  • generateHTML(): string

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getResourceUri

  • getResourceUri(p: string): vscode.Uri

  • Returns an URI from the 'resources' directory.

    Parameters

    • p: string

      The (relative) path.

    Returns vscode.Uri

    The URI.

Private getWebViewResourceUris

  • getWebViewResourceUris(): vscode.Uri[]

initialize

  • initialize(): Promise<void>

  • Initializes the board.

    Returns Promise<void>

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected onDispose

  • onDispose(): void

  • Is invoked after the underlying panel has been disposed.

    Returns void

Private onLoaded

  • onLoaded(): Promise<void>

onSaveBoard

onSaveBoardFilter

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

open

  • Opens the board.

    Parameters

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not.

postMessage

  • postMessage(command: string, data?: any): Promise<boolean>
  • inheritdoc

    Parameters

    • command: string
    • Optional data: any

    Returns Promise<boolean>

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Private raiseEvent

  • raiseEvent(name: string, data: any): Promise<void>

  • Parameters

    • name: string
    • data: any

    Returns Promise<void>

Private reloadBoard

  • reloadBoard(): Promise<void>

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc