victory-core 36.4.1 → 36.5.0

package/es/victory-util/point-path-helpers.d.ts

@@ -0,0 +1,9 @@
+export declare function circle(x: number, y: number, size: number): string;
+export declare function square(x: number, y: number, size: number): string;
+export declare function diamond(x: number, y: number, size: number): string;
+export declare function triangleDown(x: number, y: number, size: number): string;
+export declare function triangleUp(x: number, y: number, size: number): string;
+export declare function plus(x: number, y: number, size: number): string;
+export declare function cross(x: number, y: number, size: number): string;
+export declare function minus(x: number, y: number, size: number): string;
+export declare function star(x: number, y: number, size: number): string;

package/es/victory-util/point-path-helpers.js

@@ -1,73 +1,71 @@
 import _range from "lodash/range";
-export default {
-  circle: function (x, y, size) {
-    return "M ".concat(x, ", ").concat(y, "\n      m ").concat(-size, ", 0\n      a ").concat(size, ", ").concat(size, " 0 1,0 ").concat(size * 2, ",0\n      a ").concat(size, ", ").concat(size, " 0 1,0 ").concat(-size * 2, ",0");
-  },
-  square: function (x, y, size) {
-    var baseSize = 0.87 * size; // eslint-disable-line no-magic-numbers
+export function circle(x, y, size) {
+  return "M ".concat(x, ", ").concat(y, "\n      m ").concat(-size, ", 0\n      a ").concat(size, ", ").concat(size, " 0 1,0 ").concat(size * 2, ",0\n      a ").concat(size, ", ").concat(size, " 0 1,0 ").concat(-size * 2, ",0");
+}
+export function square(x, y, size) {
+  var baseSize = 0.87 * size; // eslint-disable-line no-magic-numbers
 
-    var x0 = x - baseSize;
-    var y1 = y + baseSize;
-    var distance = x + baseSize - x0;
-    return "M ".concat(x0, ", ").concat(y1, "\n      h").concat(distance, "\n      v-").concat(distance, "\n      h-").concat(distance, "\n      z");
-  },
-  diamond: function (x, y, size) {
-    var baseSize = 0.87 * size; // eslint-disable-line no-magic-numbers
+  var x0 = x - baseSize;
+  var y1 = y + baseSize;
+  var distance = x + baseSize - x0;
+  return "M ".concat(x0, ", ").concat(y1, "\n      h").concat(distance, "\n      v-").concat(distance, "\n      h-").concat(distance, "\n      z");
+}
+export function diamond(x, y, size) {
+  var baseSize = 0.87 * size; // eslint-disable-line no-magic-numbers
 
-    var length = Math.sqrt(2 * (baseSize * baseSize));
-    return "M ".concat(x, ", ").concat(y + length, "\n      l ").concat(length, ", -").concat(length, "\n      l -").concat(length, ", -").concat(length, "\n      l -").concat(length, ", ").concat(length, "\n      l ").concat(length, ", ").concat(length, "\n      z");
-  },
-  triangleDown: function (x, y, size) {
-    var height = size / 2 * Math.sqrt(3);
-    var x0 = x - size;
-    var x1 = x + size;
-    var y0 = y - size;
-    var y1 = y + height;
-    return "M ".concat(x0, ", ").concat(y0, "\n      L ").concat(x1, ", ").concat(y0, "\n      L ").concat(x, ", ").concat(y1, "\n      z");
-  },
-  triangleUp: function (x, y, size) {
-    var height = size / 2 * Math.sqrt(3);
-    var x0 = x - size;
-    var x1 = x + size;
-    var y0 = y - height;
-    var y1 = y + size;
-    return "M ".concat(x0, ", ").concat(y1, "\n      L ").concat(x1, ", ").concat(y1, "\n      L ").concat(x, ", ").concat(y0, "\n      z");
-  },
-  plus: function (x, y, size) {
-    var baseSize = 1.1 * size; // eslint-disable-line no-magic-numbers
+  var length = Math.sqrt(2 * (baseSize * baseSize));
+  return "M ".concat(x, ", ").concat(y + length, "\n      l ").concat(length, ", -").concat(length, "\n      l -").concat(length, ", -").concat(length, "\n      l -").concat(length, ", ").concat(length, "\n      l ").concat(length, ", ").concat(length, "\n      z");
+}
+export function triangleDown(x, y, size) {
+  var height = size / 2 * Math.sqrt(3);
+  var x0 = x - size;
+  var x1 = x + size;
+  var y0 = y - size;
+  var y1 = y + height;
+  return "M ".concat(x0, ", ").concat(y0, "\n      L ").concat(x1, ", ").concat(y0, "\n      L ").concat(x, ", ").concat(y1, "\n      z");
+}
+export function triangleUp(x, y, size) {
+  var height = size / 2 * Math.sqrt(3);
+  var x0 = x - size;
+  var x1 = x + size;
+  var y0 = y - height;
+  var y1 = y + size;
+  return "M ".concat(x0, ", ").concat(y1, "\n      L ").concat(x1, ", ").concat(y1, "\n      L ").concat(x, ", ").concat(y0, "\n      z");
+}
+export function plus(x, y, size) {
+  var baseSize = 1.1 * size; // eslint-disable-line no-magic-numbers
 
-    var distance = baseSize / 1.5; // eslint-disable-line no-magic-numbers
+  var distance = baseSize / 1.5; // eslint-disable-line no-magic-numbers
 
-    return "\n      M ".concat(x - distance / 2, ", ").concat(y + baseSize, "\n      v-").concat(distance, "\n      h-").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h-").concat(distance, "\n      v").concat(distance, "\n      z");
-  },
-  cross: function (x, y, size) {
-    var baseSize = 0.8 * size; // eslint-disable-line no-magic-numbers
+  return "\n      M ".concat(x - distance / 2, ", ").concat(y + baseSize, "\n      v-").concat(distance, "\n      h-").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h-").concat(distance, "\n      v").concat(distance, "\n      z");
+}
+export function cross(x, y, size) {
+  var baseSize = 0.8 * size; // eslint-disable-line no-magic-numbers
 
-    var distance = baseSize / 1.5; // eslint-disable-line no-magic-numbers
+  var distance = baseSize / 1.5; // eslint-disable-line no-magic-numbers
 
-    return "\n      M ".concat(x - distance / 2, ", ").concat(y + baseSize + distance, "\n      v-").concat(distance * 2, "\n      h-").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h-").concat(distance, "\n      v").concat(distance * 2, "\n      z");
-  },
-  minus: function (x, y, size) {
-    var baseSize = 1.1 * size; // eslint-disable-line no-magic-numbers
+  return "\n      M ".concat(x - distance / 2, ", ").concat(y + baseSize + distance, "\n      v-").concat(distance * 2, "\n      h-").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v-").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h").concat(distance, "\n      v").concat(distance, "\n      h-").concat(distance, "\n      v").concat(distance * 2, "\n      z");
+}
+export function minus(x, y, size) {
+  var baseSize = 1.1 * size; // eslint-disable-line no-magic-numbers
 
-    var lineHeight = baseSize - baseSize * 0.3; // eslint-disable-line no-magic-numbers
+  var lineHeight = baseSize - baseSize * 0.3; // eslint-disable-line no-magic-numbers
 
-    var x0 = x - baseSize;
-    var y1 = y + lineHeight / 2;
-    var distance = x + baseSize - x0;
-    return "M ".concat(x0, ", ").concat(y1, "\n      h").concat(distance, "\n      v-").concat(lineHeight, "\n      h-").concat(distance, "\n      z");
-  },
-  star: function (x, y, size) {
-    var baseSize = 1.35 * size; // eslint-disable-line no-magic-numbers
+  var x0 = x - baseSize;
+  var y1 = y + lineHeight / 2;
+  var distance = x + baseSize - x0;
+  return "M ".concat(x0, ", ").concat(y1, "\n      h").concat(distance, "\n      v-").concat(lineHeight, "\n      h-").concat(distance, "\n      z");
+}
+export function star(x, y, size) {
+  var baseSize = 1.35 * size; // eslint-disable-line no-magic-numbers
 
-    var angle = Math.PI / 5; // eslint-disable-line no-magic-numbers
-    // eslint-disable-next-line no-magic-numbers
+  var angle = Math.PI / 5; // eslint-disable-line no-magic-numbers
+  // eslint-disable-next-line no-magic-numbers
 
-    var starCoords = _range(10).map(function (index) {
-      var length = index % 2 === 0 ? baseSize : baseSize / 2;
-      return "".concat(length * Math.sin(angle * (index + 1)) + x, ",\n        ").concat(length * Math.cos(angle * (index + 1)) + y);
-    });
+  var starCoords = _range(10).map(function (index) {
+    var length = index % 2 === 0 ? baseSize : baseSize / 2;
+    return "".concat(length * Math.sin(angle * (index + 1)) + x, ",\n        ").concat(length * Math.cos(angle * (index + 1)) + y);
+  });
 
-    return "M ".concat(starCoords.join("L"), " z");
-  }
-};
+  return "M ".concat(starCoords.join("L"), " z");
+}

