Documentation / joplin-api / NoteProperties
Interface: NoteProperties
Extends
Properties
altitude
altitude:
number
numeric
Defined in
application_data
application_data:
string
text
Defined in
author
author:
string
text
Defined in
base_url
base_url:
string
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.
Defined in
body
body:
string
The note body, in Markdown. May also contain HTML.
Defined in
body_html
body_html:
string
Note body, in HTML format
Defined in
created_time
created_time:
number
When the folder was created.
Inherited from
Defined in
crop_rect
crop_rect:
object
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
Defined in
encryption_applied
encryption_applied:
number
Inherited from
BaseProperties.encryption_applied
Defined in
encryption_cipher_text
encryption_cipher_text:
string
text
Inherited from
BaseProperties.encryption_cipher_text
Defined in
id
id:
string
text
Inherited from
Defined in
image_data_url
image_data_url:
string
An image to attach to the note, in Data URL format.
Defined in
is_conflict
is_conflict:
number
Tells whether the note is a conflict or not.
Defined in
is_shared
is_shared:
number
Inherited from
Defined in
is_todo
is_todo:
IntBool
Tells whether this note is a to-do or not.
Defined in
latitude
latitude:
number
numeric
Defined in
longitude
longitude:
number
numeric
Defined in
markup_language
markup_language:
number
int
Defined in
order
order:
number
int
Defined in
parent_id
parent_id:
string
ID of the notebook that contains this note. Change this ID to move the note to a different notebook.
Defined in
source
source:
string
text
Defined in
source_application
source_application:
string
text
Defined in
source_url
source_url:
string
The full URL where the note comes from.
Defined in
title
title:
string
The tag title.
Inherited from
Defined in
todo_completed
todo_completed:
IntBool
Tells whether to-do is completed or not. This is a timestamp in milliseconds.
Defined in
todo_due
todo_due:
IntBool
When the to-do is due. An alarm will be triggered on that date.
Defined in
updated_time
updated_time:
number
When the folder was last updated.
Inherited from
Defined in
user_created_time
user_created_time:
number
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
Defined in
user_updated_time
user_updated_time:
number
When the folder was last updated. It may differ from updated_time as it can be manually set by the user.
Inherited from
BaseProperties.user_updated_time