> ## Documentation Index
> Fetch the complete documentation index at: https://dev.marginnote.com.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# Note

> Native instance exported as .

Native instance exported as `Note`.

## Properties

**annotation** `number | null` *required*

Exported member.

**childMindMap** `Note | null` *required*

**Type:** `Note | null`

Exported member.

**childNotes** `unknown[] | null` *required*

Exported member.

**colorIndex** `number` *required*

Exported member.

**comments** `unknown[] | null` *required*

Exported member.

**createDate** `Date | null` *required*

Exported member.

**docMd5** `string | null` *required*

Exported member.

**endPage** `number | null` *required*

Exported member.

**endPos** `string | null` *required*

Exported member.

**excerptPic** `Record\<string, unknown\> | null` *required*

Exported member.

**excerptText** `string | null` *required*

Exported member.

**excerptTextDirty** `number | null` *required*

Exported member.

**excerptTextMarkdown** `number | null` *required*

Exported member.

**fillIndex** `number` *required*

Exported member.

**flagged** `number | null` *required*

Exported member.

**flashcard** `number | null` *required*

Exported member.

**groupMode** `number | null` *required*

Exported member.

**groupNoteId** `string | null` *required*

Exported member.

**hasExcerptSelection** `number | null` *required*

Exported member.

**hashtags** `unknown[] | null` *required*

Exported member.

**hidden** `number | null` *required*

Exported member.

**lastBlankBandFailure** `string | null` *required*

Exported member.

**linkedNotes** `unknown[] | null` *required*

Exported member.

**mediaList** `string | null` *required*

Exported member.

**mindmapBranchClose** `number | null` *required*

Exported member.

**modifiedDate** `Date | null` *required*

Exported member.

**notebookId** `string | null` *required*

Exported member.

**noteId** `string | null` *required*

Exported member.

**notesText** `string | null` *required*

Exported member.

**noteTitle** `string | null` *required*

Exported member.

**options** `Record\<string, unknown\> | null` *required*

Exported member.

**originNoteId** `string | null` *required*

Exported member.

**parentNote** `Note | null` *required*

**Type:** `Note | null`

Exported member.

**startPage** `number | null` *required*

Exported member.

**startPos** `string | null` *required*

Exported member.

**summary** `boolean` *required*

Exported member.

**summaryLinks** `unknown[] | null` *required*

Exported member.

**textFirst** `number | null` *required*

Exported member.

**textHighlight** `Record\<string, unknown\> | null` *required*

Exported member.

**toc** `number | null` *required*

Exported member.

**zLevel** `number | null` *required*

Exported member.

## Methods

### addChild()

```typescript
addChild(_note: Note | null): void
```

Exported member.

#### Parameters

**\_note** `Note | null` *required*

**Type:** `Note | null`

### addHashtag()

```typescript
addHashtag(_hashtag: string | null): boolean
```

Exported member.

#### Parameters

**\_hashtag** `string | null` *required*

#### Returns

`boolean`

### addonValueForKey()

```typescript
addonValueForKey(_key: string | null): unknown
```

Exported member.

#### Parameters

**\_key** `string | null` *required*

#### Returns

`unknown`

### addonValues()

```typescript
addonValues(): Record<string, unknown> | null
```

Exported member.

#### Returns

`Record<string, unknown> | null`

### allNoteText()

```typescript
allNoteText(): string | null
```

Exported member.

#### Returns

`string | null`

### appendBlankBand()

```typescript
appendBlankBand(_role: string | null, _height: number | null): Note | null
```

Exported member.

#### Parameters

**\_role** `string | null` *required*

**\_height** `number | null` *required*

#### Returns

`Note | null`

### appendHtmlComment()

```typescript
appendHtmlComment(_html: string | null, _text: string | null, _size: CGSize, _tag: string | null): void
```

Exported member.

#### Parameters

**\_html** `string | null` *required*

**\_text** `string | null` *required*

**\_size** `CGSize` *required*

**\_tag** `string | null` *required*

### appendMarkdownComment()

```typescript
appendMarkdownComment(_text: string | null): void
```

Exported member.

#### Parameters

**\_text** `string | null` *required*

### appendNoteLink()

```typescript
appendNoteLink(_note: Note | null): void
```

Exported member.

#### Parameters

**\_note** `Note | null` *required*

**Type:** `Note | null`

