Home > @i2analyze/notebook-sdk > data > IFormatter
data.IFormatter interface
A set of methods for formatting property values in i2 Notebook.
Signature:
interface IFormatter
Introduced: version 1.0
Remarks
For consistency with the rest of the i2 Notebook application, it is important that plug-ins use the methods here rather than manipulating values themselves.
These methods automatically use the appropriate formatting and translation locales, and use the same formatting rules as the rest of i2 Notebook.
Methods
| Method | Description |
|---|---|
| formatValue(value, options) | Formats a value as a string, using settings from the current locale as appropriate. |
| formatValueOrFallback(value, options) | Formats a value as a string, falling back to localized "No value" text if the value is undefined. |
| formatValueOrUndefined(value, options) | Formats a value as a string, or returns undefined if the value is undefined. |
| wrapForBidi(value, mode, forceTextDirection) | Wraps an input string in invisible Unicode Control Characters (LRE, RLE, PDF) to provide correct bidirectional behavior for the specified text direction. |
| wrapForBidi(value, mode, forceTextDirection) | Wraps an input string in invisible Unicode Control Characters (LRE, RLE, PDF) to provide correct bidirectional behavior for the specified text direction. |