/
format.ts
242 lines (217 loc) · 7.21 KB
/
format.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
import {SignalRef} from 'vega';
import {isString} from 'vega-util';
import {isBinning} from '../bin';
import {
channelDefType,
DatumDef,
FieldDef,
isFieldDef,
isFieldOrDatumDefForTimeFormat,
isScaleFieldDef,
vgField
} from '../channeldef';
import {Config} from '../config';
import {fieldValidPredicate} from '../predicate';
import {ScaleType} from '../scale';
import {formatExpression, normalizeTimeUnit, timeUnitSpecifierExpression} from '../timeunit';
import {QUANTITATIVE, Type} from '../type';
import {Dict, stringify} from '../util';
import {isSignalRef} from '../vega.schema';
import {TimeUnit} from './../timeunit';
import {datumDefToExpr} from './mark/encode/valueref';
export function isCustomFormatType(formatType: string) {
return formatType && formatType !== 'number' && formatType !== 'time';
}
function customFormatExpr(formatType: string, field: string, format: string | Dict<unknown>) {
return `${formatType}(${field}${format ? `, ${stringify(format)}` : ''})`;
}
export const BIN_RANGE_DELIMITER = ' \u2013 ';
export function formatSignalRef({
fieldOrDatumDef,
format,
formatType,
expr,
normalizeStack,
config
}: {
fieldOrDatumDef: FieldDef<string> | DatumDef<string>;
format: string | Dict<unknown>;
formatType: string;
expr?: 'datum' | 'parent' | 'datum.datum';
normalizeStack?: boolean;
config: Config;
}) {
if (isCustomFormatType(formatType)) {
return formatCustomType({
fieldOrDatumDef,
format,
formatType,
expr,
config
});
}
const field = fieldToFormat(fieldOrDatumDef, expr, normalizeStack);
if (isFieldOrDatumDefForTimeFormat(fieldOrDatumDef)) {
const signal = timeFormatExpression(
field,
isFieldDef(fieldOrDatumDef) ? normalizeTimeUnit(fieldOrDatumDef.timeUnit)?.unit : undefined,
format,
config.timeFormat,
isScaleFieldDef(fieldOrDatumDef) && fieldOrDatumDef.scale?.type === ScaleType.UTC
);
return signal ? {signal} : undefined;
}
format = numberFormat(channelDefType(fieldOrDatumDef), format, config);
if (isFieldDef(fieldOrDatumDef) && isBinning(fieldOrDatumDef.bin)) {
const endField = vgField(fieldOrDatumDef, {expr, binSuffix: 'end'});
return {
signal: binFormatExpression(field, endField, format, formatType, config)
};
} else if (format || channelDefType(fieldOrDatumDef) === 'quantitative') {
return {
signal: `${formatExpr(field, format)}`
};
} else {
return {signal: `isValid(${field}) ? ${field} : ""+${field}`};
}
}
function fieldToFormat(
fieldOrDatumDef: FieldDef<string> | DatumDef<string>,
expr: 'datum' | 'parent' | 'datum.datum',
normalizeStack: boolean
) {
if (isFieldDef(fieldOrDatumDef)) {
if (normalizeStack) {
return `${vgField(fieldOrDatumDef, {expr, suffix: 'end'})}-${vgField(fieldOrDatumDef, {
expr,
suffix: 'start'
})}`;
} else {
return vgField(fieldOrDatumDef, {expr});
}
} else {
return datumDefToExpr(fieldOrDatumDef);
}
}
export function formatCustomType({
fieldOrDatumDef,
format,
formatType,
expr,
normalizeStack,
config,
field
}: {
fieldOrDatumDef: FieldDef<string> | DatumDef<string>;
format: string | Dict<unknown>;
formatType: string;
expr?: 'datum' | 'parent' | 'datum.datum';
normalizeStack?: boolean;
config: Config;
field?: string; // axis/legend "use datum.value"
}) {
field ??= fieldToFormat(fieldOrDatumDef, expr, normalizeStack);
if (isFieldDef(fieldOrDatumDef) && isBinning(fieldOrDatumDef.bin)) {
const endField = vgField(fieldOrDatumDef, {expr, binSuffix: 'end'});
return {
signal: binFormatExpression(field, endField, format, formatType, config)
};
}
return {signal: customFormatExpr(formatType, field, format)};
}
export function guideFormat(
fieldOrDatumDef: FieldDef<string> | DatumDef<string>,
type: Type,
format: string | Dict<unknown>,
formatType: string,
config: Config,
omitTimeFormatConfig: boolean // axis doesn't use config.timeFormat
) {
if (isCustomFormatType(formatType)) {
return undefined; // handled in encode block
}
if (isFieldOrDatumDefForTimeFormat(fieldOrDatumDef)) {
const timeUnit = isFieldDef(fieldOrDatumDef) ? normalizeTimeUnit(fieldOrDatumDef.timeUnit)?.unit : undefined;
return timeFormat(format as string, timeUnit, config, omitTimeFormatConfig);
}
return numberFormat(type, format, config);
}
export function guideFormatType(
formatType: string | SignalRef,
fieldOrDatumDef: FieldDef<string> | DatumDef<string>,
scaleType: ScaleType
) {
if (formatType && (isSignalRef(formatType) || formatType === 'number' || formatType === 'time')) {
return formatType;
}
if (isFieldOrDatumDefForTimeFormat(fieldOrDatumDef) && scaleType !== 'time' && scaleType !== 'utc') {
return isFieldDef(fieldOrDatumDef) && normalizeTimeUnit(fieldOrDatumDef?.timeUnit)?.utc ? 'utc' : 'time';
}
return undefined;
}
/**
* Returns number format for a fieldDef.
*/
export function numberFormat(type: Type, specifiedFormat: string | Dict<unknown>, config: Config) {
// Specified format in axis/legend has higher precedence than fieldDef.format
if (isString(specifiedFormat)) {
return specifiedFormat;
}
if (type === QUANTITATIVE) {
// we only apply the default if the field is quantitative
return config.numberFormat;
}
return undefined;
}
/**
* Returns time format for a fieldDef for use in guides.
*/
export function timeFormat(specifiedFormat: string, timeUnit: TimeUnit, config: Config, omitTimeFormatConfig: boolean) {
if (specifiedFormat) {
return specifiedFormat;
}
if (timeUnit) {
return {
signal: timeUnitSpecifierExpression(timeUnit)
};
}
return omitTimeFormatConfig ? undefined : config.timeFormat;
}
function formatExpr(field: string, format: string) {
return `format(${field}, "${format || ''}")`;
}
function binNumberFormatExpr(field: string, format: string | Dict<unknown>, formatType: string, config: Config) {
if (isCustomFormatType(formatType)) {
return customFormatExpr(formatType, field, format);
}
return formatExpr(field, (isString(format) ? format : undefined) ?? config.numberFormat);
}
export function binFormatExpression(
startField: string,
endField: string,
format: string | Dict<unknown>,
formatType: string,
config: Config
) {
const start = binNumberFormatExpr(startField, format, formatType, config);
const end = binNumberFormatExpr(endField, format, formatType, config);
return `${fieldValidPredicate(startField, false)} ? "null" : ${start} + "${BIN_RANGE_DELIMITER}" + ${end}`;
}
/**
* Returns the time expression used for axis/legend labels or text mark for a temporal field
*/
export function timeFormatExpression(
field: string,
timeUnit: TimeUnit,
format: string | Dict<unknown>,
rawTimeFormat: string, // should be provided only for actual text and headers, not axis/legend labels
isUTCScale: boolean
): string {
if (!timeUnit || format) {
// If there is no time unit, or if user explicitly specifies format for axis/legend/text.
format = isString(format) ? format : rawTimeFormat; // only use provided timeFormat if there is no timeUnit.
return `${isUTCScale ? 'utc' : 'time'}Format(${field}, '${format}')`;
} else {
return formatExpression(timeUnit, field, isUTCScale);
}
}