Back to Trilium

Interface NoteParams

docs/Script API/interfaces/Backend_Script_API._internal_.NoteParams.html

0.102.23.2 KB
Original Source

Interface NoteParams

interface NoteParams {
branchId?: string;
content: string | Buffer<ArrayBufferLike>;
dateCreated?: string;
ignoreForbiddenParents?: boolean;
isExpanded?: boolean;
isProtected?: boolean;
mime?: string;
noteId?: string;
notePosition?: number;
parentNoteId: string;
prefix?: string;
target?: "into";
templateNoteId?: string;
title: string;
type:
| "canvas"
| "code"
| "search"
| "image"
| "text"
| "file"
| "noteMap"
| "launcher"
| "doc"
| "contentWidget"
| "relationMap"
| "render"
| "mermaid"
| "book"
| "webView"
| "mindMap"
| "geoMap";
utcDateCreated?: string;
}

Index

Properties

branchId?contentdateCreated?ignoreForbiddenParents?isExpanded?isProtected?mime?noteId?notePosition?parentNoteIdprefix?target?templateNoteId?titletypeutcDateCreated?

Properties

OptionalbranchId

branchId?: string

content

content: string | Buffer<ArrayBufferLike>

OptionaldateCreated

dateCreated?: string

OptionalignoreForbiddenParents

ignoreForbiddenParents?: boolean

OptionalisExpanded

isExpanded?: boolean

default is false

OptionalisProtected

isProtected?: boolean

default is false

Optionalmime

mime?: string

default value is derived from default mimes for type

OptionalnoteId

noteId?: string

optionally can force specific noteId

OptionalnotePosition

notePosition?: number

default is the last existing notePosition in a parent + 10

parentNoteId

parentNoteId: string

Optionalprefix

prefix?: string

default is empty string

Optionaltarget

target?: "into"

OptionaltemplateNoteId

templateNoteId?: string

title

title: string

type

type:
| "canvas"
| "code"
| "search"
| "image"
| "text"
| "file"
| "noteMap"
| "launcher"
| "doc"
| "contentWidget"
| "relationMap"
| "render"
| "mermaid"
| "book"
| "webView"
| "mindMap"
| "geoMap"

text, code, file, image, search, book, relationMap, canvas, webView

OptionalutcDateCreated

utcDateCreated?: string

Settings

Member Visibility

  • Protected
  • Inherited
  • External

ThemeOSLightDark

On This Page

Properties branchIdcontentdateCreatedignoreForbiddenParentsisExpandedisProtectedmimenoteIdnotePositionparentNoteIdprefixtargettemplateNoteIdtitletypeutcDateCreated