vega-typings - npm Package Compare versions

Comparing version 0.12.3 to 0.12.4

package.json

 {
   "name": "vega-typings",
-  "version": "0.12.3",
+  "version": "0.12.4",
   "description": "Typings for Vega.",
@@ -5,0 +5,0 @@ "types": "types",

types/spec/config.d.ts

@@ -541,3 +541,3 @@ import {
 
-export interface RangeConfig {
+export type RangeConfig = {
   /**
@@ -567,2 +567,4 @@ * Default [color scheme](https://vega.github.io/vega/docs/schemes/) for categorical data.
   symbol?: SymbolShape[];
-}
+} & {
+  [name: string]: RangeScheme | number[] | boolean[] | string[] | SymbolShape[];
+};

types/spec/projection.d.ts

@@ -1,2 +0,2 @@
-import { Vector2, SignalRef, Signal, Vector3 } from '.';
+import { SignalRef, Vector2, Vector3 } from '.';
 
@@ -25,41 +25,59 @@ export type GeoJsonFeature = any; // TODO
   /*
-   * The type of the projection. The default is `"mercator"`.
+   * The cartographic projection to use. This value is case-insensitive, for example `"albers"` and `"Albers"` indicate the same projection type.
+   *
+   * __Default value:__ `mercator`
    */
   type?: ProjectionType | SignalRef;
-  /*
-   * The clip angle of the projection.
+
+  /**
+   * The projection's clipping circle radius to the specified angle in degrees. If `null`, switches to [antimeridian](http://bl.ocks.org/mbostock/3788999) cutting rather than small-circle clipping.
    */
   clipAngle?: number | SignalRef;
-  /*
-   * The projection’s viewport clip extent to the specified bounds in pixels
+
+  /**
+   * The projection's viewport clip extent to the specified bounds in pixels. The extent bounds are specified as an array `[[x0, y0], [x1, y1]]`, where `x0` is the left-side of the viewport, `y0` is the top, `x1` is the right and `y1` is the bottom. If `null`, no viewport clipping is performed.
    */
   clipExtent?: Vector2<Vector2<number | SignalRef>> | SignalRef;
+
   /**
-   * The projection’s scale factor to the specified value.
+   * The projection’s scale factor. The default scale is projection-specific. The scale factor corresponds linearly to the distance between projected points; however, scale factor values are not equivalent across projections.
    */
   scale?: number | SignalRef;
+
   /*
-   * The translation of the projection.
+   * The projection's translation offset as a two-element array `[tx, ty]`, defaults to `[480, 250]`. The translation offset determines the pixel coordinates of the projection's center. The default translation offset places (0°,0°) at the center of a 960×500 area.
    */
   translate?: Vector2<number | SignalRef> | SignalRef;
-  /*
-   * The center of the projection.
+
+  /**
+   * The projection's center, a two-element array of longitude and latitude in degrees.
+   *
+   * __Default value:__ `[0, 0]`
    */
   center?: Vector2<number | SignalRef> | SignalRef;
+
   /**
-   * The rotation of the projection.
+   * The projection's three-axis rotation to the specified angles, which must be a two- or three-element array of numbers [`lambda`, `phi`, `gamma`] specifying the rotation angles in degrees about each spherical axis. (These correspond to yaw, pitch and roll.)
+   *
+   * __Default value:__ `[0, 0, 0]`
    */
   rotate?: Vector2<number | SignalRef> | Vector3<number | SignalRef> | SignalRef;
+
   /**
-   * The desired parallels of the projection.
+   * For conic projections, the [two standard parallels](https://en.wikipedia.org/wiki/Map_projection#Conic) that define the map layout. The default depends on the specific conic projection used.
    */
   parallels?: (number | SignalRef)[] | SignalRef;
-  /*
-   * The desired precision of the projection.
+
+  /**
+   * The default radius (in pixels) to use when drawing GeoJSON `Point` and `MultiPoint` geometries. This parameter sets a constant default value. To modify the point radius in response to data, see the corresponding parameter of the GeoPath and GeoShape transforms.
+   *
+   * __Default value:__ `4.5`
    */
-  precision?: number | SignalRef;
+  pointRadius?: number | SignalRef;
+
   /**
-   * The default radius (in pixels) to use when drawing GeoJSON `Point` and `MultiPoint` geometries.
+   * The threshold for the projection's [adaptive resampling](http://bl.ocks.org/mbostock/3795544) to the specified value in pixels. This value corresponds to the [Douglas–Peucker distance](http://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm). If precision is not specified, returns the projection's current resampling precision which defaults to `√0.5 ≅ 0.70710…`.
    */
-  pointRadius?: number | SignalRef;
+  precision?: number | SignalRef;
+
   /*
@@ -89,3 +107,11 @@ * GeoJSON data to which the projection should attempt to automatically fit the translate and scale parameters..
   tilt?: number | SignalRef;
+
+  /*
+   * Sets whether or not the x-dimension is reflected (negated) in the output.
+   */
   reflectX?: boolean | SignalRef;
+
+  /*
+   * Sets whether or not the y-dimension is reflected (negated) in the output.
+   */
   reflectY?: boolean | SignalRef;
@@ -92,0 +118,0 @@ }

types/spec/scale.d.ts

@@ -13,2 +13,3 @@ import { SignalRef } from '.';
   | 'heatmap';
+
 export type RangeRawArray = (number | SignalRef)[];
@@ -59,12 +60,27 @@ export type RangeRaw = (null | boolean | string | number | SignalRef | RangeRawArray)[];
 
-export type ScaleBins =
-  | (number | SignalRef)[]
-  | SignalRef
-  | {
-      step: number | SignalRef;
-      start?: number | SignalRef;
-      stop?: number | SignalRef;
-    };
+export interface ScaleBinParams {
+  /**
+   * The step size defining the bin interval width.
+   */
+  step: number | SignalRef;
 
-export type ScaleInterpolate =
+  /**
+   * The starting (lowest-valued) bin boundary.
+   *
+   * __Default value:__ The lowest value of the scale domain will be used.
+   */
+  start?: number | SignalRef;
+
+  /**
+   * The stopping (highest-valued) bin boundary.
+   *
+   * __Default value:__ The highest value of the scale domain will be used.
+   *
+   */
+  stop?: number | SignalRef;
+}
+
+export type ScaleBins = (number | SignalRef)[] | SignalRef | ScaleBinParams;
+
+export type ScaleInterpolateEnum =
   | 'rgb'
@@ -77,23 +93,28 @@ | 'lab'
   | 'cubehelix'
-  | 'cubehelix-long'
-  | SignalRef
-  | {
-      type: 'rgb' | 'cubehelix' | 'cubehelix-long' | SignalRef;
-      gamma?: number | SignalRef;
-    };
-export interface DataRef {
+  | 'cubehelix-long';
+
+export interface ScaleInterpolateParams {
+  type: 'rgb' | 'cubehelix' | 'cubehelix-long' | SignalRef;
+  gamma?: number | SignalRef;
+}
+
+export type ScaleInterpolate = ScaleInterpolateEnum | SignalRef | ScaleInterpolateParams;
+
+export interface ScaleDataRef {
   data: string;
   field: ScaleField;
 }
-export type MultiDataRef =
-  | {
-      data: string;
-      fields: ScaleField[];
-    }
-  | {
-      fields: ((string | number | boolean)[] | DataRef | SignalRef)[];
-    };
-export type ScaleData =
-  | (DataRef & { sort?: SortField })
-  | (MultiDataRef & { sort?: UnionSortField });
+
+export interface ScaleMultiDataRef {
+  fields: ((string | number | boolean)[] | ScaleDataRef | SignalRef)[];
+}
+
+export interface ScaleMultiFieldsRef {
+  data: string;
+  fields: ScaleField[];
+}
+
+export type ScaleData = (ScaleDataRef | ScaleMultiDataRef | ScaleMultiFieldsRef) & {
+  sort?: SortField;
+};
 export type QuantScaleType =
@@ -167,5 +188,11 @@ | 'linear'
   | 'year';
+
+export interface TimeIntervalStep {
+  interval: TimeInterval;
+  step: number;
+}
+
 export interface TimeScale extends ContinuousScale {
   type: 'time' | 'utc';
-  nice?: boolean | TimeInterval | SignalRef;
+  nice?: boolean | TimeInterval | TimeIntervalStep | SignalRef;
 }
@@ -172,0 +199,0 @@ export interface IdentityScale extends BaseScale {

types/spec/transform.d.ts

@@ -554,3 +554,3 @@ import {
   fields?: FieldRef[] | SignalRef;
-  as?: string | null | SignalRef;
+  as?: (string | SignalRef | null)[] | SignalRef;
 }
@@ -557,0 +557,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

4013

increased by0.8%

Worsened metrics

Total package byte prevSize

115446

decreased by-7.56%

Number of package files

37

decreased by-5.13%

No dependency changes