package/es/victory-util/selection.d.ts

@@ -0,0 +1,23 @@
+import * as React from "react";
+import { DomainPropType, ScalePropType, SVGCoordinateType } from "./types";
+
+export function getParentSVG(evt: React.SyntheticEvent): string;
+
+export function getSVGEventCoordinates(
+  evt: React.SyntheticEvent,
+  svg?: SVGElement
+): SVGCoordinateType;
+
+export function getDomainCoordinates(
+  props: any,
+  domain?: DomainPropType
+): DomainPropType;
+
+export function getDataCoordinates(
+  props: any,
+  scale: ScalePropType,
+  x: number,
+  y: number
+): SVGCoordinateType;
+
+export function getBounds(props: any): SVGCoordinateType;

package/es/victory-util/selection.js

@@ -1,5 +1,3 @@
-/* eslint-disable func-style */
-
 /* eslint-disable no-use-before-define */
 import * as Collection from "./collection"; // Private Functions
 

package/es/victory-util/style.js

@@ -1,5 +1,3 @@
-/* eslint-disable func-style */
-
 /**
  * Given an object with CSS/SVG transform definitions, return the string value
  * for use with the `transform` CSS property or SVG attribute. Note that we

package/es/victory-util/textsize.d.ts

@@ -0,0 +1,8 @@
+import { TextSizeStyleInterface } from "./types";
+
+export function approximateTextSize(
+  text: string,
+  style?: TextSizeStyleInterface
+): { width: number; height: number };
+
+export function convertLengthToPixels(length: string, fontSize: number): number;

package/es/victory-util/timer-context.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import Timer from "./timer";
+/**
+ * The React context object consumers may use to access or override the global
+ * timer.
+ */
+declare const TimerContext: React.Context<{
+    transitionTimer: Timer;
+    animationTimer: Timer;
+}>;
+export default TimerContext;

