Documentation / joplin-api / NoteProperties
Interface: NoteProperties
Defined in: model/NoteProperties.ts:4
Extends
Properties
altitude
altitude:
number
Defined in: model/NoteProperties.ts:28
numeric
application_data
application_data:
string
Defined in: model/NoteProperties.ts:60
text
author
author:
string
Defined in: model/NoteProperties.ts:32
text
base_url
base_url:
string
Defined in: model/NoteProperties.ts:76
If body_html is provided and contains relative URLs, provide the base_url parameter too so that all the URLs can be converted to absolute ones. The base URL is basically where the HTML was fetched from, minus the query (everything after the '?'). For example if the original page was https://stackoverflow.com/search?q=[java]+test, the base URL is https://stackoverflow.com/search.
body
body:
string
Defined in: model/NoteProperties.ts:12
The note body, in Markdown. May also contain HTML.
body_html
body_html:
string
Defined in: model/NoteProperties.ts:72
Note body, in HTML format
created_time
created_time:
number
Defined in: model/BaseProperties.ts:9
When the folder was created.
Inherited from
crop_rect
crop_rect:
object
Defined in: model/NoteProperties.ts:84
If an image is provided, you can also specify an optional rectangle that will be used to crop the image. In format { x: x, y: y, width: width, height: height }
height
height:
number
width
width:
number
x
x:
number
y
y:
number
encryption_applied
encryption_applied:
number
Defined in: model/BaseProperties.ts:33
Inherited from
BaseProperties.encryption_applied
encryption_cipher_text
encryption_cipher_text:
string
Defined in: model/BaseProperties.ts:29
text
Inherited from
BaseProperties.encryption_cipher_text
id
id:
string
Defined in: model/BaseProperties.ts:5
text
Inherited from
image_data_url
image_data_url:
string
Defined in: model/NoteProperties.ts:80
An image to attach to the note, in Data URL format.
is_conflict
is_conflict:
number
Defined in: model/NoteProperties.ts:16
Tells whether the note is a conflict or not.
is_shared
is_shared:
number
Defined in: model/BaseProperties.ts:37
Inherited from
is_todo
is_todo:
IntBool
Defined in: model/NoteProperties.ts:40
Tells whether this note is a to-do or not.
latitude
latitude:
number
Defined in: model/NoteProperties.ts:20
numeric
longitude
longitude:
number
Defined in: model/NoteProperties.ts:24
numeric
markup_language
markup_language:
number
Defined in: model/NoteProperties.ts:68
int
order
order:
number
Defined in: model/NoteProperties.ts:64
int
parent_id
parent_id:
string
Defined in: model/NoteProperties.ts:8
ID of the notebook that contains this note. Change this ID to move the note to a different notebook.
source
source:
string
Defined in: model/NoteProperties.ts:52
text
source_application
source_application:
string
Defined in: model/NoteProperties.ts:56
text
source_url
source_url:
string
Defined in: model/NoteProperties.ts:36
The full URL where the note comes from.
title
title:
string
Defined in: model/BaseProperties.ts:25
The tag title.
Inherited from
todo_completed
todo_completed:
IntBool
Defined in: model/NoteProperties.ts:48
Tells whether to-do is completed or not. This is a timestamp in milliseconds.
todo_due
todo_due:
IntBool
Defined in: model/NoteProperties.ts:44
When the to-do is due. An alarm will be triggered on that date.
updated_time
updated_time:
number
Defined in: model/BaseProperties.ts:13
When the folder was last updated.
Inherited from
user_created_time
user_created_time:
number
Defined in: model/BaseProperties.ts:17
When the folder was created. It may differ from created_time as it can be manually set by the user.
Inherited from
BaseProperties.user_created_time
user_updated_time
user_updated_time:
number
Defined in: model/BaseProperties.ts:21
When the folder was last updated. It may differ from updated_time as it can be manually set by the user.