docs/Script API/classes/Frontend_Script_API._internal_.default-5.html
AbstractThe base class for all the note types.
_noteId_position$widgetattrschildrencomponentIdinitializednoteContext?parent?spacedUpdate
hoistedNoteIdnotenoteIdnotePathntxIdpositionsanitizedClassName
activeContextChangedactiveContextChangedEventcallMethodcanBeShownchildclasscleanupcollapsiblecontentSizedcsscssBlockdataSaveddoRefreshdoRenderfillingfocusfrocaReloadedEventgetClosestNtxIdgetDatagetPositionhandleEventhandleEventInChildrenidisActiveisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisiblelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventoptChildoptCssreadOnlyTemporarilyDisabledEventrefreshrefreshWithNoteremoverenderscrollToEndsetNoteContextEventsetParenttoggleExttoggleInttriggerCommandtriggerEventgetType
new default(): default
_noteId: string
_position: number
$widget: JQuery<HTMLElement>
Protectedattrsattrs: Record<string, string>
children: default[]
componentId: string
initialized: null | Promise<void>
OptionalnoteContextnoteContext?: NoteContext
Optionalparentparent?: TypedComponent<any>
spacedUpdate: default
get hoistedNoteId(): undefined | string
get note(): undefined | null | FNote
get noteId(): undefined | string
get notePath(): undefined | null | string
get ntxId(): undefined | null | string
get position(): number
set position(newPosition: number): void
get sanitizedClassName(): string
activeContextChanged(): Promise<void>
activeContextChangedEvent(
__namedParameters: { noteContext: NoteContext },
): Promise<void>
callMethod(
fun: (arg: unknown) => Promise<unknown>,
data: unknown,
): undefined | Promise<unknown>
canBeShown(): boolean
child(...components: default[]): default
class(className: string): default
cleanup(): void
collapsible(): default
contentSized(): default
css(name: string, value: string): default
Sets the CSS attribute of the given name to the given value.
the name of the CSS attribute to set (e.g. padding-left).
the value of the CSS attribute to set (e.g. 12px).
self for chaining.
cssBlock(block: string): default
Accepts a string of CSS to add with the widget.
for chaining
dataSaved(): void
doRefresh(note: FNote): void | Promise<void>
doRender(): void
Method used for rendering the widget.
Your class should override this method. The method is expected to create a this.$widget containing jQuery object
filling(): default
focus(): void
frocaReloadedEvent(): Promise<void>
getClosestNtxId(): undefined | null | string
getData(): void
promise resolving note data. Note data is an object with content.
getPosition(): number
handleEvent<T extends EventNames>(
name: T,
data: EventData<T>,
): undefined | null | Promise<unknown>
handleEventInChildren<T extends EventNames>(
name: T,
data: EventData<T>,
): null | Promise<unknown>
By default:
activeContextChanged is intercepted and converted to a setNoteContext event to avoid refresh().entitiesReloaded and refreshData are passed as-is.id(id: string): default
isActive(): boolean
isActiveNoteContext(): boolean
isEnabled(): undefined | null | boolean
Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to false will cause the widget not to be displayed, however it will still be available on the DOM but hidden.
If the widget is not enabled, it will not receive refreshWithNote updates.
true when an active note exists
isHiddenExt(): boolean
isHiddenInt(): boolean
isNote(noteId: string): boolean
isNoteContext(
ntxId: undefined | null | string | string[],
): undefined | null | boolean | ""
isVisible(): boolean
logRenderingError(e: Error): void
noteSwitched(): Promise<void>
noteSwitchedAndActivatedEvent(
__namedParameters: NoteSwitchedContext,
): Promise<void>
noteSwitchedEvent(__namedParameters: NoteSwitchedContext): Promise<void>
noteTypeMimeChangedEvent(__namedParameters: { noteId: string }): Promise<void>
optChild(condition: boolean, ...components: default[]): default
Conditionally adds the given components as children to this component.
whether to add the components.
the components to be added as children to this component provided the condition is truthy.
self for chaining.
optCss(condition: boolean, name: string, value: string): default
Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.
true in order to apply the CSS, false to ignore it.
the name of the CSS attribute to set (e.g. padding-left).
the value of the CSS attribute to set (e.g. 12px).
self for chaining.
readOnlyTemporarilyDisabledEvent(
__namedParameters: { noteContext: NoteContext },
): Promise<void>
refresh(): Promise<void>
refreshWithNote(note: undefined | null | FNote): Promise<void>
Override this method to be able to refresh your widget with each note.
remove(): void
render(): JQuery<HTMLElement>
scrollToEnd(): void
setNoteContextEvent(__namedParameters: { noteContext: NoteContext }): void
setParent(parent: TypedComponent<any>): default
toggleExt(show: undefined | null | boolean | ""): void
toggleInt(show: undefined | null | boolean): void
triggerCommand<K extends keyof CommandMappings>(
name: K,
data?: CommandMappings[K],
): undefined | null | Promise<unknown>
Optionaldata: CommandMappings[K]triggerEvent<T extends EventNames>(
name: T,
data: EventData<T>,
): undefined | null | Promise<unknown>
StaticgetTypegetType(): void
Member Visibility
ThemeOSLightDark
Constructors constructor Properties _noteId_position$widgetattrschildrencomponentIdinitializednoteContextparentspacedUpdate Accessors hoistedNoteIdnotenoteIdnotePathntxIdpositionsanitizedClassName Methods activeContextChangedactiveContextChangedEventcallMethodcanBeShownchildclasscleanupcollapsiblecontentSizedcsscssBlockdataSaveddoRefreshdoRenderfillingfocusfrocaReloadedEventgetClosestNtxIdgetDatagetPositionhandleEventhandleEventInChildrenidisActiveisActiveNoteContextisEnabledisHiddenExtisHiddenIntisNoteisNoteContextisVisiblelogRenderingErrornoteSwitchednoteSwitchedAndActivatedEventnoteSwitchedEventnoteTypeMimeChangedEventoptChildoptCssreadOnlyTemporarilyDisabledEventrefreshrefreshWithNoteremoverenderscrollToEndsetNoteContextEventsetParenttoggleExttoggleInttriggerCommandtriggerEventgetType