Skip to main content

Class: VscodeHats

ide/vscode/hats/VscodeHats.VscodeHats

Implements

Constructors

constructor

new VscodeHats(ide, extensionContext)

Parameters

NameType
ideVscodeIDE
extensionContextExtensionContext

Defined in

ide/vscode/hats/VscodeHats.ts:25

Properties

enabledHatStyleManager

Private enabledHatStyleManager: VscodeEnabledHatStyleManager

Defined in

ide/vscode/hats/VscodeHats.ts:19


hatRanges

Private hatRanges: HatRange[] = []

Defined in

ide/vscode/hats/VscodeHats.ts:23


hatRenderer

Private hatRenderer: VscodeHatRenderer

Defined in

ide/vscode/hats/VscodeHats.ts:20


isEnabled

isEnabled: boolean

Whether hats are enabled. This can be determined by a setting, a toggle command, or both.

Implementation of

Hats.isEnabled

Defined in

ide/vscode/hats/VscodeHats.ts:21


isEnabledNotifier

Private isEnabledNotifier: Notifier<[boolean]>

Defined in

ide/vscode/hats/VscodeHats.ts:22

Accessors

enabledHatStyles

get enabledHatStyles(): HatStyleMap

Mapping from enabled hat styles to their penalties. Each hat style represents a combination of hat style components (eg color, shape, etc). So a hat style might be "green-curve".

Returns

HatStyleMap

Implementation of

Hats.enabledHatStyles

Defined in

ide/vscode/hats/VscodeHats.ts:119

Methods

applyHatDecorations

Private applyHatDecorations(): Promise<void>

Returns

Promise<void>

Defined in

ide/vscode/hats/VscodeHats.ts:86


handleHatDecorationMapUpdated

Private handleHatDecorationMapUpdated(): void

Returns

void

Defined in

ide/vscode/hats/VscodeHats.ts:64


init

init(): Promise<void>

Returns

Promise<void>

Defined in

ide/vscode/hats/VscodeHats.ts:55


onDidChangeEnabledHatStyles

onDidChangeEnabledHatStyles(listener): Disposable

Parameters

NameType
listenerListener<[HatStyleMap]>

Returns

Disposable

Implementation of

Hats.onDidChangeEnabledHatStyles

Defined in

ide/vscode/hats/VscodeHats.ts:123


onDidChangeIsEnabled

onDidChangeIsEnabled(listener): Disposable

Parameters

NameType
listenerListener<[boolean]>

Returns

Disposable

Implementation of

Hats.onDidChangeIsEnabled

Defined in

ide/vscode/hats/VscodeHats.ts:127


setHatRanges

setHatRanges(hatRanges): Promise<void>

Set which ranges each hat should have

Parameters

NameType
hatRangesHatRange[]

Returns

Promise<void>

Implementation of

Hats.setHatRanges

Defined in

ide/vscode/hats/VscodeHats.ts:81


toggle

Private toggle(): void

Returns

void

Defined in

ide/vscode/hats/VscodeHats.ts:59