Class pvc.options.format.CustomFormat
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
The options documentation of the custom format class.
|
| Method Attributes | Method Name and Description |
|---|---|
|
formatter(value, sourceValue)
The custom formatting function.
|
Class Detail
pvc.options.format.CustomFormat
The options documentation of the custom format class.
A custom format formats arbitrary values with a custom, user supplied, formatting function: CustomFormat#formatter.
See FormatProvider for more information on inheritance of formatting configurations.
Method Detail
{string}
formatter(value, sourceValue)
The custom formatting function.
The signature of this function is that of a dimension formatter.
- Context:
- {null}
- Arguments:
- {any} value
- The value to format.
- {any} sourceValue Optional
- The source (or raw) value,
when the value was read from a data source,
or
undefined, otherwise.
In the case where the raw value is a Google-table-like cell, it is the value of its v property that is passed to this argument.
- Returns:
- {string} The string that is the formatted value. Only the null value should have the empty string as the formatted value.