vega-typings - npm Package Compare versions

Comparing version 0.15.4 to 0.16.0

package.json

 {
   "name": "vega-typings",
-  "version": "0.15.4",
+  "version": "0.16.0",
   "description": "Typings for Vega.",
@@ -22,3 +22,4 @@ "types": "types",
     "vega-util": "^1.13.1"
-  }
+  },
+  "gitHead": "35e31c5c6b54db9dc3a577b5adad8d15ec274d32"
 }

types/spec/axis.d.ts

@@ -21,2 +21,3 @@ import {
   StringValue,
+  StrokeCapValue,
   TextBaselineValue,
@@ -111,10 +112,2 @@ } from './values';
   /**
-   * The integer z-index indicating the layering of the axis group relative to other axis, mark, and legend groups.
-   *
-   * @TJS-type integer
-   * @minimum 0
-   */
-  zindex?: number;
-
-  /**
    * Mark definitions for custom axis encoding.
@@ -181,2 +174,18 @@ */
 
+  // ---------- ARIA ----------
+  /**
+   * A boolean flag indicating if [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) should be included (SVG output only).
+   * If `false`, the "aria-hidden" attribute will be set on the output SVG group, removing the axis from the ARIA accessibility tree.
+   *
+   * __Default value:__ `true`
+   */
+  aria?: boolean;
+
+  /**
+   * A text description of this axis for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If the `aria` property is true, for SVG output the ["aria-label" attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute) will be set to this description.
+   * If the description is unspecified it will be automatically generated.
+   */
+  description?: string;
+
   // ---------- Title ----------
@@ -272,2 +281,9 @@ /**
   /**
+   * The stroke cap for the domain line's ending style. One of `"butt"`, `"round"` or `"square"`.
+   *
+   * __Default value:__ `"butt"`
+   */
+  domainCap?: StrokeCapValue;
+
+  /**
    * An array of alternating [stroke, space] lengths for dashed domain lines.
@@ -315,2 +331,10 @@ */
   /**
+   * The stroke cap for the tick lines' ending style. One of `"butt"`, `"round"` or `"square"`.
+   *
+   * __Default value:__ `"butt"`
+   */
+
+  tickCap?: StrokeCapValue;
+
+  /**
    * The color of the axis's tick.
@@ -377,2 +401,9 @@ *
   /**
+   * The stroke cap for grid lines' ending style. One of `"butt"`, `"round"` or `"square"`.
+   *
+   * __Default value:__ `"butt"`
+   */
+  gridCap?: StrokeCapValue;
+
+  /**
    * Color of gridlines.
@@ -525,4 +556,11 @@ *
    */
+  labelPadding?: NumberValue;
 
-  labelPadding?: NumberValue;
+  /**
+   * The integer z-index indicating the layering of the axis group relative to other axis, mark, and legend groups.
+   *
+   * @TJS-type integer
+   * @minimum 0
+   */
+  zindex?: number;
 }

types/spec/config.d.ts

@@ -87,2 +87,28 @@ import {
   /**
+   * A boolean flag indicating if [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) should be included (SVG output only).
+   * If `false`, the "aria-hidden" attribute will be set on the output SVG element, removing the mark item from the ARIA accessibility tree.
+   */
+  aria?: boolean | SignalRef;
+
+  /**
+   * Sets the type of user interface element of the mark item for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If specified, this property determines the "role" attribute.
+   * Warning: this property is experimental and may be changed in the future.
+   */
+  ariaRole?: string | SignalRef;
+
+  /**
+   * A human-readable, author-localized description for the role of the mark item for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If specified, this property determines the "aria-roledescription" attribute.
+   * Warning: this property is experimental and may be changed in the future.
+   */
+  ariaRoleDescription?: string | SignalRef;
+
+  /**
+   * A text description of the mark item for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If specified, this property determines the ["aria-label" attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute).
+   */
+  description?: string | SignalRef;
+
+  /**
    * Width of the marks.
@@ -89,0 +115,0 @@ */

types/spec/encode.d.ts

@@ -1,4 +0,4 @@
-import { StrokeCap, StrokeJoin, Cursor } from './config.d';
 import { SignalRef } from '.';
 import { Color } from './color';
+import { Cursor, StrokeCap, StrokeJoin } from './config.d';
 import { TitleAnchor } from './title';
@@ -63,2 +63,4 @@
 export type AlignValueRef = ScaledValueRef<Align>;
+
+export type StrokeCapValueRef = ScaledValueRef<StrokeCap>;
 export type AnchorValueRef = ScaledValueRef<TitleAnchor>;
@@ -258,2 +260,24 @@ export type OrientValueRef = ScaledValueRef<Orient>;
   zindex?: ProductionRule<NumericValueRef>;
+  /**
+   * A boolean flag indicating if [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) should be included (SVG output only).
+   * If `false`, the "aria-hidden" attribute will be set on the output SVG element, removing the mark item from the ARIA accessibility tree.
+   */
+  aria?: ProductionRule<BooleanValueRef>;
+  /**
+   * Sets the type of user interface element of the mark item for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If specified, this property determines the "role" attribute.
+   * Warning: this property is experimental and may be changed in the future.
+   */
+  ariaRole?: ProductionRule<StringValueRef>;
+  /**
+   * A human-readable, author-localized description for the role of the mark item for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If specified, this property determines the "aria-roledescription" attribute.
+   * Warning: this property is experimental and may be changed in the future.
+   */
+  ariaRoleDescription?: ProductionRule<StringValueRef>;
+  /**
+   * A text description of the mark item for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If specified, this property determines the ["aria-label" attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute).
+   */
+  description?: ProductionRule<StringValueRef>;
   [k: string]: ProductionRule<ArbitraryValueRef> | undefined;
@@ -260,0 +284,0 @@ }

