TextDocument

Documentation / editor/document/TextDocument

default

Defined in: editor/document/TextDocument.ts:18

Constructors

Constructor

new default(linesOrDocOrDelta?: 
  | default
  | Line[]
  | default, selection?: EditorRange): default;

Defined in: editor/document/TextDocument.ts:25

Parameters

Parameter	Type	Default value
linesOrDocOrDelta?	| default | Line[] | default	undefined
selection?	EditorRange	null

Returns

default

Properties

byId

byId: LineIds;

Defined in: editor/document/TextDocument.ts:20

length

length: number;

Defined in: editor/document/TextDocument.ts:22

lines

lines: Line[];

Defined in: editor/document/TextDocument.ts:21

selection

selection: EditorRange;

Defined in: editor/document/TextDocument.ts:23

Accessors

change

Get Signature

get change(): default;

Defined in: editor/document/TextDocument.ts:68

Returns

default

Methods

apply()

apply(
   change: 
  | default
  | default, 
   selection?: EditorRange, 
   throwOnError?: boolean): default;

Defined in: editor/document/TextDocument.ts:180

Parameters

Parameter	Type
change	| default | default
selection?	EditorRange
throwOnError?	boolean

Returns

default

equals()

equals(other: default, options?: object): boolean;

Defined in: editor/document/TextDocument.ts:353

Parameters

Parameter	Type
other	default
options?	{ contentOnly: boolean; }
options.contentOnly?	boolean

Returns

boolean

getFormats()

getFormats(at: number | EditorRange, options?: FormattingOptions): AttributeMap;

Defined in: editor/document/TextDocument.ts:153

Parameters

Parameter	Type
at	number | EditorRange
options?	FormattingOptions

Returns

AttributeMap

getLineAt()

getLineAt(at: number): Line;

Defined in: editor/document/TextDocument.ts:85

Parameters

Parameter	Type
at	number

Returns

Line

getLineBy()

getLineBy(id: string): Line;

Defined in: editor/document/TextDocument.ts:81

Parameters

Parameter	Type
id	string

Returns

Line

getLineFormat()

getLineFormat(at: number | EditorRange, options?: FormattingOptions): AttributeMap;

Defined in: editor/document/TextDocument.ts:126

Parameters

Parameter	Type
at	number | EditorRange
options?	FormattingOptions

Returns

AttributeMap

getLineRange()

getLineRange(at: string | number | Line): EditorRange;

Defined in: editor/document/TextDocument.ts:104

Parameters

Parameter	Type
at	string | number | Line

Returns

EditorRange

getLineRanges()

getLineRanges(at?: number | EditorRange): any[];

Defined in: editor/document/TextDocument.ts:118

Parameters

Parameter	Type
at?	number | EditorRange

Returns

any[]

getLinesAt()

getLinesAt(atOrRange: number | EditorRange, encompassed?: boolean): Line[];

Defined in: editor/document/TextDocument.ts:92

Parameters

Parameter	Type
atOrRange	number | EditorRange
encompassed?	boolean

Returns

Line[]

getText()

getText(range?: EditorRange): string;

Defined in: editor/document/TextDocument.ts:74

Parameters

Parameter	Type
range?	EditorRange

Returns

string

getTextFormat()

getTextFormat(at: number | EditorRange, options?: FormattingOptions): AttributeMap;

Defined in: editor/document/TextDocument.ts:136

Parameters

Parameter	Type
at	number | EditorRange
options?	FormattingOptions

Returns

AttributeMap

replace()

replace(delta?: default, selection?: EditorRange): default;

Defined in: editor/document/TextDocument.ts:339

Parameters

Parameter	Type
delta?	default
selection?	EditorRange

Returns

default

slice()

slice(start: number, end: number): default;

Defined in: editor/document/TextDocument.ts:163

Parameters

Parameter	Type	Default value
start	number	0
end	number	Infinity

Returns

default

toDelta()

toDelta(): default;

Defined in: editor/document/TextDocument.ts:343

Returns

default

toJSON()

toJSON(): default;

Defined in: editor/document/TextDocument.ts:361

Returns

default

toString()

toString(): string;

Defined in: editor/document/TextDocument.ts:365

Returns

string

---

FormattingOptions

Defined in: editor/document/TextDocument.ts:13

Properties

Property	Type	Defined in
allFormats?	boolean	editor/document/TextDocument.ts:15
nameOnly?	boolean	editor/document/TextDocument.ts:14