### appendRichTextComment()

```typescript
appendRichTextComment(_text: string | null, _style: Record<string, unknown> | null): void
```

Exported member.

#### Parameters

**\_text** `string | null` *required*

**\_style** `Record\<string, unknown\> | null` *required*

### appendTextComment()

```typescript
appendTextComment(_text: string | null): void
```

Exported member.

#### Parameters

**\_text** `string | null` *required*

### blankBandImage()

```typescript
blankBandImage(_bandId: string | null, _maxEdge: number | null): NSData | null
```

Exported member.

#### Parameters

**\_bandId** `string | null` *required*

**\_maxEdge** `number | null` *required*

#### Returns

`NSData | null`

### blankBands()

```typescript
blankBands(): unknown[] | null
```

Exported member.

#### Returns

`unknown[] | null`

### clearFormat()

```typescript
clearFormat(): void
```

Exported member.

### commentState()

```typescript
commentState(): Record<string, unknown> | null
```

Exported member.

#### Returns

`Record<string, unknown> | null`

### getDrawingSize()

```typescript
getDrawingSize(): number | null
```

Exported member.

#### Returns

`number | null`

### getStrokesCount()

```typescript
getStrokesCount(): number
```

Exported member.

#### Returns

`number`

### insertChildBefore()

```typescript
insertChildBefore(_note: Note | null, _n: Note | null): void
```

Exported member.

#### Parameters

**\_note** `Note | null` *required*

**Type:** `Note | null`

**\_n** `Note | null` *required*

**Type:** `Note | null`

### merge()

```typescript
merge(_note: Note | null): void
```

Exported member.

#### Parameters

**\_note** `Note | null` *required*

**Type:** `Note | null`

### paste()

```typescript
paste(): void
```

Exported member.

### processMarkdownBase64Images()

```typescript
processMarkdownBase64Images(): boolean
```

Exported member.

#### Returns

`boolean`

### realGroupNoteIdForTopicId()

```typescript
realGroupNoteIdForTopicId(_topicid: string | null): string | null
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

#### Returns

`string | null`

### removeCommentByIndex()

```typescript
removeCommentByIndex(_index: number): void
```

Exported member.

#### Parameters

**\_index** `number` *required*

### removeFromParent()

```typescript
removeFromParent(): void
```

Exported member.

### removeHashtag()

```typescript
removeHashtag(_hashtag: string | null): boolean
```

Exported member.

#### Parameters

**\_hashtag** `string | null` *required*

#### Returns

`boolean`

### scrollToBlankBand()

```typescript
scrollToBlankBand(_bandId: string | null): boolean
```

Exported member.

#### Parameters

**\_bandId** `string | null` *required*

#### Returns

`boolean`

### setAddonValueForKey()

```typescript
setAddonValueForKey(_value: unknown, _key: string | null): boolean
```

Exported member.

#### Parameters

**\_value** `unknown` *required*

**\_key** `string | null` *required*

#### Returns

`boolean`

### setBlankBandClosed()

```typescript
setBlankBandClosed(_bandId: string | null, _closed: boolean): boolean
```

Exported member.

#### Parameters

**\_bandId** `string | null` *required*

**\_closed** `boolean` *required*

#### Returns

`boolean`

### setBlankBandHeight()

```typescript
setBlankBandHeight(_bandId: string | null, _height: number | null): boolean
```

Exported member.

#### Parameters

**\_bandId** `string | null` *required*

**\_height** `number | null` *required*

#### Returns

`boolean`

### setCommentField()

```typescript
setCommentField(_index: number, _fieldId: string | null, _isLabel: boolean): void
```

Exported member.

#### Parameters

**\_index** `number` *required*

**\_fieldId** `string | null` *required*

**\_isLabel** `boolean` *required*

### setCommentsCollapsed()

```typescript
setCommentsCollapsed(_targets: unknown, _collapsed: unknown, _revision: unknown): Record<string, unknown> | null
```

Exported member.

#### Parameters

**\_targets** `unknown` *required*

**\_collapsed** `unknown` *required*

**\_revision** `unknown` *required*

#### Returns

`Record<string, unknown> | null`

### sortCommentsByNewIndices()

```typescript
sortCommentsByNewIndices(_newIndices: unknown[] | null): void
```

Exported member.

#### Parameters

**\_newIndices** `unknown[] | null` *required*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.