types/spec/legend.d.ts

@@ -15,2 +15,3 @@ import {
   AnchorValue,
+  BooleanValue,
   ColorValue,
@@ -104,10 +105,2 @@ DashArrayValue,
   /**
-   * The integer z-index indicating the layering of the legend group relative to other axis, mark, and legend groups.
-   *
-   * @TJS-type integer
-   * @minimum 0
-   */
-  zindex?: number;
-
-  /**
    * Mark definitions for custom legend encoding.
@@ -148,2 +141,18 @@ */
 
+  // ---------- ARIA ----------
+  /**
+   * A boolean flag indicating if [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) should be included (SVG output only).
+   * If `false`, the "aria-hidden" attribute will be set on the output SVG group, removing the legend from the ARIA accessibility tree.
+   *
+   * __Default value:__ `true`
+   */
+  aria?: boolean;
+
+  /**
+   * A text description of this legend for [ARIA accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) (SVG output only).
+   * If the `aria` property is true, for SVG output the ["aria-label" attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute) will be set to this description.
+   * If the description is unspecified it will be automatically generated.
+   */
+  description?: string;
+
   // ---------- Legend Group ----------
@@ -469,2 +478,10 @@ /**
   labelSeparation?: number | SignalRef;
+
+  /**
+   * The integer z-index indicating the layering of the legend group relative to other axis, mark, and legend groups.
+   *
+   * @TJS-type integer
+   * @minimum 0
+   */
+  zindex?: number;
 }

types/spec/mark.d.ts

@@ -51,2 +51,3 @@ import * as Encode from './encode';
   description?: string;
+  aria?: boolean;
   key?: string;
@@ -53,0 +54,0 @@ clip?: Clip;

types/spec/title.d.ts

@@ -6,2 +6,3 @@ import { GroupEncodeEntry, GuideEncodeEntry, SignalRef, TextEncodeEntry } from '.';
   AnchorValue,
+  BooleanValue,
   ColorValue,
@@ -46,12 +47,2 @@ FontStyleValue,
   /**
-   * 	The integer z-index indicating the layering of the title group relative to other axis, mark, and legend groups.
-   *
-   * __Default value:__ `0`.
-   *
-   * @TJS-type integer
-   * @minimum 0
-   */
-  zindex?: number;
-
-  /**
    * Mark definitions for custom title encoding.
@@ -94,2 +85,17 @@ */
   /**
+   * Default title orientation (`"top"`, `"bottom"`, `"left"`, or `"right"`)
+   */
+  orient?: TitleOrient | SignalRef;
+
+  // ---------- ARIA ----------
+  /**
+   * A boolean flag indicating if [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) should be included (SVG output only).
+   * If `false`, the "aria-hidden" attribute will be set on the output SVG group, removing the title from the ARIA accessibility tree.
+   *
+   * __Default value:__ `true`
+   */
+  aria?: boolean;
+
+  // ---------- Shared Text Properties ----------
+  /**
    * Horizontal text alignment for title text. One of `"left"`, `"center"`, or `"right"`.
@@ -120,2 +126,10 @@ */
   /**
+   * The maximum allowed length in pixels of title and subtitle text.
+   *
+   * @minimum 0
+   */
+  limit?: NumberValue;
+
+  // ---------- Title Text ----------
+  /**
    * Text color for title text.
@@ -153,15 +167,4 @@ */
 
+  // ---------- Subtitle Text ----------
   /**
-   * The maximum allowed length in pixels of title and subtitle text.
-   *
-   * @minimum 0
-   */
-  limit?: NumberValue;
-
-  /**
-   * Default title orientation (`"top"`, `"bottom"`, `"left"`, or `"right"`)
-   */
-  orient?: TitleOrient | SignalRef;
-
-  /**
    * Text color for subtitle text.
@@ -203,2 +206,12 @@ */
   subtitlePadding?: NumberValue;
+
+  /**
+   * 	The integer z-index indicating the layering of the title group relative to other axis, mark, and legend groups.
+   *
+   * __Default value:__ `0`.
+   *
+   * @TJS-type integer
+   * @minimum 0
+   */
+  zindex?: number;
 }

types/spec/transform.d.ts

@@ -648,2 +648,3 @@ import {
   | 'date'
+  | 'dayofyear'
   | 'hours'
@@ -650,0 +651,0 @@ | 'minutes'

types/spec/values.d.ts

@@ -0,1 +1,3 @@
+import { Color } from './color';
+import { StrokeCap } from './config';
 import {
@@ -16,2 +18,3 @@ Align,
   StringValueRef,
+  StrokeCapValueRef,
   SymbolShape,
@@ -23,3 +26,2 @@ SymbolShapeValueRef,
 import { TitleAnchor } from './title';
-import { Color } from './color';
 
@@ -38,2 +40,4 @@ export type NumberValue = number | NumericValueRef;
 
+export type StrokeCapValue = StrokeCap | StrokeCapValueRef;
+
 export type TextBaselineValue = TextBaseline | TextBaselineValueRef;
@@ -40,0 +44,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

Total package byte prevSize

128263

increased by6.36%

Number of package files

37

increased by2.78%

Lines of code

4237

increased by2.67%

No dependency changes