Class TextEditorOptionsExt

Represents a text editor's options

Implements

TextEditorOptions

Index

Constructors

constructor

new TextEditorOptionsExt(proxy, id, source): TextEditorOptionsExt
Parameters
- proxy: TextEditorsMain
- id: string
- source: TextEditorConfiguration
Returns TextEditorOptionsExt
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:285

Properties

`Private` _cursorStyle

_cursorStyle: TextEditorCursorStyle

`Private` _indentSize

_indentSize: number | "tabSize"

`Private` _insertSpace

_insertSpace: boolean

`Private` _lineNumbers

_lineNumbers: TextEditorLineNumbersStyle

`Private` _tabSize

_tabSize: number

`Private` `Readonly` id

id: string

`Private` `Readonly` proxy

proxy: TextEditorsMain

Accessors

cursorStyle

get cursorStyle(): TextEditorCursorStyle
The rendering style of the cursor in this editor. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.

Returns TextEditorCursorStyle
Implementation of TextEditorOptions.cursorStyle
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:406
set cursorStyle(val): void
The rendering style of the cursor in this editor. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
Parameters
- val: TextEditorCursorStyle
Returns void
Implementation of TextEditorOptions.cursorStyle
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:410

indentSize

get indentSize(): number
The number of spaces to insert when insertSpaces is true.

When getting a text editor's options, this property will always be a number (resolved). When setting a text editor's options, this property is optional and it can be a number or "tabSize".

Returns number
Implementation of TextEditorOptions.indentSize
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:339
set indentSize(val): void
The number of spaces to insert when insertSpaces is true.

When getting a text editor's options, this property will always be a number (resolved). When setting a text editor's options, this property is optional and it can be a number or "tabSize".
Parameters
- val: undefined | string | number
Returns void
Implementation of TextEditorOptions.indentSize
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:346

insertSpaces

get insertSpaces(): string | boolean
When pressing Tab insert n spaces. When getting a text editor's options, this property will always be a boolean (resolved). When setting a text editor's options, this property is optional and it can be a boolean or "auto".

Returns string | boolean
Implementation of TextEditorOptions.insertSpaces
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:384
set insertSpaces(val): void
When pressing Tab insert n spaces. When getting a text editor's options, this property will always be a boolean (resolved). When setting a text editor's options, this property is optional and it can be a boolean or "auto".
Parameters
- val: string | boolean
Returns void
Implementation of TextEditorOptions.insertSpaces
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:388

lineNumbers

get lineNumbers(): TextEditorLineNumbersStyle
Render relative line numbers w.r.t. the current line number. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.

Returns TextEditorLineNumbersStyle
Implementation of TextEditorOptions.lineNumbers
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:418
set lineNumbers(val): void
Render relative line numbers w.r.t. the current line number. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.
Parameters
- val: TextEditorLineNumbersStyle
Returns void
Implementation of TextEditorOptions.lineNumbers
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:421

tabSize

get tabSize(): number
The size in spaces a tab takes. This is used for two purposes:
- the rendering width of a tab character;
- the number of spaces to insert when insertSpaces is true.
When getting a text editor's options, this property will always be a number (resolved). When setting a text editor's options, this property is optional and it can be a number or "auto".
Returns number
Implementation of TextEditorOptions.tabSize
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:299
set tabSize(val): void
The size in spaces a tab takes. This is used for two purposes:
- the rendering width of a tab character;
- the number of spaces to insert when insertSpaces is true.
When getting a text editor's options, this property will always be a number (resolved). When setting a text editor's options, this property is optional and it can be a number or "auto".
Parameters
- val: undefined | string | number
Returns void
Implementation of TextEditorOptions.tabSize
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:303

Methods

accept

accept(source): void
Parameters
- source: TextEditorConfiguration
Returns void
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:291

assign

assign(newOptions): void
Parameters
- newOptions: TextEditorOptions
Returns void
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:429

`Private` validateIndentSize

validateIndentSize(val): undefined | number | "tabSize"
Parameters
- val: undefined | string | number
Returns undefined | number | "tabSize"
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:365

`Private` validateInsertSpaces

validateInsertSpaces(val): boolean | "auto"
Parameters
- val: string | boolean
Returns boolean | "auto"
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:399

`Private` validateTabSize

validateTabSize(val): undefined | number | "auto"
Parameters
- val: undefined | string | number
Returns undefined | number | "auto"
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:320

Class TextEditorOptionsExt

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TextEditorOptionsExt

Properties

Private _cursorStyle

Private _indentSize

Private _insertSpace

Private _lineNumbers

Private _tabSize

Private Readonly id

Private Readonly proxy

Accessors

cursorStyle

Returns TextEditorCursorStyle

Parameters

Returns void

indentSize

Returns number

Parameters

Returns void

insertSpaces

Returns string | boolean

Parameters

Returns void

lineNumbers

Returns TextEditorLineNumbersStyle

Parameters

Returns void

tabSize

Returns number

Parameters

Returns void

Methods

accept

Parameters

Returns void

assign

Parameters

Returns void

Private validateIndentSize

Parameters

Returns undefined | number | "tabSize"

Private validateInsertSpaces

Parameters

Returns boolean | "auto"

Private validateTabSize

Parameters

Returns undefined | number | "auto"

Settings

Member Visibility

Theme

On This Page

`Private` _cursorStyle

`Private` _indentSize

`Private` _insertSpace

`Private` _lineNumbers

`Private` _tabSize

`Private` `Readonly` id

`Private` `Readonly` proxy

`Private` validateIndentSize

`Private` validateInsertSpaces

`Private` validateTabSize