spectacular-dashboard / DashboardPanel / DashboardPanel

Class: DashboardPanel

DashboardPanel.DashboardPanel

Table of contents

Constructors

• constructor

Properties

• _disposables
• _extensionUri
• _fileWatcher
• _panel
• _rootPath
• currentPanel
• viewType

Methods

• _getHtmlForWebview
• _getThemeKind
• _handleGetFileTree
• _handleMessage
• _handleReadFile
• _handleSaveAllFiles
• _handleSaveFile
• _handleSelectDirectory
• _postMessage
• _sendConfig
• _startWatching
• _stopWatching
• dispose
• notifyFileChange
• reveal
• setRootPath
• showFile
• createOrShow
• dispose

Constructors

constructor

• new DashboardPanel(panel, extensionUri, rootPath?): DashboardPanel

Parameters

Name	Type
panel	WebviewPanel
extensionUri	Uri
rootPath?	string

Returns

DashboardPanel

Defined in

src/DashboardPanel.ts:53

Properties

_disposables

• Private _disposables: Disposable[] = []

Defined in

src/DashboardPanel.ts:15

---

_extensionUri

• Private Readonly _extensionUri: Uri

Defined in

src/DashboardPanel.ts:12

---

_fileWatcher

• Private _fileWatcher: undefined | FileSystemWatcher

Defined in

src/DashboardPanel.ts:14

---

_panel

• Private Readonly _panel: WebviewPanel

Defined in

src/DashboardPanel.ts:11

---

_rootPath

• Private _rootPath: undefined | string

Defined in

src/DashboardPanel.ts:13

---

currentPanel

▪ Static currentPanel: undefined | DashboardPanel

Defined in

src/DashboardPanel.ts:8

---

viewType

▪ Static Private Readonly viewType: "spectacularDashboard"

Defined in

src/DashboardPanel.ts:9

Methods

_getHtmlForWebview

▸ _getHtmlForWebview(): string

Returns

string

Defined in

src/DashboardPanel.ts:385

---

_getThemeKind

▸ _getThemeKind(theme): "dark" | "light"

Parameters

Name	Type
theme	ColorTheme

Returns

"dark" | "light"

Defined in

src/DashboardPanel.ts:374

---

_handleGetFileTree

▸ _handleGetFileTree(rootPath): Promise<void>

Parameters

Name	Type
rootPath	string

Returns

Promise<void>

Defined in

src/DashboardPanel.ts:209

---

_handleMessage

▸ _handleMessage(message): Promise<void>

Parameters

Name	Type
message	Object
message.command	string

Returns

Promise<void>

Defined in

src/DashboardPanel.ts:145

---

_handleReadFile

▸ _handleReadFile(filePath): Promise<void>

Parameters

Name	Type
filePath	string

Returns

Promise<void>

Defined in

src/DashboardPanel.ts:221

---

_handleSaveAllFiles

▸ _handleSaveAllFiles(files): Promise<void>

Parameters

Name	Type
files	{ content: string ; path: string }[]

Returns

Promise<void>

Defined in

src/DashboardPanel.ts:256

---

_handleSaveFile

▸ _handleSaveFile(filePath, content): Promise<void>

Parameters

Name	Type
filePath	string
content	string

Returns

Promise<void>

Defined in

src/DashboardPanel.ts:236

---

_handleSelectDirectory

▸ _handleSelectDirectory(): Promise<void>

Returns

Promise<void>

Defined in

src/DashboardPanel.ts:287

---

_postMessage

▸ _postMessage(message): void

Parameters

Name	Type
message	Object
message.data?	unknown
message.type	string

Returns

void

Defined in

src/DashboardPanel.ts:381

---

_sendConfig

▸ _sendConfig(): Promise<void>

Returns

Promise<void>

Defined in

src/DashboardPanel.ts:350

---

_startWatching

▸ _startWatching(rootPath): void

Parameters

Name	Type
rootPath	string

Returns

void

Defined in

src/DashboardPanel.ts:306

---

_stopWatching

▸ _stopWatching(): void

Returns

void

Defined in

src/DashboardPanel.ts:342

---

dispose

▸ dispose(): void

Returns

void

Defined in

src/DashboardPanel.ts:435

---

notifyFileChange

▸ notifyFileChange(filePath): void

Parameters

Name	Type
filePath	string

Returns

void

Defined in

src/DashboardPanel.ts:133

---

reveal

▸ reveal(preserveFocus?): void

Parameters

Name	Type	Default value
preserveFocus	boolean	false

Returns

void

Defined in

src/DashboardPanel.ts:129

---

setRootPath

▸ setRootPath(rootPath): void

Parameters

Name	Type
rootPath	string

Returns

void

Defined in

src/DashboardPanel.ts:113

---

showFile

▸ showFile(filePath): void

Parameters

Name	Type
filePath	string

Returns

void

Defined in

src/DashboardPanel.ts:119

---

createOrShow

▸ createOrShow(extensionUri, rootPath?, column?): void

Parameters

Name	Type	Default value
extensionUri	Uri	undefined
rootPath?	string	undefined
column	ViewColumn	vscode.ViewColumn.One

Returns

void

Defined in

src/DashboardPanel.ts:17

---

dispose

▸ dispose(): void

Returns

void

Defined in

src/DashboardPanel.ts:49