@types/chartist - npm Package Compare versions

Comparing version 0.9.35 to 0.9.36

chartist/index.d.ts

@@ -1,4 +0,4 @@
-// Type definitions for Chartist v0.9.6
+// Type definitions for Chartist v0.9.7
 // Project: https://github.com/gionkunz/chartist-js
-// Definitions by: Matt Gibbs <https://github.com/mtgibbs>, Simon Pfeifer <https://github.com/psimonski>
+// Definitions by: Matt Gibbs <https://github.com/mtgibbs>, Simon Pfeifer <https://github.com/psimonski>, Cassey Lottman <https://github.com/clottman>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -190,7 +190,13 @@
     donut?: boolean;
+    
+    /**
+     * If specified the donut segments will be drawn as shapes instead of strokes.
+     */    
+    donutSolid?: boolean;
 
     /**
-     * Specify the donut stroke width, currently done in javascript for convenience.
+     * Specify the donut stroke width, currently done in javascript for convenience. May move to CSS styles in the future.
+     * This option can be set as number or string to specify a relative width (i.e. 100 or '30%').
      */
-    donutWidth?: number;
+    donutWidth?: number | string;
 
@@ -221,2 +227,12 @@ /**
     labelDirection?: string;
+
+    /**
+     * If true the whole data is reversed including labels, the series order as well as the whole series data arrays.
+     */
+    reverseData?: boolean;
+    
+    /**
+    * If true empty values will be ignored to avoid drawing unncessary slices and labels
+    */
+    ignoreEmptyValues?: boolean;
   }
@@ -362,120 +378,121 @@
 
-  interface ICandleChartOptions extends IChartOptions {
+  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 drawncorrectly 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,     
+   }       
+ 
 
-    /**
-     * 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 {
@@ -688,2 +705,2 @@ new (name: HTMLElement | string, attributes: Object, className?: string, parent?: Object, insertFirst?: boolean): IChartistSvg;
 export = Chartist;
-export as namespace Chartist;
+export as namespace Chartist;

chartist/package.json

 {
     "name": "@types/chartist",
-    "version": "0.9.35",
+    "version": "0.9.36",
     "description": "TypeScript definitions for Chartist",
@@ -9,7 +9,14 @@ "license": "MIT",
             "name": "Matt Gibbs",
-            "url": "https://github.com/mtgibbs"
+            "url": "https://github.com/mtgibbs",
+            "githubUsername": "mtgibbs"
         },
         {
             "name": "Simon Pfeifer",
-            "url": "https://github.com/psimonski"
+            "url": "https://github.com/psimonski",
+            "githubUsername": "psimonski"
+        },
+        {
+            "name": "Cassey Lottman",
+            "url": "https://github.com/clottman",
+            "githubUsername": "clottman"
         }
@@ -24,5 +31,4 @@ ],
     "dependencies": {},
-    "peerDependencies": {},
-    "typesPublisherContentHash": "79437dde184510c704556929fdab977efed0f5ade9bcac475665da011f10c435",
+    "typesPublisherContentHash": "2c8c3433b130169e2267ca28d2a6180943c395feaf929552f7f73bbfcf27aa10",
     "typeScriptVersion": "2.0"
 }

chartist/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Fri, 09 Jun 2017 14:51:29 GMT
+ * Last updated: Tue, 03 Oct 2017 13:52:12 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: Chartist
 # Credits
-These definitions were written by Matt Gibbs <https://github.com/mtgibbs>, Simon Pfeifer <https://github.com/psimonski>.
+These definitions were written by Matt Gibbs <https://github.com/mtgibbs>, Simon Pfeifer <https://github.com/psimonski>, Cassey Lottman <https://github.com/clottman>.

No alert changes

Improved metrics

Total package byte prevSize

28690

increased by6.29%

Lines of code

589

increased by2.08%

No dependency changes