@types/chartist - npm Package Compare versions

Comparing version 0.9.34 to 0.9.35

chartist/index.d.ts

@@ -1,4 +0,4 @@
-// Type definitions for Chartist v0.9.5
+// Type definitions for Chartist v0.9.6
 // Project: https://github.com/gionkunz/chartist-js
-// Definitions by: Matt Gibbs <https://github.com/mtgibbs>
+// Definitions by: Matt Gibbs <https://github.com/mtgibbs>, Simon Pfeifer <https://github.com/psimonski>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -23,2 +23,3 @@
     Line: IChartistLineChart;
+    Candle: IChartistCandleChart;
 
@@ -142,2 +143,6 @@ FixedScaleAxis: IFixedScaleAxisStatic;
 
+  interface IChartistCandleChart extends IChartistBase<ICandleChartOptions> {
+    new (target: any, data: IChartistData, options?: ICandleChartOptions, responsiveOptions?: Array<IResponsiveOptionTuple<ICandleChartOptions>>): IChartistCandleChart;
+  }
+
   interface IChartOptions {
@@ -357,2 +362,120 @@ /**
 
+  interface ICandleChartOptions extends IChartOptions {
+
+    /**
+     * Options for X-Axis
+     */
+    axisX?: ICandleChartAxis;
+
+    /**
+     * Options for Y-Axis
+     */
+    axisY?: ICandleChartAxis;
+
+    /**
+     * Specify a fixed width for the chart as a string (i.e. '100px' or '50%')
+     */
+    width?: number | string;
+
+    /**
+     * Specify a fixed height for the chart as a string (i.e. '100px' or '50%')
+     */
+    height?: number | string;
+
+    /**
+     * Overriding the natural high of the chart allows you to zoom in or limit the charts highest displayed value
+     */
+    hight?: number | string;
+
+    /**
+     * Overriding the natural low of the chart allows you to zoom in or limit the charts lowest displayed value
+     */
+    low?: number | string;
+
+    /**
+     * Width of candle body in pixel (IMO is 2 px best minimum value)
+     */
+    candleWidth?: number | string;
+
+    /**
+     * Width of candle wick in pixel (IMO is 1 px best minimum value)
+     */
+    candleWickWidth?: number | string;
+
+    /**
+     * Use calculated x-axis step length, depending on the number of quotes to display, as candle width. Otherwise the candleWidth is being used.
+     */
+    useStepLengthAsCandleWidth?: boolean | string;
+
+    /**
+     * Use 1/3 of candle body width as width for the candle wick, otherwise the candleWickWidth is being used.
+     */
+    useOneThirdAsCandleWickWidth?: boolean | string;
+
+    /**
+     * Padding of the chart drawing area to the container element and labels as a number or padding object {top: 5, right: 5, bottom: 5, left: 5}
+     */
+    chartPadding?: IChartPadding | number;
+
+    /**
+     * When set to true, the last grid line on the x-axis is not drawn and the chart elements will expand to the full available width of the chart. For the last label to be drawn correctly you might need to add chart padding or offset the last label with a draw event handler.
+     */
+    fullWidth?: boolean | string;
+
+    /**
+     * Override the class names that get used to generate the SVG structure of the chart
+     */
+    classNames?: ICandleChartClasses;
+  }
+
+  interface ICandleChartAxis {
+    /**
+     * The offset of the chart drawing area to the border of the container
+     */
+    offset?: number;
+    /**
+     * Position where labels are placed. Can be set to `start` or `end` where `start` is equivalent to left or top on vertical axis and `end` is equivalent to right or bottom on horizontal axis.
+     */
+    position?: string;
+    /**
+     * Allows you to correct label positioning on this axis by positive or negative x and y offset.
+     */
+    labelOffset?: {
+      x?: number;
+      y?: number;
+    };
+    /**
+     * If labels should be shown or not
+     */
+    showLabel?: boolean;
+    /**
+     * If the axis grid should be drawn or not
+     */
+    showGrid?: boolean;
+    /**
+     * Interpolation function that allows you to intercept the value from the axis label
+     */
+    labelInterpolationFnc?: Function;
+    /**
+     * Set the axis type to be used to project values on this axis. If not defined, Chartist.StepAxis will be used for the X-Axis, where the ticks option will be set to the labels in the data and the stretch option will be set to the global fullWidth option. This type can be changed to any axis constructor available (e.g. Chartist.FixedScaleAxis), where all axis options should be present here.
+     */
+    type?: any;
+  }
+
+  interface ICandleChartClasses {
+    chart?: string;
+    label?: string;
+    labelGroup?: string;
+    series?: string;
+    candlePositive?: string;
+    candleNegative?: string,
+    grid?: string,
+    gridGroup?: string,
+    gridBackground?: string,
+    vertical?: string,
+    horizontal?: string,
+    start?: string,
+    end?: string,
+  }
+
   interface ChartistSvgStatic {
@@ -359,0 +482,0 @@ new (name: HTMLElement | string, attributes: Object, className?: string, parent?: Object, insertFirst?: boolean): IChartistSvg;

chartist/package.json

 {
     "name": "@types/chartist",
-    "version": "0.9.34",
+    "version": "0.9.35",
     "description": "TypeScript definitions for Chartist",
     "license": "MIT",
-    "author": "Matt Gibbs <https://github.com/mtgibbs>",
+    "contributors": [
+        {
+            "name": "Matt Gibbs",
+            "url": "https://github.com/mtgibbs"
+        },
+        {
+            "name": "Simon Pfeifer",
+            "url": "https://github.com/psimonski"
+        }
+    ],
     "main": "",
@@ -15,3 +24,4 @@ "repository": {
     "peerDependencies": {},
-    "typesPublisherContentHash": "eb72b63ec1480c0b7298c154e6619732d670b0a0b725f3f7c5c0a2e9e1fd8d5c"
+    "typesPublisherContentHash": "79437dde184510c704556929fdab977efed0f5ade9bcac475665da011f10c435",
+    "typeScriptVersion": "2.0"
 }

chartist/README.md

@@ -8,11 +8,10 @@ # Installation
 # Details
-Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/chartist
+Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chartist
 
 Additional Details
- * Last updated: Mon, 12 Dec 2016 22:50:15 GMT
- * Library Dependencies: none
- * Module Dependencies: none
+ * Last updated: Fri, 09 Jun 2017 14:51:29 GMT
+ * Dependencies: none
  * Global values: Chartist
 
 # Credits
-These definitions were written by Matt Gibbs <https://github.com/mtgibbs>.
+These definitions were written by Matt Gibbs <https://github.com/mtgibbs>, Simon Pfeifer <https://github.com/psimonski>.

No alert changes

Improved metrics

Total package byte prevSize

26991

22.31%

Lines of code

577

17.28%

Worsened metrics

Number of lines in readme file

17

-5.56%

No dependency changes