package/es/victory-util/timer.d.ts

@@ -0,0 +1,16 @@
+declare type Callback = (elapsed: number, duration: number) => void;
+export default class Timer {
+    private shouldAnimate;
+    private readonly subscribers;
+    private activeSubscriptions;
+    private timer;
+    constructor();
+    bypassAnimation(): void;
+    resumeAnimation(): void;
+    loop: () => void;
+    start(): void;
+    stop(): void;
+    subscribe(callback: Callback, duration: number): number;
+    unsubscribe(id: any): void;
+}
+export {};

package/es/victory-util/timer.js

@@ -8,11 +8,23 @@ import { timer, now } from "victory-vendor/d3-timer";
 
 var Timer = /*#__PURE__*/function () {
   function Timer() {
+    var _this = this;
+
     _classCallCheck(this, Timer);
 
+    this.shouldAnimate = void 0;
+    this.subscribers = void 0;
+    this.activeSubscriptions = void 0;
+    this.timer = void 0;
+
+    this.loop = function () {
+      _this.subscribers.forEach(function (s) {
+        s.callback(now() - s.startTime, s.duration);
+      });
+    };
+
     this.shouldAnimate = true;
     this.subscribers = [];
-    this.loop = this.loop.bind(this);
     this.timer = null;
     this.activeSubscriptions = 0;
   }
@@ -27,13 +39,6 @@ var Timer = /*#__PURE__*/function () {
     value: function resumeAnimation() {
       this.shouldAnimate = true;
     }
-  }, {
-    key: "loop",
-    value: function loop() {
-      this.subscribers.forEach(function (s) {
-        s.callback(now() - s.startTime, s.duration);
-      });
-    }
   }, {
     key: "start",
     value: function start() {

package/es/victory-util/types.d.ts

@@ -0,0 +1,188 @@
+import * as React from "react";
+import { OriginType } from "../victory-label/victory-label";
+import { NumberOrCallback, PaddingProps, VictoryThemeDefinition } from "../victory-theme/victory-theme";
+import { StringOrCallback, StringOrNumberOrCallback } from "../types";
+import { AnimationEasing, AnimationStyle } from "../victory-animation/victory-animation";
+export declare type StringOrNumberOrList = string | number | (string | number)[];
+export interface AnimatePropTypeInterface {
+    duration?: number;
+    onEnd?: () => void;
+    onExit?: {
+        duration?: number;
+        before?: (datum: any) => AnimationStyle;
+    };
+    onEnter?: {
+        duration?: number;
+        before?: (datum: any) => AnimationStyle;
+        after?: (datum: any) => AnimationStyle;
+    };
+    onLoad?: {
+        duration?: number;
+        before?: (datum: any) => AnimationStyle;
+        after?: (datum: any) => AnimationStyle;
+    };
+    easing?: AnimationEasing;
+    animationWhitelist?: string[];
+}
+export interface EventCallbackInterface<TTarget, TEventKey> {
+    childName?: string | string[];
+    target?: TTarget;
+    eventKey?: TEventKey;
+    mutation: (props: any) => any;
+    callback?: (props: any) => any;
+}
+export interface EventPropTypeInterface<TTarget, TEventKey> {
+    childName?: string | Array<StringOrNumberOrCallback>;
+    target: TTarget;
+    eventKey?: TEventKey;
+    eventHandlers: {
+        [key: string]: {
+            (event: React.SyntheticEvent<any>, props?: any): EventCallbackInterface<TTarget, TEventKey>;
+        } | {
+            (event: React.SyntheticEvent<any>, props?: any): EventCallbackInterface<TTarget, TEventKey>[];
+        } | {
+            (event: React.SyntheticEvent<any>, props?: any): void;
+        };
+    };
+}
+export declare type DomainTuple = [number, number] | [Date, Date];
+export declare type DomainPropObjectType = {
+    x?: DomainTuple;
+    y: DomainTuple;
+} | {
+    x: DomainTuple;
+    y?: DomainTuple;
+};
+export declare type DomainPropType = DomainPropObjectType | DomainTuple;
+export declare type PaddingType = number | [number, number];
+export declare type DomainPaddingPropType = PaddingType | {
+    x?: PaddingType;
+    y?: PaddingType;
+};
+export declare type RangeTuple = [number, number];
+export declare type RangePropType = RangeTuple | {
+    x?: RangeTuple;
+    y?: RangeTuple;
+};
+/**
+ * D3 scale function shape. Don"t want to introduce typing dependency to d3
+ */
+export interface D3Scale {
+    (input: string | number): number;
+    domain: () => any;
+    range: () => any;
+    copy: () => any;
+}
+export declare type ScalePropType = "linear" | "time" | "log" | "sqrt";
+export declare type CategoryPropType = string[] | {
+    x: string[];
+} | {
+    y: string[];
+} | {
+    x: string[];
+    y: string[];
+};
+export declare type DataGetterPropType = number | string | string[] | {
+    (data: any): number | string | string[];
+} | Function;
+export declare type InterpolationPropType = "basis" | "basisClosed" | "basisOpen" | "bundle" | "cardinal" | "cardinalClosed" | "cardinalOpen" | "catmullRom" | "catmullRomClosed" | "catmullRomOpen" | "linear" | "linearClosed" | "monotoneX" | "monotoneY" | "natural" | "radial" | "step" | "stepAfter" | "stepBefore";
+export declare type ColorScalePropType = "grayscale" | "qualitative" | "heatmap" | "warm" | "cool" | "red" | "green" | "blue" | string[];
+export declare type SortOrderPropType = "ascending" | "descending";
+export declare type SVGCoordinateType = {
+    x: number;
+    y: number;
+};
+export interface VictoryCommonThemeProps {
+    animate?: boolean | AnimatePropTypeInterface;
+    colorScale?: ColorScalePropType;
+    containerComponent?: React.ReactElement;
+    domainPadding?: DomainPaddingPropType;
+    externalEventMutations?: EventCallbackInterface<string | string[], StringOrNumberOrList>[];
+    groupComponent?: React.ReactElement;
+    height?: number;
+    horizontal?: boolean;
+    maxDomain?: number | {
+        x?: number;
+        y?: number;
+    };
+    minDomain?: number | {
+        x?: number;
+        y?: number;
+    };
+    name?: string;
+    origin?: OriginType;
+    padding?: PaddingProps;
+    polar?: boolean;
+    range?: RangePropType;
+    scale?: ScalePropType | D3Scale | {
+        x?: ScalePropType | D3Scale;
+        y?: ScalePropType | D3Scale;
+    };
+    sharedEvents?: {
+        events: any[];
+        getEventState: Function;
+    };
+    singleQuadrantDomainPadding?: boolean | {
+        x?: boolean;
+        y?: boolean;
+    };
+    standalone?: boolean;
+    width?: number;
+}
+export interface VictoryCommonProps extends VictoryCommonThemeProps {
+    theme?: VictoryThemeDefinition;
+}
+export interface VictoryCommonPrimitiveProps {
+    active?: boolean;
+    ariaLabel?: StringOrCallback;
+    className?: string;
+    clipPath?: string;
+    data?: any;
+    desc?: string | Function;
+    disableInlineStyles?: boolean;
+    events?: object;
+    id?: number | string | Function;
+    index?: number | string;
+    origin?: OriginType;
+    polar?: boolean;
+    role?: string;
+    scale?: any;
+    shapeRendering?: string;
+    style?: any;
+    tabIndex?: NumberOrCallback;
+    transform?: string;
+}
+export interface VictoryDatableProps {
+    categories?: CategoryPropType;
+    data?: any[];
+    dataComponent?: React.ReactElement;
+    domain?: DomainPropType;
+    domainPadding?: DomainPaddingPropType;
+    samples?: number;
+    sortKey?: DataGetterPropType;
+    sortOrder?: SortOrderPropType;
+    x?: DataGetterPropType;
+    y?: DataGetterPropType;
+    y0?: DataGetterPropType;
+}
+export interface VictoryLabelableProps {
+    labelComponent?: React.ReactElement;
+}
+export interface VictoryMultiLabelableProps extends VictoryLabelableProps {
+    labels?: string[] | number[] | {
+        (data: any): string | string[] | number | number[] | null;
+    };
+}
+export interface VictorySingleLabelableProps extends VictoryLabelableProps {
+    label?: string | {
+        (data: any): string | number | null;
+    };
+}
+export interface TextSizeStyleInterface {
+    angle?: number;
+    characterConstant?: string;
+    fontFamily?: string;
+    fontSize?: number | string;
+    letterSpacing?: string;
+    lineHeight?: number;
+}

package/es/victory-util/types.js

@@ -0,0 +1 @@
+export {};