@mathstack/viz 0.0.1-beta.4 → 0.0.1-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/mathstack-viz.mjs +104 -104
- package/fesm2022/mathstack-viz.mjs.map +1 -1
- package/package.json +1 -1
- package/types/mathstack-viz.d.ts +183 -183
package/package.json
CHANGED
package/types/mathstack-viz.d.ts
CHANGED
|
@@ -3108,6 +3108,79 @@ interface DateChartPositionDimensionOptions<Datum> extends DataDimensionOptions<
|
|
|
3108
3108
|
scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>;
|
|
3109
3109
|
}
|
|
3110
3110
|
|
|
3111
|
+
/**
|
|
3112
|
+
* A dimension that transforms Date values into a position on a chart.
|
|
3113
|
+
*
|
|
3114
|
+
* This dimension is used for the positional dimensions of a chart, such as x and y. The underlying scale will always be a [D3 time scale](https://d3js.org/d3-scale/time). The range of the scale will be a dimension from the chart.
|
|
3115
|
+
*
|
|
3116
|
+
* The generic is the type of the data that will be passed to the dimension.
|
|
3117
|
+
*
|
|
3118
|
+
* TESTABLE FUNCTIONALITY
|
|
3119
|
+
*
|
|
3120
|
+
* - It extracts values for the dimension from data.
|
|
3121
|
+
* - tested in: lines.cy.ts
|
|
3122
|
+
* - It sets the domain of the dimension.
|
|
3123
|
+
* - tested in: lines.cy.ts
|
|
3124
|
+
* - It creates and returns a scale from a range.
|
|
3125
|
+
* - tested in: lines.cy.ts
|
|
3126
|
+
* - It checks if a value is in valid.
|
|
3127
|
+
* - tested in: lines.cy.ts
|
|
3128
|
+
* - The domain will be unique values from the user-provided domain if the user provides a domain.
|
|
3129
|
+
* - tested in: date-chart-position.spec.ts
|
|
3130
|
+
* - The domain will be unique values from the data if no custom domain is given by the user.
|
|
3131
|
+
* - tested in: date-chart-position.spec.ts
|
|
3132
|
+
* - The domain can be set in reverse order.
|
|
3133
|
+
* - tested in: date-chart-position.spec.ts
|
|
3134
|
+
*/
|
|
3135
|
+
declare class DateChartPositionDimension<Datum> extends DataDimension<Datum, Date> implements DateChartPositionDimensionOptions<Datum> {
|
|
3136
|
+
private calculatedDomain;
|
|
3137
|
+
readonly domain: [Date, Date];
|
|
3138
|
+
readonly formatSpecifier: string;
|
|
3139
|
+
scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>;
|
|
3140
|
+
constructor(options: DateChartPositionDimensionOptions<Datum>);
|
|
3141
|
+
setPropertiesFromData(data: Datum[]): void;
|
|
3142
|
+
protected setDomain(): void;
|
|
3143
|
+
getScaleFromRange(range: [number, number]): ScaleTime<number, number>;
|
|
3144
|
+
isValidValue(x: unknown): boolean;
|
|
3145
|
+
}
|
|
3146
|
+
|
|
3147
|
+
declare class DateChartPositionDimensionBuilder<Datum> extends DataDimensionBuilder<Datum, Date> {
|
|
3148
|
+
private _domain;
|
|
3149
|
+
private _formatSpecifier;
|
|
3150
|
+
private _scaleFn;
|
|
3151
|
+
constructor();
|
|
3152
|
+
/**
|
|
3153
|
+
* OPTIONAL. Sets the domain of the scale.
|
|
3154
|
+
*
|
|
3155
|
+
* If not provided, the domain will be determined by the data.
|
|
3156
|
+
*/
|
|
3157
|
+
domain(domain: null): this;
|
|
3158
|
+
domain(domain: [Date, Date]): this;
|
|
3159
|
+
/**
|
|
3160
|
+
* OPTIONAL. Sets a format specifier that will be applied to values from this dimension for display purposes, for example, in a tooltip.
|
|
3161
|
+
*
|
|
3162
|
+
* This is a string that is passed to D3's timeFormat function.
|
|
3163
|
+
*
|
|
3164
|
+
* @default '%Y %m'
|
|
3165
|
+
*/
|
|
3166
|
+
formatSpecifier(formatSpecifier: null): this;
|
|
3167
|
+
formatSpecifier(formatSpecifier: string): this;
|
|
3168
|
+
/**
|
|
3169
|
+
* OPTIONAL. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
|
|
3170
|
+
*
|
|
3171
|
+
* @default d3.scaleUtc
|
|
3172
|
+
*/
|
|
3173
|
+
scaleFn(scaleFn: null): this;
|
|
3174
|
+
scaleFn(scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>): this;
|
|
3175
|
+
/**
|
|
3176
|
+
* @internal This function is for internal use only and should never be called by the user.
|
|
3177
|
+
*
|
|
3178
|
+
* @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
|
|
3179
|
+
*/
|
|
3180
|
+
_build(dimensionName: string): DateChartPositionDimension<Datum>;
|
|
3181
|
+
private validateBuilder;
|
|
3182
|
+
}
|
|
3183
|
+
|
|
3111
3184
|
interface PercentOverDomainPaddingOptions {
|
|
3112
3185
|
percentOver: number;
|
|
3113
3186
|
}
|
|
@@ -3124,11 +3197,32 @@ interface RoundUpToSigFigDomainPaddingOptions {
|
|
|
3124
3197
|
sigFigures: (d: number) => number;
|
|
3125
3198
|
}
|
|
3126
3199
|
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
|
|
3130
|
-
|
|
3131
|
-
|
|
3200
|
+
/**
|
|
3201
|
+
* An abstract dimension that for dimensions whose input values are numbers. It assumes that the domain is two numbers.
|
|
3202
|
+
*
|
|
3203
|
+
* The generic is the type of the data that will be passed to the dimension.
|
|
3204
|
+
*
|
|
3205
|
+
* TESTABLE FUNCTIONALITY
|
|
3206
|
+
*
|
|
3207
|
+
* - The domain will be the user=provided domain if the user provides a domain.
|
|
3208
|
+
* - tested in: number-dimension.spec.ts
|
|
3209
|
+
* - The domain will be [min, max] of values if the user does not provide a domain.
|
|
3210
|
+
* - tested in: number-dimension.spec.ts
|
|
3211
|
+
* - The domain will include 0 if includeZeroInDomain is true.
|
|
3212
|
+
* - tested in: number-dimension.spec.ts
|
|
3213
|
+
* - domainIncludesZero will be true if 0 is in the domain.
|
|
3214
|
+
* - tested in: number-dimension.spec.ts
|
|
3215
|
+
*/
|
|
3216
|
+
declare abstract class NumberDimension<Datum> extends DataDimension<Datum, number> {
|
|
3217
|
+
protected calculatedDomain: [number, number];
|
|
3218
|
+
readonly domain: [number, number];
|
|
3219
|
+
domainIncludesZero: boolean;
|
|
3220
|
+
readonly formatSpecifier: string;
|
|
3221
|
+
readonly includeZeroInDomain: boolean;
|
|
3222
|
+
setDomain(valuesOverride?: [number, number]): void;
|
|
3223
|
+
protected getCalculatedDomain(domain: [number, number]): [number, number];
|
|
3224
|
+
protected setDomainIncludesZero(): void;
|
|
3225
|
+
isValidValue(x: unknown): boolean;
|
|
3132
3226
|
}
|
|
3133
3227
|
|
|
3134
3228
|
declare enum DomainPaddingType {
|
|
@@ -3182,43 +3276,15 @@ declare class RoundUpToSigFigDomainPadding extends DomainPadding implements Roun
|
|
|
3182
3276
|
|
|
3183
3277
|
type ConcreteDomainPadding = RoundUpToSigFigDomainPadding | RoundUpToIntervalDomainPadding | PercentOverDomainPadding | PixelDomainPadding;
|
|
3184
3278
|
|
|
3185
|
-
interface
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
align: number;
|
|
3191
|
-
domain: Domain[];
|
|
3192
|
-
paddingInner: number;
|
|
3193
|
-
paddingOuter: number;
|
|
3279
|
+
interface NumberDimensionOptions<Datum, Range> extends DataDimensionOptions<Datum, number> {
|
|
3280
|
+
domain: [number, number];
|
|
3281
|
+
formatSpecifier: string;
|
|
3282
|
+
includeZeroInDomain: boolean;
|
|
3283
|
+
scaleFn: (domain?: Iterable<number>, range?: Iterable<Range>) => ScaleContinuousNumeric<Range, Range>;
|
|
3194
3284
|
}
|
|
3195
3285
|
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
*
|
|
3199
|
-
* The generic is the type of the data that will be passed to the dimension.
|
|
3200
|
-
*
|
|
3201
|
-
* TESTABLE FUNCTIONALITY
|
|
3202
|
-
*
|
|
3203
|
-
* - The domain will be the user=provided domain if the user provides a domain.
|
|
3204
|
-
* - tested in: number-dimension.spec.ts
|
|
3205
|
-
* - The domain will be [min, max] of values if the user does not provide a domain.
|
|
3206
|
-
* - tested in: number-dimension.spec.ts
|
|
3207
|
-
* - The domain will include 0 if includeZeroInDomain is true.
|
|
3208
|
-
* - tested in: number-dimension.spec.ts
|
|
3209
|
-
* - domainIncludesZero will be true if 0 is in the domain.
|
|
3210
|
-
* - tested in: number-dimension.spec.ts
|
|
3211
|
-
*/
|
|
3212
|
-
declare abstract class NumberDimension<Datum> extends DataDimension<Datum, number> {
|
|
3213
|
-
protected calculatedDomain: [number, number];
|
|
3214
|
-
readonly domain: [number, number];
|
|
3215
|
-
domainIncludesZero: boolean;
|
|
3216
|
-
readonly formatSpecifier: string;
|
|
3217
|
-
readonly includeZeroInDomain: boolean;
|
|
3218
|
-
setDomain(valuesOverride?: [number, number]): void;
|
|
3219
|
-
protected getCalculatedDomain(domain: [number, number]): [number, number];
|
|
3220
|
-
protected setDomainIncludesZero(): void;
|
|
3221
|
-
isValidValue(x: unknown): boolean;
|
|
3286
|
+
interface NumberChartPositionDimensionOptions<Datum> extends NumberDimensionOptions<Datum, number> {
|
|
3287
|
+
domainPadding?: ConcreteDomainPadding;
|
|
3222
3288
|
}
|
|
3223
3289
|
|
|
3224
3290
|
/**
|
|
@@ -3248,6 +3314,82 @@ declare class NumberChartPositionDimension<Datum> extends NumberDimension<Datum>
|
|
|
3248
3314
|
private getPaddedQuantitativeDomain;
|
|
3249
3315
|
}
|
|
3250
3316
|
|
|
3317
|
+
declare class NumberChartPositionDimensionBuilder<Datum> extends DataDimensionBuilder<Datum, number> {
|
|
3318
|
+
private _domain;
|
|
3319
|
+
private _formatSpecifier;
|
|
3320
|
+
private _includeZeroInDomain;
|
|
3321
|
+
private _domainPadding;
|
|
3322
|
+
private _scaleFn;
|
|
3323
|
+
constructor();
|
|
3324
|
+
/**
|
|
3325
|
+
* OPTIONAL. Sets the domain of the scale.
|
|
3326
|
+
*
|
|
3327
|
+
* Should be in the form of [min, max].
|
|
3328
|
+
*
|
|
3329
|
+
* If not provided, the domain will be determined by the data.
|
|
3330
|
+
*/
|
|
3331
|
+
domain(domain: [number, number]): this;
|
|
3332
|
+
domain(domain: null): this;
|
|
3333
|
+
/**
|
|
3334
|
+
* OPTIONAL. Sets a format specifier that will be applied to the value of this dimension for display purposes.
|
|
3335
|
+
*/
|
|
3336
|
+
formatSpecifier(formatSpecifier: string): this;
|
|
3337
|
+
formatSpecifier(formatSpecifier: null): this;
|
|
3338
|
+
/**
|
|
3339
|
+
* OPTIONAL. Sets a boolean that indicates whether the domain of the dimension's scale should include zero.
|
|
3340
|
+
*
|
|
3341
|
+
* @default true
|
|
3342
|
+
*/
|
|
3343
|
+
includeZeroInDomain(includeZeroInDomain: boolean): this;
|
|
3344
|
+
/**
|
|
3345
|
+
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value of the quantitative domain.
|
|
3346
|
+
*
|
|
3347
|
+
* For example, if the domain is [0, 100] and the percent is 0.1, the new domain will be [0, 110].
|
|
3348
|
+
*
|
|
3349
|
+
* @default 0.1
|
|
3350
|
+
*/
|
|
3351
|
+
domainPaddingPercentOver(percentOver?: number): this;
|
|
3352
|
+
/**
|
|
3353
|
+
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value of the quantitative domain so that it exceeds its original value by the specified number of pixels.
|
|
3354
|
+
*
|
|
3355
|
+
* @default 40
|
|
3356
|
+
*/
|
|
3357
|
+
domainPaddingPixels(numPixels?: number): this;
|
|
3358
|
+
/**
|
|
3359
|
+
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value to a number that is rounded up to the specified interval.
|
|
3360
|
+
*
|
|
3361
|
+
* @default () => 1
|
|
3362
|
+
*/
|
|
3363
|
+
domainPaddingRoundUpToInterval(interval?: (d: number) => number): this;
|
|
3364
|
+
/**
|
|
3365
|
+
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value to a number that is rounded up to the specified number of significant figures.
|
|
3366
|
+
*
|
|
3367
|
+
* @default () => 1
|
|
3368
|
+
*/
|
|
3369
|
+
domainPaddingRoundUpToSigFig(sigFigures?: (d: number) => number): this;
|
|
3370
|
+
/**
|
|
3371
|
+
* OPTIONAL. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
|
|
3372
|
+
*
|
|
3373
|
+
* @default d3.scaleLinear
|
|
3374
|
+
*/
|
|
3375
|
+
scaleFn(scaleFn: null): this;
|
|
3376
|
+
scaleFn(scaleFn: (domain?: Iterable<number>, range?: Iterable<number>) => ScaleContinuousNumeric<number, number>): this;
|
|
3377
|
+
/**
|
|
3378
|
+
* @internal This method is not intended to be used by consumers of this library.
|
|
3379
|
+
*
|
|
3380
|
+
* @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
|
|
3381
|
+
*/
|
|
3382
|
+
_build(dimensionName: string): NumberChartPositionDimension<Datum>;
|
|
3383
|
+
private validateBuilder;
|
|
3384
|
+
}
|
|
3385
|
+
|
|
3386
|
+
interface OrdinalChartPositionDimensionOptions<Datum, Domain extends DataValue> extends DataDimensionOptions<Datum, Domain> {
|
|
3387
|
+
align: number;
|
|
3388
|
+
domain: Domain[];
|
|
3389
|
+
paddingInner: number;
|
|
3390
|
+
paddingOuter: number;
|
|
3391
|
+
}
|
|
3392
|
+
|
|
3251
3393
|
/**
|
|
3252
3394
|
* A dimension that transforms string / number / Date values into a position on a chart.
|
|
3253
3395
|
*
|
|
@@ -3491,75 +3633,6 @@ declare class VicBarsModule {
|
|
|
3491
3633
|
static ɵinj: i0.ɵɵInjectorDeclaration<VicBarsModule>;
|
|
3492
3634
|
}
|
|
3493
3635
|
|
|
3494
|
-
declare class NumberChartPositionDimensionBuilder<Datum> extends DataDimensionBuilder<Datum, number> {
|
|
3495
|
-
private _domain;
|
|
3496
|
-
private _formatSpecifier;
|
|
3497
|
-
private _includeZeroInDomain;
|
|
3498
|
-
private _domainPadding;
|
|
3499
|
-
private _scaleFn;
|
|
3500
|
-
constructor();
|
|
3501
|
-
/**
|
|
3502
|
-
* OPTIONAL. Sets the domain of the scale.
|
|
3503
|
-
*
|
|
3504
|
-
* Should be in the form of [min, max].
|
|
3505
|
-
*
|
|
3506
|
-
* If not provided, the domain will be determined by the data.
|
|
3507
|
-
*/
|
|
3508
|
-
domain(domain: [number, number]): this;
|
|
3509
|
-
domain(domain: null): this;
|
|
3510
|
-
/**
|
|
3511
|
-
* OPTIONAL. Sets a format specifier that will be applied to the value of this dimension for display purposes.
|
|
3512
|
-
*/
|
|
3513
|
-
formatSpecifier(formatSpecifier: string): this;
|
|
3514
|
-
formatSpecifier(formatSpecifier: null): this;
|
|
3515
|
-
/**
|
|
3516
|
-
* OPTIONAL. Sets a boolean that indicates whether the domain of the dimension's scale should include zero.
|
|
3517
|
-
*
|
|
3518
|
-
* @default true
|
|
3519
|
-
*/
|
|
3520
|
-
includeZeroInDomain(includeZeroInDomain: boolean): this;
|
|
3521
|
-
/**
|
|
3522
|
-
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value of the quantitative domain.
|
|
3523
|
-
*
|
|
3524
|
-
* For example, if the domain is [0, 100] and the percent is 0.1, the new domain will be [0, 110].
|
|
3525
|
-
*
|
|
3526
|
-
* @default 0.1
|
|
3527
|
-
*/
|
|
3528
|
-
domainPaddingPercentOver(percentOver?: number): this;
|
|
3529
|
-
/**
|
|
3530
|
-
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value of the quantitative domain so that it exceeds its original value by the specified number of pixels.
|
|
3531
|
-
*
|
|
3532
|
-
* @default 40
|
|
3533
|
-
*/
|
|
3534
|
-
domainPaddingPixels(numPixels?: number): this;
|
|
3535
|
-
/**
|
|
3536
|
-
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value to a number that is rounded up to the specified interval.
|
|
3537
|
-
*
|
|
3538
|
-
* @default () => 1
|
|
3539
|
-
*/
|
|
3540
|
-
domainPaddingRoundUpToInterval(interval?: (d: number) => number): this;
|
|
3541
|
-
/**
|
|
3542
|
-
* OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value to a number that is rounded up to the specified number of significant figures.
|
|
3543
|
-
*
|
|
3544
|
-
* @default () => 1
|
|
3545
|
-
*/
|
|
3546
|
-
domainPaddingRoundUpToSigFig(sigFigures?: (d: number) => number): this;
|
|
3547
|
-
/**
|
|
3548
|
-
* OPTIONAL. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
|
|
3549
|
-
*
|
|
3550
|
-
* @default d3.scaleLinear
|
|
3551
|
-
*/
|
|
3552
|
-
scaleFn(scaleFn: null): this;
|
|
3553
|
-
scaleFn(scaleFn: (domain?: Iterable<number>, range?: Iterable<number>) => ScaleContinuousNumeric<number, number>): this;
|
|
3554
|
-
/**
|
|
3555
|
-
* @internal This method is not intended to be used by consumers of this library.
|
|
3556
|
-
*
|
|
3557
|
-
* @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
|
|
3558
|
-
*/
|
|
3559
|
-
_build(dimensionName: string): NumberChartPositionDimension<Datum>;
|
|
3560
|
-
private validateBuilder;
|
|
3561
|
-
}
|
|
3562
|
-
|
|
3563
3636
|
declare class OrdinalChartPositionDimensionBuilder<Datum, Domain extends DataValue> extends DataDimensionBuilder<Datum, Domain> {
|
|
3564
3637
|
private _align;
|
|
3565
3638
|
private _domain;
|
|
@@ -3883,79 +3956,6 @@ declare class VicDataExport {
|
|
|
3883
3956
|
static ɵprov: i0.ɵɵInjectableDeclaration<VicDataExport>;
|
|
3884
3957
|
}
|
|
3885
3958
|
|
|
3886
|
-
/**
|
|
3887
|
-
* A dimension that transforms Date values into a position on a chart.
|
|
3888
|
-
*
|
|
3889
|
-
* This dimension is used for the positional dimensions of a chart, such as x and y. The underlying scale will always be a [D3 time scale](https://d3js.org/d3-scale/time). The range of the scale will be a dimension from the chart.
|
|
3890
|
-
*
|
|
3891
|
-
* The generic is the type of the data that will be passed to the dimension.
|
|
3892
|
-
*
|
|
3893
|
-
* TESTABLE FUNCTIONALITY
|
|
3894
|
-
*
|
|
3895
|
-
* - It extracts values for the dimension from data.
|
|
3896
|
-
* - tested in: lines.cy.ts
|
|
3897
|
-
* - It sets the domain of the dimension.
|
|
3898
|
-
* - tested in: lines.cy.ts
|
|
3899
|
-
* - It creates and returns a scale from a range.
|
|
3900
|
-
* - tested in: lines.cy.ts
|
|
3901
|
-
* - It checks if a value is in valid.
|
|
3902
|
-
* - tested in: lines.cy.ts
|
|
3903
|
-
* - The domain will be unique values from the user-provided domain if the user provides a domain.
|
|
3904
|
-
* - tested in: date-chart-position.spec.ts
|
|
3905
|
-
* - The domain will be unique values from the data if no custom domain is given by the user.
|
|
3906
|
-
* - tested in: date-chart-position.spec.ts
|
|
3907
|
-
* - The domain can be set in reverse order.
|
|
3908
|
-
* - tested in: date-chart-position.spec.ts
|
|
3909
|
-
*/
|
|
3910
|
-
declare class DateChartPositionDimension<Datum> extends DataDimension<Datum, Date> implements DateChartPositionDimensionOptions<Datum> {
|
|
3911
|
-
private calculatedDomain;
|
|
3912
|
-
readonly domain: [Date, Date];
|
|
3913
|
-
readonly formatSpecifier: string;
|
|
3914
|
-
scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>;
|
|
3915
|
-
constructor(options: DateChartPositionDimensionOptions<Datum>);
|
|
3916
|
-
setPropertiesFromData(data: Datum[]): void;
|
|
3917
|
-
protected setDomain(): void;
|
|
3918
|
-
getScaleFromRange(range: [number, number]): ScaleTime<number, number>;
|
|
3919
|
-
isValidValue(x: unknown): boolean;
|
|
3920
|
-
}
|
|
3921
|
-
|
|
3922
|
-
declare class DateChartPositionDimensionBuilder<Datum> extends DataDimensionBuilder<Datum, Date> {
|
|
3923
|
-
private _domain;
|
|
3924
|
-
private _formatSpecifier;
|
|
3925
|
-
private _scaleFn;
|
|
3926
|
-
constructor();
|
|
3927
|
-
/**
|
|
3928
|
-
* OPTIONAL. Sets the domain of the scale.
|
|
3929
|
-
*
|
|
3930
|
-
* If not provided, the domain will be determined by the data.
|
|
3931
|
-
*/
|
|
3932
|
-
domain(domain: null): this;
|
|
3933
|
-
domain(domain: [Date, Date]): this;
|
|
3934
|
-
/**
|
|
3935
|
-
* OPTIONAL. Sets a format specifier that will be applied to values from this dimension for display purposes, for example, in a tooltip.
|
|
3936
|
-
*
|
|
3937
|
-
* This is a string that is passed to D3's timeFormat function.
|
|
3938
|
-
*
|
|
3939
|
-
* @default '%Y %m'
|
|
3940
|
-
*/
|
|
3941
|
-
formatSpecifier(formatSpecifier: null): this;
|
|
3942
|
-
formatSpecifier(formatSpecifier: string): this;
|
|
3943
|
-
/**
|
|
3944
|
-
* OPTIONAL. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
|
|
3945
|
-
*
|
|
3946
|
-
* @default d3.scaleUtc
|
|
3947
|
-
*/
|
|
3948
|
-
scaleFn(scaleFn: null): this;
|
|
3949
|
-
scaleFn(scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>): this;
|
|
3950
|
-
/**
|
|
3951
|
-
* @internal This function is for internal use only and should never be called by the user.
|
|
3952
|
-
*
|
|
3953
|
-
* @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
|
|
3954
|
-
*/
|
|
3955
|
-
_build(dimensionName: string): DateChartPositionDimension<Datum>;
|
|
3956
|
-
private validateBuilder;
|
|
3957
|
-
}
|
|
3958
|
-
|
|
3959
3959
|
interface NumberVisualValueDimensionOptions<Datum, Range extends VisualValue> extends NumberDimensionOptions<Datum, Range> {
|
|
3960
3960
|
range: [Range, Range];
|
|
3961
3961
|
scale: (value: number) => Range;
|
|
@@ -5494,5 +5494,5 @@ declare class VicXyBackgroundModule {
|
|
|
5494
5494
|
static ɵinj: i0.ɵɵInjectorDeclaration<VicXyBackgroundModule>;
|
|
5495
5495
|
}
|
|
5496
5496
|
|
|
5497
|
-
export { AuxMarks, AuxMarksConfig, BARS, BarsClickEmitTooltipDataPauseOtherActions, BarsComponent, BarsConfig, BarsEventsDirective, BarsHoverEmitTooltipData, BarsHoverMoveEmitTooltipData, BarsHoverShowLabels, BarsLabels, BinStrategy, CHART, CHART_SIZE, CategoricalBinsAttributeDataDimension, Chart, ChartComponent, ChartConfig, ColorUtilities, CustomBreaksBinsAttributeDataDimension, DEFAULT_TOOLTIP_Y_OFFSET, DOTS, DataMarksConfig, DotsComponent, DotsConfig, DotsEventsDirective, DotsHoverDefaultStyles, DotsHoverMoveDefaultStyles, DotsHoverMoveEmitTooltipData, EqualFrequenciesAttributeDataDimension, EqualValueRangesAttributeDataDimension, EventType, EventsDirective, GEOGRAPHIES, GeographiesAttributeDataLayer, GeographiesAttributeDataLayerBuilder, GeographiesClickEmitTooltipDataPauseOtherActions, GeographiesComponent, GeographiesConfig, GeographiesEventsDirective, GeographiesGeojsonPropertiesLayer, GeographiesGeojsonPropertiesLayerBuilder, GeographiesHoverEmitTooltipData, GeographiesHoverMoveEmitTooltipData, GeographiesLabels, GeographiesLabelsBuilder, GroupedBarsComponent, GroupedBarsConfig, GroupedBarsEventsDirective, HorizontalBarsDimensionsBuilder, HtmlTooltipCdkManagedPosition, HtmlTooltipConfig, HtmlTooltipDirective, HtmlTooltipSize, HtmlTooltipSizeBuilder, LINES, LinesClickEmitTooltipDataPauseHoverMoveActions, LinesComponent, LinesConfig, LinesEventsDirective, LinesHoverMoveDefaultLinesStyles, LinesHoverMoveDefaultMarkersStyles, LinesHoverMoveDefaultStyles, LinesHoverMoveEmitTooltipData, LinesMarkerClickEmitTooltipData, LinesTooltipPositioner, MapChartComponent, MapLegendComponent, MapPrimaryMarks, MarksConfig, NoBinsAttributeDataDimension, Orientation, PointMarkers, PrimaryMarks, PrimaryMarksBuilder, PrimaryMarksConfig, QuantitativeRulesComponent, QuantitativeRulesConfig, QuantitativeRulesLabels, STACKED_AREA, STACKED_BARS, Side, StackedAreaComponent, StackedAreaConfig, StackedAreaEventsDirective, StackedAreaHoverMoveEmitTooltipData, StackedBarsClickEmitTooltipDataPauseOtherActions, StackedBarsComponent, StackedBarsConfig, StackedBarsEventsDirective, StackedBarsHoverEmitTooltipData, StackedBarsHoverMoveEmitTooltipData, Stroke, SvgTextWrap, TooltipPosition, TooltipPositionBuilder, TooltipPositioner, TooltipTriangleComponent, VIC_PRIMARY_MARKS, ValueExtent, VerticalBarsDimensionsBuilder, VicAuxMarksBuilder, VicBarsConfigBuilder, VicBarsModule, VicChartConfigBuilder, VicChartModule, VicColumnConfig, VicDataExport, VicDataExportConfig, VicDotsConfigBuilder, VicDotsModule, VicGeographiesConfigBuilder, VicGeographiesModule, VicGroupedBarsConfigBuilder, VicGroupedBarsModule, VicHtmlTooltipConfigBuilder, VicHtmlTooltipModule, VicImage, VicImageDownloadService, VicJpegImageConfig, VicLegendType, VicLinesConfigBuilder, VicLinesModule, VicMapAuxMarks, VicMapLegendModule, VicPngImageConfig, VicQuantitativeRulesConfigBuilder, VicQuantitativeRulesModule, VicStackedAreaConfigBuilder, VicStackedAreaModule, VicStackedBarsConfigBuilder, VicStackedBarsModule, VicSvgImageConfig, VicXOrdinalAxisConfig, VicXOrdinalAxisConfigBuilder, VicXQuantitativeAxisConfig, VicXQuantitativeAxisConfigBuilder, VicXyAxisModule, VicXyBackgroundModule, VicXyPrimaryMarks, VicYOrdinalAxisConfig, VicYOrdinalAxisConfigBuilder, VicYQuantitativeAxisConfig, VicYQuantitativeAxisConfigBuilder, XOrdinalAxisComponent, XQuantitativeAxisComponent, XyAuxMarks, XyBackgroundComponent, XyChartComponent, XyContentScale, XyMarksConfig, XyPrimaryMarksConfig, YOrdinalAxisComponent, YQuantitativeAxisComponent, valueFormat };
|
|
5497
|
+
export { AuxMarks, AuxMarksConfig, BARS, BarsClickEmitTooltipDataPauseOtherActions, BarsComponent, BarsConfig, BarsEventsDirective, BarsHoverEmitTooltipData, BarsHoverMoveEmitTooltipData, BarsHoverShowLabels, BarsLabels, BinStrategy, CHART, CHART_SIZE, CategoricalBinsAttributeDataDimension, Chart, ChartComponent, ChartConfig, ColorUtilities, CustomBreaksBinsAttributeDataDimension, DEFAULT_TOOLTIP_Y_OFFSET, DOTS, DataMarksConfig, DateChartPositionDimensionBuilder, DotsComponent, DotsConfig, DotsEventsDirective, DotsHoverDefaultStyles, DotsHoverMoveDefaultStyles, DotsHoverMoveEmitTooltipData, EqualFrequenciesAttributeDataDimension, EqualValueRangesAttributeDataDimension, EventType, EventsDirective, GEOGRAPHIES, GeographiesAttributeDataLayer, GeographiesAttributeDataLayerBuilder, GeographiesClickEmitTooltipDataPauseOtherActions, GeographiesComponent, GeographiesConfig, GeographiesEventsDirective, GeographiesGeojsonPropertiesLayer, GeographiesGeojsonPropertiesLayerBuilder, GeographiesHoverEmitTooltipData, GeographiesHoverMoveEmitTooltipData, GeographiesLabels, GeographiesLabelsBuilder, GroupedBarsComponent, GroupedBarsConfig, GroupedBarsEventsDirective, HorizontalBarsDimensionsBuilder, HtmlTooltipCdkManagedPosition, HtmlTooltipConfig, HtmlTooltipDirective, HtmlTooltipSize, HtmlTooltipSizeBuilder, LINES, LinesClickEmitTooltipDataPauseHoverMoveActions, LinesComponent, LinesConfig, LinesEventsDirective, LinesHoverMoveDefaultLinesStyles, LinesHoverMoveDefaultMarkersStyles, LinesHoverMoveDefaultStyles, LinesHoverMoveEmitTooltipData, LinesMarkerClickEmitTooltipData, LinesStrokeBuilder, LinesTooltipPositioner, MapChartComponent, MapLegendComponent, MapPrimaryMarks, MarksConfig, NoBinsAttributeDataDimension, NumberChartPositionDimensionBuilder, Orientation, PointMarkers, PrimaryMarks, PrimaryMarksBuilder, PrimaryMarksConfig, QuantitativeRulesComponent, QuantitativeRulesConfig, QuantitativeRulesLabels, STACKED_AREA, STACKED_BARS, Side, StackedAreaComponent, StackedAreaConfig, StackedAreaEventsDirective, StackedAreaHoverMoveEmitTooltipData, StackedBarsClickEmitTooltipDataPauseOtherActions, StackedBarsComponent, StackedBarsConfig, StackedBarsEventsDirective, StackedBarsHoverEmitTooltipData, StackedBarsHoverMoveEmitTooltipData, Stroke, SvgTextWrap, TooltipPosition, TooltipPositionBuilder, TooltipPositioner, TooltipTriangleComponent, VIC_PRIMARY_MARKS, ValueExtent, VerticalBarsDimensionsBuilder, VicAuxMarksBuilder, VicBarsConfigBuilder, VicBarsModule, VicChartConfigBuilder, VicChartModule, VicColumnConfig, VicDataExport, VicDataExportConfig, VicDotsConfigBuilder, VicDotsModule, VicGeographiesConfigBuilder, VicGeographiesModule, VicGroupedBarsConfigBuilder, VicGroupedBarsModule, VicHtmlTooltipConfigBuilder, VicHtmlTooltipModule, VicImage, VicImageDownloadService, VicJpegImageConfig, VicLegendType, VicLinesConfigBuilder, VicLinesModule, VicMapAuxMarks, VicMapLegendModule, VicPngImageConfig, VicQuantitativeRulesConfigBuilder, VicQuantitativeRulesModule, VicStackedAreaConfigBuilder, VicStackedAreaModule, VicStackedBarsConfigBuilder, VicStackedBarsModule, VicSvgImageConfig, VicXOrdinalAxisConfig, VicXOrdinalAxisConfigBuilder, VicXQuantitativeAxisConfig, VicXQuantitativeAxisConfigBuilder, VicXyAxisModule, VicXyBackgroundModule, VicXyPrimaryMarks, VicYOrdinalAxisConfig, VicYOrdinalAxisConfigBuilder, VicYQuantitativeAxisConfig, VicYQuantitativeAxisConfigBuilder, XOrdinalAxisComponent, XQuantitativeAxisComponent, XyAuxMarks, XyBackgroundComponent, XyChartComponent, XyContentScale, XyMarksConfig, XyPrimaryMarksConfig, YOrdinalAxisComponent, YQuantitativeAxisComponent, valueFormat };
|
|
5498
5498
|
export type { ActionHost, BarDatum, BarGroupSelection, BarLabelSelection, BarSelection, BarsHost, BarsInteractionOutput, BarsLabelsOptions, BarsOptions, BarsTooltipDatum, CategoricalBinsOptions, ChartResizing, ContinuousValue, CustomBreaksBinsAttributeDataDimensionOptions, DataMarksOptions, DataValue, DateChartPositionDimensionOptions, Dimensions, DotDatum, DotGroupSelection, DotLabelSelection, DotSelection, DotsHost, DotsInteractionOutput, DotsOptions, DotsTooltipDatum, ElementSpacing, EqualFrequenciesAttributeDataDimensionOptions, EqualValueRangesAttributeDataDimensionOptions, EventAction, EventStrategy, FillDefinition, GenericScale, GeographiesAttributeDataLayerOptions, GeographiesFeature, GeographiesGeojsonPropertiesLayerOptions, GeographiesHost, GeographiesInteractionOutput, GeographiesLabelsColorOptions, GeographiesLabelsFontWeightOptions, GeographiesLabelsOptions, GeographiesOptions, GeographiesSvgElement, BarsHost as GroupedBarsHost, BarsInteractionOutput as GroupedBarsInteractionOutput, GroupedBarsOptions, HoverMoveAction, HtmlTooltipOptions, HtmlTooltipSizeOptions, ImageDownloadOptions, InputEventAction, InteractionOutput, LayersGroup, LinesGroupSelection, LinesGroupSelectionDatum, LinesHost, LinesInteractionOutput, LinesMarkerDatum, LinesOptions, LinesTooltipDatum, ListenElement, MarkerSelection, MarksHost, MarksOptions, NoBinsAttributeDataDimensionOptions, NumberChartPositionDimensionOptions, OrdinalChartPositionDimensionOptions, OrdinalVisualValueDimensionOptions, PercentOverDomainPaddingOptions, PixelDomainPaddingOptions, PointMarkersOptions, Position, QuantitativeRulesLabelsOptions, Ranges, ReactiveConfig, RoundUpToIntervalDomainPaddingOptions, RoundUpToSigFigDomainPaddingOptions, ScalingStrategy, StackDatum, StackedAreaDatum, StackedAreaHost, StackedAreaOptions, StackedAreaSelection, StackedAreaTooltipDatum, StackedBarGroupSelection, StackedBarsHost, BarsInteractionOutput as StackedBarsInteractionOutput, StackedBarsOptions, StrokeOptions, SvgTextWrapOptions, TooltipPositionConfig, UnlistenFunction, VicAttributeDataDimensionConfig, VicImageType, VicNumberValuesBin, VicValueFormats, VisualValue, XyChartScales, XyMarks };
|