aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/javascript/formatters.texi
blob: a3086aa9ac144ae6258eed749c921f617fbe2bd5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@node formatters
@subsection formatters

Formatting procedures used by some components.
@c TODO can we have a backref of every node containing @ref{formatters-proc}?

@deftypefun void format(targetElement:HTMLElement, data:VEvent, key:string)
Checks if a specific formatter exists for the given key, and executes
it.
Defaults to 'default', and also runs that if the regular formatter throws.
@end deftypefun

@deftypevar {Map<string, (e:HTMLElement, d:VEvent, s:any) => void>} formatters
@anchor{formatters-proc}

Each procedure takes three arguments. The HTML-element which contents
should be replaced, the VEvent containing all data, and the target
value, as returned by @ref{VEvent.getProperty}.
@end deftypevar

@deftypevr {Window Value} {Map<string, (e:HTMLElement, d:VEvent, s:string) => void>} formatters
Same object as @xref{formatters-proc}. Provided for @xref{user-additions.js}.
@end deftypevr