From b9917c89da9f2f9cfb2f099396b908d8bcca36ea Mon Sep 17 00:00:00 2001 From: preserveddarnell Date: Mon, 22 Oct 2018 17:49:46 -0400 Subject: [PATCH 1/2] Update various typos, punctuations & errors. --- LICENSE | 7 +- README.md | 4 +- webroot/amcharts/plugins/animate/README.md | 10 +- webroot/amcharts/plugins/dataloader/readme.md | 142 ++--- webroot/amcharts/plugins/export/README.md | 582 +++++++++--------- 5 files changed, 372 insertions(+), 373 deletions(-) diff --git a/LICENSE b/LICENSE index 08b5886..93d321d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,10 +1,9 @@ The MIT License (MIT) -Copyright (c) 2017-2018 LBRY Inc +Copyright (c) 2017-2018 LBRY Inc. -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - +THE SOFTWARE IS PROVIDED "AS-IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index d33f103..9d99c8b 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ composer update * Create the directories, `tmp` and `logs` in the `block-explorer` folder if they have not been created yet, and make sure that they are writable by the web server. * Copy `config/app.default.php` to `config/app.php`. Edit the database connection values to correspond to your environment. * Copy `config/lbry.default.php` to `config/lbry.php`. Update the values for LBRY RPC URL and the Redis URL to correspond to your environment. -* Configure your web server with the host root folder set to `/block-explorer/webroot` where `` is the absolute path to the configuraiton. Here is a sample nginx configuration. You can make changes to this configuration to correspond to your environment. +* Configure your web server with the host root folder set to `/block-explorer/webroot` where `` is the absolute path to the configuration. Here is a sample nginx configuration. You can make changes to this configuration to correspond to your environment. ``` server { listen 80; @@ -68,7 +68,7 @@ Create claims found on the LBRY blockchain in the database. This requires the Py Get the current LBC price in USD and store the value in the `PriceHistory` table. This also caches the most recent price in Redis. #### forever.sh -Run the `forevermempool` script, and restart if necessary. The `forevermempool` script checks the LBRY blockchain mempool every second and creates transactions found in the database. The script makes use of Redis for caching the pending transation IDs. +Run the `forevermempool` script, and restart if necessary. The `forevermempool` script checks the LBRY blockchain mempool every second and creates transactions found in the database. The script makes use of Redis for caching the pending transaction IDs. ## Usage diff --git a/webroot/amcharts/plugins/animate/README.md b/webroot/amcharts/plugins/animate/README.md index 50ebf2f..869043e 100644 --- a/webroot/amcharts/plugins/animate/README.md +++ b/webroot/amcharts/plugins/animate/README.md @@ -5,7 +5,7 @@ Version: 1.1.2 ## Description -Smoothly animates the `dataProvider` +Smoothly animates the `dataProvider`. It works with serial, pie, XY, funnel, and radar. @@ -96,13 +96,13 @@ http://www.apache.org/licenses/LICENSE-2.0 ## Changelog ### 1.1.2 -* Fixing a bug with the minimum/maximum +* Fixing a bug with the minimum/maximum. ### 1.1.1 -* It now automatically sets the minimum/maximum on the value axes while animating +* It now automatically sets the minimum/maximum on the value axes while animating. ### 1.1.0 -* Adding in support for XY charts +* Adding in support for XY charts. ### 1.0.0 -* Initial release +* Initial release. diff --git a/webroot/amcharts/plugins/dataloader/readme.md b/webroot/amcharts/plugins/dataloader/readme.md index 48c3919..4431de6 100644 --- a/webroot/amcharts/plugins/dataloader/readme.md +++ b/webroot/amcharts/plugins/dataloader/readme.md @@ -5,28 +5,28 @@ Version: 1.0.16 ## Description -By default all amCharts libraries accept data in JSON format. It needs to be +By default, all amCharts libraries accept data in JSON format. It needs to be there when the web page loads, defined in-line or loaded via custom code. -This plugin introduces are native wrapper that enables automatic loading of data -from external data data sources in CSV and JSON formats. +This plugin introduces our native wrapper that enables automatic loading of data +from external data sources in CSV and JSON formats. -Most of the times you will just need to provide a URL of the external data +Most of the time, you will just need to provide a URL of the external data source - static file or dynamically generated - and it will do the rest. ## Important notice -Due to security measures implemented in most of the browsers, the external data -loader will work only when the page with the chart or map is loaded via web +Due to security measures implemented in most of the browsers, the external data +loader will work only when the page with the chart or map is loaded via web server. So, any of the examples loaded locally (file:///) will not work. The page needs to be loaded via web server (http://) in order to work properly. -Loading data from another domain than the web page is loaded is possible but is -a subject for `Access-Control-Allow-Origin` policies defined by the web server +Loading data from another domain than the web page is loaded is possible, but is +a subject for `Access-Control-Allow-Origin` policies defined by the web server you are loading data from. For more about loading data across domains use the following thread: @@ -75,10 +75,10 @@ AmCharts.makeChart( "chartdiv", { } ); ``` -That's it. The plugin will make sure the files are loaded and dataProvider is +That's it. The plugin will make sure the files are loaded and dataProvider is populated with their content *before* the chart is built. -Some formats, like CSV, will require additional parameters needed to parse the +Some formats like CSV, will require additional parameters needed to parse the data, such as "separator". If the "format" is omitted, the plugin will assume JSON. @@ -104,33 +104,33 @@ chart["dataLoader"] = { Property | Default | Description -------- | ------- | ----------- -async | true | If set to false (not recommended) everything will wait until data is fully loaded -complete | | Callback function to execute when loader is done -delimiter | , | [CSV only] a delimiter for columns (use \t for tab delimiters) -emptyAs | undefined | [CSV only] replace empty columns with whatever is set here -error | | Callback function to execute if file load fails -init | | Callback function to execute when Data Loader is initialized, before any loading starts -format | json | Type of data: json, csv -headers | | An array of objects with two properties (key and value) to attach to HTTP request -load | | Callback function to execute when file is successfully loaded (might be invoked multiple times) -noStyles | false | If set to true no styles will be applied to "Data loading" curtain -numberFields | | [CSV only] An array of fields in data to treat as numbers -postProcess | | If set to function reference, that function will be called to "post-process" loaded data before passing it on to chart. The handler function will receive two parameters: loaded data, Data Loader options +async | true | If set to false (not recommended), everything will wait until data is fully loaded. +complete | | Callback function to execute when loader is done. +delimiter | , | [CSV only] a delimiter for columns (use \t for tab delimiters). +emptyAs | undefined | [CSV only] replace empty columns with whatever is set here. +error | | Callback function to execute if file load fails. +init | | Callback function to execute when Data Loader is initialized, before any loading starts. +format | json | Type of data: json, csv. +headers | | An array of objects with two properties (key and value) to attach to HTTP request. +load | | Callback function to execute when file is successfully loaded (might be invoked multiple times). +noStyles | false | If set to true, no styles will be applied to "Data loading" curtain. +numberFields | | [CSV only] An array of fields in data to treat as numbers. +postProcess | | If set to function reference, that function will be called to "post-process" loaded data before passing it on to chart. The handler function will receive two parameters: loaded data, Data Loader options. progress | | Set this to function reference to track progress of the load. The function will be passed in three parameters: global progress, individual file progress, file URL. -showErrors | true | Show loading errors in a chart curtain -showCurtain | true| Show curtain over the chart area when loading data -reload | 0 | Reload data every X seconds -reverse | false | [CSV only] add data points in revers order -skip | 0 | [CSV only] skip X first rows in data (includes first row if useColumnNames is used) -skipEmpty | true | [CSV only] Ignore empty lines in data -timestamp | false | Add current timestamp to data URLs (to avoid caching) -useColumnNames | false | [CSV only] Use first row in data as column names when parsing +showErrors | true | Show loading errors in a chart curtain. +showCurtain | true| Show curtain over the chart area when loading data. +reload | 0 | Reload data every X seconds. +reverse | false | [CSV only] add data points in revers order. +skip | 0 | [CSV only] skip X first rows in data (includes first row if useColumnNames is used). +skipEmpty | true | [CSV only] Ignore empty lines in data. +timestamp | false | Add current timestamp to data URLs (to avoid caching). +useColumnNames | false | [CSV only] Use first row in data as column names when parsing. ## Using in JavaScript Stock Chart -In JavaScript Stock Chart it works exactly the same as in other chart types, -with the exception that `dataLoader` is set as a property to the data set +In JavaScript Stock Chart, it works exactly the same as in other chart types, +with the exception that `dataLoader` is set as a property to the data set definition. I.e.: ``` @@ -174,7 +174,7 @@ var chart = AmCharts.makeChart("chartdiv", { ### Can I also load event data the same way? -Sure. You just add a `eventDataLoader` object to your data set. All the same +Sure. You just add a `eventDataLoader` object to your data set. All the same settings apply. @@ -251,9 +251,9 @@ The three available functions are as follows: Function | Parameters | Description -------- | ---------- | ----------- -AmCharts.loadFile() | url, options, callback | Loads the file and passes it into callback function (unparsed) -AmCharts.parseCSV() | data, options | Parses data in string CSV format and returns JavaScript Array -AmCharts.parseJSON() | data | Parses data in string JSON format and returns JavaScript Array +AmCharts.loadFile() | url, options, callback | Loads the file and passes it into callback function (unparsed). +AmCharts.parseCSV() | data, options | Parses data in string CSV format and returns JavaScript Array. +AmCharts.parseJSON() | data | Parses data in string JSON format and returns JavaScript Array. The options passed into standalone functions are the same as discussed in [Complete list of available dataLoader settings](#complete-list-of-available-dataloader-settings) chapter. @@ -280,16 +280,16 @@ AmCharts.loadFile(dataset_url, {}, function(data) { ## Translating into other languages -Depending on configuration options the plugin will display a small number of +Depending on configuration options, the plugin will display a small number of text prompts, like 'Data loading...'. -Plugin will try matching chart's `language` property and display text prompts in +Plugin will try matching chart's `language` property and display text prompts in a corresponding language. For that the plugin needs to have the translations. -Some of the plugin translations are in **lang** subdirectory. Simply include the +Some of the plugin translations are in **lang** subdirectory. Simply include the one you need. -If there is no translation to your language readily available, just grab en.js, +If there is no translation to your language readily available, just grab en.js, copy it and translate. The structure is simple: @@ -302,7 +302,7 @@ The phrase in English must be left intact. When you're done, you can include your language as a JavaScript file. -P.S. send us your translation so we can include it for the benefits of other +P.S. send us your translation so we can include it for the benefits of other users. Thanks! @@ -354,72 +354,72 @@ http://www.apache.org/licenses/LICENSE-2.0 ## Changelog ### 1.0.16 -* Added "numberFields" config array +* Added "numberFields" config array. ### 1.0.15 -* Added "emptyAs" config property. Empty CSV values will be set to this (default `undefined`) +* Added "emptyAs" config property. Empty CSV values will be set to this (default `undefined`). ### 1.0.14 -* Added "init" event handler, which is called **before** loading starts +* Added "init" event handler, which is called **before** loading starts. ### 1.0.13 -* Added "progress" handler, which can be used to monitor data load progress +* Added "progress" handler, which can be used to monitor data load progress. ### 1.0.12 -* Better default options handling in external calls to AmCharts.loadFile -* Fixed the latest version of Stock Chart not resetting to default pre-defined period -* New example: Using Data Loader functions externally (map_json_external_function.html) +* Better default options handling in external calls to AmCharts.loadFile. +* Fixed the latest version of Stock Chart not resetting to default pre-defined period. +* New example: Using Data Loader functions externally (map_json_external_function.html). ### 1.0.11 * New translation: Added French translation. Thanks Remy! -* Tweaks to allow better animation after data load on Pie chart +* Tweaks to allow better animation after data load on Pie chart. ### 1.0.10 -* Fixed error related to headers not being set when using standalone data load functions +* Fixed error related to headers not being set when using standalone data load functions. ### 1.0.9 -* Plugin will now ignore empty CSV lines by default (configurable with `skipEmpty` property) +* Plugin will now ignore empty CSV lines by default (configurable with `skipEmpty` property). ### 1.0.8 -* Added `headers` config variable which allows adding custom headers to HTTP requests +* Added `headers` config variable which allows adding custom headers to HTTP requests. ### 1.0.7 -* Fixed an issue with the Pie chart when it is being loaded in inactive tab +* Fixed an issue with the Pie chart when it is being loaded in inactive tab. ### 1.0.6 -* Added support for Gauge chart (loads `arrows` array) +* Added support for Gauge chart (loads `arrows` array). ### 1.0.5 -* Fixed JS error if periodSelector was not defined in chart config -* Now all callback functions (complete, error, load) receive additional parameter: chart -* postProcess function will now have "this" context set to Data Loader object as well as receive chart reference as third paramater +* Fixed JS error if periodSelector was not defined in chart config. +* Now all callback functions (complete, error, load) receive additional parameter: chart. +* postProcess function will now have "this" context set to Data Loader object as well as receive chart reference as third parameter. ### 1.0.4 -* Added `chart.dataLoader.loadData()` function which can be used to manually trigger all data reload +* Added `chart.dataLoader.loadData()` function which can be used to manually trigger all data reload. ### 1.0.3 -* Fixed the bug where defaults were not being applied properly -* Fixed the bug with translations not being applied properly -* Cleaned up the code (to pass JSHint validation) +* Fixed the bug where defaults were not being applied properly. +* Fixed the bug with translations not being applied properly. +* Cleaned up the code (to pass JSHint validation). ### 1.0.2 -* Fixed the issue with modified Array prototypes +* Fixed the issue with modified Array prototypes. ### 1.0.1 -* Added `complete`, `load` and `error` properties that can be set with function handlers to be invoked on load completion, successful file load or failed load respectively -* Fixed language container initialization bug -* Fixed bug that was causing parse errors not be displayed +* Added `complete`, `load` and `error` properties that can be set with function handlers to be invoked on load completion, successful file load or failed load respectively. +* Fixed language container initialization bug. +* Fixed bug that was causing parse errors not be displayed. ### 1.0 -* Added GANTT chart support +* Added GANTT chart support. ### 0.9.2 -* Added global data load methods that can be used to load and parse data by code outside plugin -* Trim CSV column names -* Translation added: Lithuanian +* Added global data load methods that can be used to load and parse data by code outside plugin. +* Trim CSV column names. +* Translation added: Lithuanian. ### 0.9.1 -* Fix chart animations not playing after asynchronous load +* Fix chart animations not playing after asynchronous load. ### 0.9 -* Initial release \ No newline at end of file +* Initial release. diff --git a/webroot/amcharts/plugins/export/README.md b/webroot/amcharts/plugins/export/README.md index b5cdc53..6ed6a93 100644 --- a/webroot/amcharts/plugins/export/README.md +++ b/webroot/amcharts/plugins/export/README.md @@ -77,7 +77,7 @@ AmCharts.makeChart( "chartdiv", { ## Loading external libraries needed for operation of this plugin -The plugin relies on a number of different libraries, to export images, draw +The plugin relies on a number of different libraries to export images, draw annotations or generate download files. Those libraries need to be loaded for the plugin to work properly. @@ -86,15 +86,15 @@ There are two ways to load them. Choose the one that is right: ### 1) Automatic (preferred) -All libraries required for plugin operation are included withing plugins */libs* +All libraries required for plugin operation are included within plugins */libs* subdirectory. -The plugin will automatically try to look in chart's [`path`](http://docs.amcharts.com/3/javascriptcharts/AmSerialChart#path) +The plugin will automatically try to look in the chart's [`path`](http://docs.amcharts.com/3/javascriptcharts/AmSerialChart#path) property. If your plugin files are located within plugins folder under amcharts (as is the case with the default distributions), you don't need to do anything - the libraries will load on-demand. -If you are using relative url, note that it is relative to the web page you are +If you are using relative URL, note that it is relative to the web page you are displaying your chart on, not the export.js library. In case you've moved the libs folder you need to tell the plugin where it is @@ -122,41 +122,41 @@ xlsx.js | libs/xlsx/ | Export to XLSX format Property | Default | Description -------- | ------- | ----------- -backgroundColor | #FFFFFF | RGB code of the color for the background of the exported image -enabled | true | Enables or disables export functionality +backgroundColor | #FFFFFF | RGB code of the color for the background of the exported image. +enabled | true | Enables or disables export functionality. divId | | ID or a reference to div object in case you want the menu in a separate container. -fabric | {} | Overwrites the default drawing settings (fabricJS library) -fallback | {} | Holds the messages to guide the user to copy the generated output; `false` will disable the fallback feature -fileName | amCharts | A file name to use for generated export files (an extension will be appended to it based on the export format) -legend | {} | Places the legend in case it is within an external container ([skip to chapter](#adding-external-legend)) -libs | | 3rd party required library settings (see the above section) -menu | [] | A list of menu or submenu items (see the next chapter for details) -pdfMake | {} | Overwrites the default settings for PDF export (pdfMake library) -position | top-right | A position of export icon. Possible values: "top-left", "top-right" (default), "bottom-left", "bottom-right" -removeImages | true | If true export checks for and removes "tainted" images that area lodead from different domains -delay | | General setting to delay the capturing of the chart ([skip to chapter](#delay-the-capturing-before-export)) -exportFields | [] | If set, only fields in this array will be exported ( data export only ) -exportTitles | false | Exchanges the data field names with it's dedicated title ( data export only ) +fabric | {} | Overwrites the default drawing settings (fabricJS library). +fallback | {} | Holds the messages to guide the user to copy the generated output; `false` will disable the fallback feature. +fileName | amCharts | A file name to use for generated export files (an extension will be appended to it based on the export format). +legend | {} | Places the legend in case it is within an external container ([skip to chapter](#adding-external-legend)). +libs | | 3rd party required library settings (see the above section). +menu | [] | A list of menu or submenu items (see the next chapter for details). +pdfMake | {} | Overwrites the default settings for PDF export (pdfMake library). +position | top-right | A position of export icon. Possible values: "top-left", "top-right" (default), "bottom-left", "bottom-right". +removeImages | true | If true, export checks for and removes "tainted" images that area loaded from different domains. +delay | | General setting to delay the capturing of the chart ([skip to chapter](#delay-the-capturing-before-export)). +exportFields | [] | If set, only fields in this array will be exported (data export only). +exportTitles | false | Exchanges the data field names with its dedicated title (data export only). columnNames | {} | An object of key/value pairs to use as column names when exporting to data formats. `exportTitles` needs to be set for this to work as well. -exportSelection | false | Exports the current data selection only ( data export only ) -dataDateFormat | | Format to convert date strings to date objects, uses by default charts dataDateFormat ( data export only ) -dateFormat | YYYY-MM-DD | Formats the category field in given date format ( data export only ) -keyListener | false | If true it observes the pressed keys to undo/redo the annotations -fileListener | false | If true it observes the drag and drop feature and loads the dropped image file into the annotation -drawing | {} | Object which holds all possible settings for the annotation mode ([skip to chapter](#annotation-settings)) -overflow | true | Flag to overwrite the css attribute 'overflow' of the chart container to avoid cropping the menu on small container -border | {} | An object of key/value pairs to define the overlaying border -processData | | A function which can be used to change the dataProvider when exporting to CSV, XLSX, or JSON -pageOrigin | true | A flag to show / hide the origin of the generated PDF ( pdf export only ) -forceRemoveImages | false | If true export removes all images +exportSelection | false | Exports the current data selection only ( data export only ). +dataDateFormat | | Format to convert date strings to date objects, uses by default charts dataDateFormat (data export only). +dateFormat | YYYY-MM-DD | Formats the category field in given date format (data export only). +keyListener | false | If true, it observes the pressed keys to undo/redo the annotations. +fileListener | false | If true, it observes the drag and drop feature and loads the dropped image file into the annotation. +drawing | {} | Object which holds all possible settings for the annotation mode ([skip to chapter](#annotation-settings)). +overflow | true | Flag to overwrite the CSS attribute 'overflow' of the chart container to avoid cropping the menu on small container. +border | {} | An object of key/value pairs to define the overlaying border. +processData | | A function which can be used to change the dataProvider when exporting to CSV, XLSX, or JSON. +pageOrigin | true | A flag to show/hide the origin of the generated PDF (pdf export only). +forceRemoveImages | false | If true, export removes all images. debug | false | A flag which enables the plugin to write console logs (currently used by the dependency handler only). ## Configuring export menu Plugin includes a way to completely control what is displayed on export menu. -You can set up menus, sub-menus, down to any level. You can even add custom -items there that execute your arbitrary code on click. It's so configurable +You can set up menus and sub-menus down to any level. You can even add custom +items there that execute your arbitrary code on click. It's so configurable, it makes us sick with power ;) The top-level menu is configured via `menu` property under `export`. It should @@ -189,15 +189,15 @@ icon: * JPG * CSV -When clicked the plugin will trigger export to a respective format. +When clicked, the plugin will trigger export to a respective format. -If that is all you need, you're all set. +If that is all you need, then you're all set. -Please note that we have wrapped out menu into another menu item, so that only -the icon is displayed until we roll over the icon. This means that technically +Please note that we have wrapped our menu into another menu item, so that only +the icon is displayed until we roll over the icon. This means that technically, we have a two-level hierarchical menu. -If we opmitted that first step, the chart would simply display a format list +If we omitted that first step, the chart would simply display a format list right there on the chart. ### Advanced menu setup @@ -273,7 +273,7 @@ This needs to be a function reference. I.e.: ### Adding external legend In case you have an external legend you need to define the position where it should get placed in your export. -By default it obtains the dimensions from the container but you can optionally overwrite those settings as shown below. +By default, it obtains the dimensions from the container, but you can optionally overwrite those settings as shown below. ``` "export": { @@ -299,7 +299,7 @@ If you want to change the dataProvider when exporting to CSV, XLSX, or JSON, you ### Adding overlaying border -In case you need a more visible separation of your chart for further processing you can add an overlaying border. +In case you need a more visible separation of your chart for further processing, you can add an overlaying border. ``` "export": { @@ -313,8 +313,8 @@ In case you need a more visible separation of your chart for further processing ### Menu item reviver -By passing the `menuReviver` callback function you can modify the resulting menu -item or relative container, before it gets appended to the list (`ul`). The +By passing the `menuReviver` callback function, you can modify the resulting menu +item or relative container before it gets appended to the list (`ul`). The function takes two arguments and it needs to return a valid DOM element. ``` @@ -328,7 +328,7 @@ function takes two arguments and it needs to return a valid DOM element. #### Format specific options that you can override using Menu item reviver -Some formats, such as CSV, have specific parameters that are used when exporting to this format. For example, default column separator for CSV is a comma. But what if you would like to be that a tab? You could use `menuReviver` for that like this: +Some formats such as CSV, have specific parameters that are used when exporting to this format. For example, default column separator for CSV is a comma. But what if you would like to be that a tab? You could use `menuReviver` for that like this: ``` "export": { @@ -348,45 +348,45 @@ Below you will find a list of parameters that you can override for each format: Property | Default | Available values | Description --------- | ------- | ---------------- | ----------- -quality |1 | 0-1 | A quality of the resulting JPG image -multiplier | 1 | number | Set this to non-1 number to resize the resulting image by +quality |1 | 0-1 | A quality of the resulting JPG image. +multiplier | 1 | number | Set this to a non-1 number to resize the resulting image by. **PNG** Property | Default | Available values | Description --------- | ------- | ---------------- | ----------- -quality | 1 | 0-1 | A quality of the resulting JPG image -multiplier | 1 | number | Set this to non-1 number to resize the resulting image by +quality | 1 | 0-1 | A quality of the resulting JPG image. +multiplier | 1 | number | Set this to a non-1 number to resize the resulting image by. **PDF** Property | Default | Available values | Description --------- | ------- | ---------------- | ----------- -multiplier | 2 | number | Set this to non-1 number to resize the resulting image by +multiplier | 2 | number | Set this to a non-1 number to resize the resulting image by. **PRINT** Property | Default | Available values | Description --------- | ------- | ---------------- | ----------- -delay | 1 | number | Delay by number of seconds before triggering print -lossless | false | true/false | Enable or disable image optimization when printing +delay | 1 | number | Delay by number of seconds before triggering print. +lossless | false | true/false | Enable or disable image optimization when printing. **CSV** Property | Default | Available values | Description --------- | ------- | ---------------- | ----------- -delimiter | "," | string | A string to use as a column delimiter -quotes | true | true/false | Set whether to enclose strings in doublequotes -escape | true | true/false | Set whether to escape strings -withHeader | true | true/false | Add header row with column names +delimiter | "," | string | A string to use as a column delimiter. +quotes | true | true/false | Set whether to enclose strings in doublequotes. +escape | true | true/false | Set whether to escape strings. +withHeader | true | true/false | Add header row with column names. **XLSX** Property | Default | Available values | Description --------- | ------- | ---------------- | ----------- -dateFormat | "dateObject" | "dateObject"\|"string" | Whether to export dates as dates recognisable by Excel or formatted as strings -withHeader | true | true/false | Add header row with column names -stringify | false | true/false | Convert all cell content to strings +dateFormat | "dateObject" | "dateObject"\|"string" | Whether to export dates as dates recognizable by Excel, or formatted as strings. +withHeader | true | true/false | Add header row with column names. +stringify | false | true/false | Convert all cell content to strings. ### Menu walker @@ -436,7 +436,7 @@ Or if you want to change the label: OK, this one is so cool, you'll need a class 700 insulation jacket. -By default each menu item triggers some kind of export. You can trigger an +By default, each menu item triggers some kind of export. You can trigger an "annotation" mode instead by including `"action": "draw"` instead. ``` @@ -458,7 +458,7 @@ Now, when you click on the "Annotate" item in the menu, the chart will turn into an image editor which you can actual draw on and the menu gets replaced by the default annotation menu. -If you don't like the detault annotation menu, you can define your own: +If you don't like the default annotation menu, you can define your own: ``` "export": { @@ -480,7 +480,7 @@ If you don't like the detault annotation menu, you can define your own: ``` Now, when you turn on the annotation mode, your own submenu will display, -allowing to export the image into either PNG, JPG, SVG or PDF. +allowing you to export the image into either PNG, JPG, SVG or PDF. And that's not even the end of it. You can add menu items to cancel, undo, redo and still be able to reuse the choices by using the actions `draw.modes`, @@ -517,7 +517,7 @@ and still be able to reuse the choices by using the actions `draw.modes`, ### Annotation settings -Since 1.2.1 it's also possible to set some of the annotation options without the +Since 1.2.1, it's also possible to set some of the annotation options without the need to re-define the whole menu structure. You can easily adjust the choice of modes, colors, widths or shapes, and set the defaults when entering the annotation mode. @@ -569,8 +569,8 @@ the following: ### Delay the capturing before export -In some cases you may want to delay the capturing of the current chart snapshot -to highlight the current value. For this you can simply define the 'delay' +In some cases, you may want to delay the capturing of the current chart snapshot +to highlight the current value. For this, you can simply define the 'delay' property in your menu item: ``` @@ -589,7 +589,7 @@ property in your menu item: ### Events -Since version 1.1.7 the plugin introduces some events you can use. For example +Since version 1.1.7, the plugin introduces some events you can use. For example, the `afterCapture` event allows you to add some texts or images which can't be seen on the regular chart but only the generated export. Use it to watermark your exported images. @@ -623,7 +623,7 @@ your exported images. }], ``` -Since version 1.4.29 we have added the `onReady` callback to get your stuff done +Since version 1.4.29, we have added the `onReady` callback to get your stuff done right after the plugin or specific dependency is ready to use. Ensure to check the `timedout` flag to be sure the dependency got fully loaded. @@ -653,42 +653,42 @@ right after the plugin or specific dependency is ready to use. Ensure to check t Name | Arguments | Description ---- | --------- | ----------- -beforeCapture | [menu item setup](#a-list-of-menu-item-properties) | Called before the SVG element gets converted -afterCapture | [menu item setup](#a-list-of-menu-item-properties) | Called right before the passed callback of the capture method +beforeCapture | [menu item setup](#a-list-of-menu-item-properties) | Called before the SVG element gets converted. +afterCapture | [menu item setup](#a-list-of-menu-item-properties) | Called right before the passed callback of the capture method. ### A list of menu item properties Property | Description -------- | ----------- -action | Set to "draw" if you want the item to trigger annotation mode -class | Class name applied to the tag -click | Function handler invoked upon click on menu item -format | A format to export chart/map to upon click (see below for a list of available formats) -icon | Icon file (will use chart's [path](http://docs.amcharts.com/3/javascriptcharts/AmSerialChart#path) if the URL is not full) -label | Text label to be displayed -menu | An array of submenu items -title | A title attribute of the link -backgroundColor | The background color of the canvas -fileName | A file name to use for generated export files (an extension will be appended to it based on the export format) -extension | File extension for the generated export file (uses format default if not defined) -mimeType | Internet media type to generate the export file (usses format default if not defined) -pageSize | A string or { width: number, height: number } ([details](#exporting-to-pdf)) -pageOrientation | By default we use portrait, you can change it to landscape if you wish ([details](#exporting-to-pdf)) -pageMargins | [left, top, right, bottom] or [horizontal, vertical] or just a number for equal margins ([details](#exporting-to-pdf)) -content | Array of elements which represents the content ([details](#exporting-to-pdf)) -multiplier | Scale factor for the generated image -lossless | Flag to print the actual vector graphic instead of buffered bitmap (print option only, experimental) -delay | A numeric value to delay the capturing in seconds ([details](#delay-the-capturing-before-export)) -exportFields | [] | If set, only fields in this array will be exported ( data export only ) -exportTitles | Exchanges the data field names with it's dedicated title ( data export only ) -columnNames | An object of key/value pairs to use as column names when exporting ( data export only ) -exportSelection | Exports the current data selection only ( data export only ) -dataDateFormat | Format to convert date strings to date objects, uses by default charts dataDateFormat ( data export only ) -dateFormat | Formats the category field in given date format ( data export only ) -border | An object of key/value pairs to define the overlaying border -pageOrigin | A flag to show / hide the origin of the generated PDF ( pdf export only ) -compress | A flag to compress the generated output ( svg only ) +action | Set to "draw" if you want the item to trigger annotation mode. +class | Class name applied to the tag. +click | Function handler invoked upon click on menu item. +format | A format to export chart/map to upon click (see below for a list of available formats). +icon | Icon file (will use chart's [path](http://docs.amcharts.com/3/javascriptcharts/AmSerialChart#path) if the URL is not full). +label | Text label to be displayed. +menu | An array of submenu items. +title | A title attribute of the link. +backgroundColor | The background color of the canvas. +fileName | A file name to use for generated export files (an extension will be appended to it based on the export format). +extension | File extension for the generated export file (uses format default if not defined). +mimeType | Internet media type to generate the export file (uses format default if not defined). +pageSize | A string or { width: number, height: number } ([details](#exporting-to-pdf)). +pageOrientation | By default we use portrait. You can change it to landscape if you wish ([details](#exporting-to-pdf)). +pageMargins | [left, top, right, bottom] or [horizontal, vertical] or just a number for equal margins ([details](#exporting-to-pdf)). +content | Array of elements which represents the content ([details](#exporting-to-pdf)). +multiplier | Scale factor for the generated image. +lossless | Flag to print the actual vector graphic instead of buffered bitmap (print option only, experimental). +delay | A numeric value to delay the capturing in seconds ([details](#delay-the-capturing-before-export)). +exportFields | [] | If set, only fields in this array will be exported (data export only). +exportTitles | Exchanges the data field names with its dedicated title (data export only). +columnNames | An object of key/value pairs to use as column names when exporting (data export only). +exportSelection | Exports the current data selection only (data export only). +dataDateFormat | Format to convert date strings to date objects, uses by default charts dataDateFormat (data export only). +dateFormat | Formats the category field in given date format (data export only). +border | An object of key/value pairs to define the overlaying border. +pageOrigin | A flag to show/hide the origin of the generated PDF (pdf export only). +compress | A flag to compress the generated output (svg only). Available `format` values: @@ -716,7 +716,7 @@ a function that returns a string. To include exported image, use `image: "reference"`. -Additionally, you can add `fit` property which is an array of pixel dimensions, +Additionally, you can add `fit` property, which is an array of pixel dimensions you want the image to be scaled to fit into. Here's an example of such export menu item: @@ -733,10 +733,10 @@ Here's an example of such export menu item: Property | Description -------- | ----------- -pageSize | a string or { width: number, height: number } -pageOrientation | by default we use portrait, you can change it to landscape if you wish -pageMargins | [left, top, right, bottom] or [horizontal, vertical] or just a number for equal margins -content | array of elements which represents the content ([full description](https://github.com/bpampuch/pdfmake/)) +pageSize | A string or {width: number, height: number}. +pageOrientation | By default, we use portrait. You can change it to landscape if you wish. +pageMargins | [left, top, right, bottom] or [horizontal, vertical] or just a number for equal margins. +content | Array of elements which represents the content ([full description](https://github.com/bpampuch/pdfmake/)). Pagesize | Dimensions in pixel -------- | ----------- @@ -796,7 +796,7 @@ TABLOID | [792.00, 1224.00] The plugin comes with a default CSS file `export.css`. You just need to include it on your page. -Feel free to override any styles defined in it, create your own version and +Feel free to override any styles defined in it. Create your own version and modify as you see fit. If you choose to modify it, we suggest creating a copy so it does not get @@ -808,7 +808,7 @@ overwritten when you update amCharts or plugin. We explained how you can define custom functions to be executed on click on export menu items. -Those functions can tap into plugin's methods to augment it with some custom +Those functions can tap into a plugin's methods to augment it with some custom functionality. Here's an example: @@ -838,29 +838,29 @@ Here's a full list of API functions available for your consumption: Function | Parameters | Description -------- | ---------- | ----------- -toJPG | (object) options, (function) callback | Prepares a JPEG representation of the chart and passes the binary data to the callback function -toPNG | (object) options, (function) callback | Prepares a PNG representation of the chart and passes the binary data to the callback function -toSVG | (object) options, (function) callback | Prepares a SVG representation of the chart and passes the binary data to the callback function -toPDF | (object) options, (function) callback | Prepares a PDF representation of the chart and passes the binary data to the callback function -toJSON | (object) options, (function) callback | Prepares a JSON and passes the plain data to the callback function -toCSV | (object) options, (function) callback | Prepares a CSV and passes the plain data to the callback function -toXLSX | (object) options, (function) callback | Prepares a XLSX representation of the chart and passes the binary data to the callback function -toBlob | (object) options, (function) callback | Prepares a BLOB and passes the instance to the callback function -toCanvas | (object) options, (function) callback | Prepares a Canvas and passes the element to the callback function -toArray | (object) options, (function) callback | Prepares an Array and passes the data to the callback function -toImage | (object) options, (function) callback | Generates an image element which holds the output in an embedded base64 data url +toJPG | (object) options, (function) callback | Prepares a JPEG representation of the chart and passes the binary data to the callback function. +toPNG | (object) options, (function) callback | Prepares a PNG representation of the chart and passes the binary data to the callback function. +toSVG | (object) options, (function) callback | Prepares a SVG representation of the chart and passes the binary data to the callback function. +toPDF | (object) options, (function) callback | Prepares a PDF representation of the chart and passes the binary data to the callback function. +toJSON | (object) options, (function) callback | Prepares a JSON and passes the plain data to the callback function. +toCSV | (object) options, (function) callback | Prepares a CSV and passes the plain data to the callback function. +toXLSX | (object) options, (function) callback | Prepares a XLSX representation of the chart and passes the binary data to the callback function. +toBlob | (object) options, (function) callback | Prepares a BLOB and passes the instance to the callback function. +toCanvas | (object) options, (function) callback | Prepares a Canvas and passes the element to the callback function. +toArray | (object) options, (function) callback | Prepares an Array and passes the data to the callback function. +toImage | (object) options, (function) callback | Generates an image element which holds the output in an embedded base64 data URL. ## Annotation API -Since version 1.4.27 we've introduced the functionality to manage the annotations on the fly. The setter returns an array of objects, where each element represents an annotation. -On the other hand the setter processes the given annotations within options (options.data). Both methods support the reviver callback which allows you to modify the annotations if needed. +Since version 1.4.27, we've introduced the functionality to manage the annotations on the fly. The setter returns an array of objects, where each element represents an annotation. +On the other hand, the setter processes the given annotations within options (options.data). Both methods support the reviver callback which allows you to modify the annotations if needed. Function | Parameters | Description -------- | ---------- | ----------- getAnnotations | (object) options, (function) callback | Returns an array of objects where each element represents an annotation. setAnnotations | (object) options, (function) callback | Draws the given annotations (options.data). -Here's an example how to insert annotations, please ensure your chart is in annotation mode: +Here's an example how to insert annotations. Please ensure your chart is in annotation mode: ``` chart.export.setAnnotations({ @@ -880,7 +880,7 @@ chart.export.setAnnotations({ },function() { - // Callback when finished + // Callback when finished }); ``` @@ -897,7 +897,7 @@ you may need to add following metatag in your `` of your HTML document. ``` -This feature will kick in by default. If you want to disable it simply pass +This feature will kick in by default. If you want to disable it, simply pass `false` to the `fallback` parameter. ``` @@ -906,7 +906,7 @@ This feature will kick in by default. If you want to disable it simply pass } ``` -In case you want to change our default messages you can modify it like +In case you want to change our default messages, you can modify it like the following. ``` @@ -942,7 +942,7 @@ They're all in subdirectory /examples. You're encouraged to modify, extend and make derivative plugins out of this plugin. -You can modify files, included in this archive or, better yet, fork this project +You can modify files included in this archive, or better yet, fork this project on GitHub: https://github.com/amcharts/export @@ -958,7 +958,7 @@ This plugin is licensed under Apache License 2.0. This basically means you're free to use or modify this plugin, even make your own versions or completely different products out of it. -Please see attached file "license.txt" for the complete license or online here: +Please see attached file "license.txt" for the complete license, or online here: http://www.apache.org/licenses/LICENSE-2.0 @@ -977,49 +977,49 @@ http://www.apache.org/licenses/LICENSE-2.0 * Fixed: Menu active state on mouseleave. ### 1.4.65 -* Fixed: Menu active state issue, menu kept its active when it hasn't been rerendered. +* Fixed: Menu active state issue, menu kept its active when it hasn't been re-rendered. ### 1.4.64 -* Fixed: classList issue on IE11 +* Fixed: classList issue on IE11. ### 1.4.63 -* Fixed: Clip-path issue on graph lines +* Fixed: Clip-path issue on graph lines. ### 1.4.62 -* Fixed: Gantt category issue +* Fixed: Gantt category issue.. ### 1.4.61 -* Fixed: SmoothCustomBullet plugin support, clip-path issue on curved corners +* Fixed: SmoothCustomBullet plugin support, clip-path issue on curved corners. ### 1.4.60 -* Fixed: Empty print output in chrome version 57 +* Fixed: Empty print output in chrome version 57. ### 1.4.59 -* Fixed: Issue with blurred element when closing annotation mode +* Fixed: Issue with blurred element when closing annotation mode. ### 1.4.58 -* Fixed: SVG clip-path export issue; injection control; wrap elements to support fill reference -* Fixed: Keyboard navigation disabled on touch devices +* Fixed: SVG clip-path export issue; injection control; wrap elements to support fill reference. +* Fixed: Keyboard navigation disabled on touch devices. ### 1.4.57 * Added: Support for keyboard navigation (tabs and arrow keys). -* Fixed: Merged pull request [#84](https://github.com/amcharts/export/pull/54) fixing an issue when "a" is undefined within deepMerge (thanks to [RahavLussato](https://github.com/RahavLussato) ) +* Fixed: Merged pull request [#84](https://github.com/amcharts/export/pull/54) fixing an issue when "a" is undefined within deepMerge (thanks to [RahavLussato](https://github.com/RahavLussato)). ### 1.4.56 * Added: Dependency handler on export methods, holds the actual call until the namespace shows up in current scope (uses libs.loadTimeout). ### 1.4.55 -* Added: Radial gradient issue on pie caused by the vertical gradient fix (v1.4.44) +* Added: Radial gradient issue on pie caused by the vertical gradient fix (v1.4.44). ### 1.4.54 -* Fixed: Default text size on width changes +* Fixed: Default text size on width changes. ### 1.4.53 -* Fixed: IOS print issue, captured the whole page instead of the single page +* Fixed: IOS print issue, captured the whole page instead of the single page. ### 1.4.52 -* Fixed: Blank export issue especifically in chrome on IOS devices. -* Updated: FileSaver.js due the chrome export issue on IOS +* Fixed: Blank export issue specifically in chrome on IOS devices. +* Updated: FileSaver.js due the chrome export issue on IOS. ### 1.4.51 * Fixed: Render issue on maps due half pixel position correction; simplified the positioning. @@ -1037,118 +1037,118 @@ http://www.apache.org/licenses/LICENSE-2.0 * Fixed: `afterCapture` issue which removed injected elements. ### 1.4.46 -* Fixed: toSVG clipPath issue which exported multiple times the same clipPath +* Fixed: toSVG clipPath issue which exported multiple times the same clipPath. ### 1.4.45 -* Fixed: Object selection issue on charts with heavy amount of datapoints -* Fixed: Line/Arrow drawing issue on vertical movement -* Changed: Pressing escape while an object has been selected will deselect first instead quiting the annotation mode +* Fixed: Object selection issue on charts with heavy amount of datapoints. +* Fixed: Line/Arrow drawing issue on vertical movement. +* Changed: Pressing escape while an object has been selected will deselect first instead quitting the annotation mode. ### 1.4.44 -* Fixed: Vertical gradient issue +* Fixed: Vertical gradient issue. ### 1.4.43 -* Fixed: Shown label in hidden valueAxis +* Fixed: Shown label in hidden valueAxis. ### 1.4.42 -* Fixed: `exportFields` issue in combination with `columnNames` or `exportTitles` -* Added: `dataFieldsTitlesMap` into `processData` context to be able to trace back the translated keys against the data fields +* Fixed: `exportFields` issue in combination with `columnNames` or `exportTitles`. +* Added: `dataFieldsTitlesMap` into `processData` context to be able to trace back the translated keys against the data fields. ### 1.4.41 -* Added: quote, escape option to `toArray` method -* Fixed: toArray method to respect `exportFields` order -* Fixed: toCSV, toXLSX to respect `exportFields` order +* Added: quote, escape option to `toArray` method. +* Fixed: toArray method to respect `exportFields` order. +* Fixed: toCSV, toXLSX to respect `exportFields` order. ### 1.4.40 * Fixed: Infinite loop in Angular2 Zones -* Fixed: `compress` option being obtained from the global config +* Fixed: `compress` option being obtained from the global config. ### 1.4.39 * Added: New menu option `compress` to compress the generated output (svg only). * Fixed: Strikethrough issue in SVG output. ### 1.4.38 -* Fixed: Support for external stock chart legends, overlapping issue with free licensed version of amcharts +* Fixed: Support for external stock chart legends, overlapping issue with free licensed version of amcharts. ### 1.4.37 -* Fixed: Gradient issue which left the chart elements hidden after the export process -* Fixed: Typo in examples dropdown -* Added: Support for external stock chart legends +* Fixed: Gradient issue which left the chart elements hidden after the export process. +* Fixed: Typo in examples dropdown. +* Added: Support for external stock chart legends. ### 1.4.36 -* Fixed: exportFields order being considered -* Fixed: Keep scroll position after printing -* Fixed: Namespace key issue with minified resource versions +* Fixed: exportFields order being considered. +* Fixed: Keep scroll position after printing. +* Fixed: Namespace key issue with minified resource versions. ### 1.4.35 -* Fixed: Menu handling issue on touch devices, uses css classname to toggle menu items (updated CSS file, on devices only where the "Touch" object is within window scope) +* Fixed: Menu handling issue on touch devices, uses CSS classname to toggle menu items (updated CSS file, on devices only where the "Touch" object is within window scope). ### 1.4.34 -* Fixed: Data shifting issue in data exports with compared graphs (stock only) -* Fixed: Shallow copy of compared graphs in data exports (stock only) +* Fixed: Data shifting issue in data exports with compared graphs (stock only). +* Fixed: Shallow copy of compared graphs in data exports (stock only). ### 1.4.33 -* Fixed: fill/stroke polyfilling issue on svg elements with color validation/preparation for fabric +* Fixed: fill/stroke polyfilling issue on svg elements with color validation/preparation for fabric. ### 1.4.32 -* Fixed: Issue polyfilling the color attributes with "rgba" color codes +* Fixed: Issue polyfilling the color attributes with "rgba" color codes. ### 1.4.31 -* Changed: Included independent IE detection to handle specific IE10, IE11 svg image in canvas issue +* Changed: Included independent IE detection to handle specific IE10, IE11 svg image in canvas issue. ### 1.4.30 -* Fixed: Pattern loading, positioning issue, supports x,y offset now +* Fixed: Pattern loading, positioning issue, supports x,y offset now. ### 1.4.29 -* Added: `libs.loadTimeout` dependency namespace timeout used within onReady handler -* Added: `fabric.loadTimeout` loading image timeout to avoid blocking the export process -* Added: [onReady](#events) ready callback handler to get notified when the export or specific dependency is ready to use -* Fixed: fill/stroke issue on SVG elements which caused a crash within the export process -* Fixed: Image loader which freezed occasionally and caused an unexpected behaviour +* Added: `libs.loadTimeout` dependency namespace timeout used within onReady handler. +* Added: `fabric.loadTimeout` loading image timeout to avoid blocking the export process. +* Added: [onReady](#events) ready callback handler to get notified when the export or specific dependency is ready to use. +* Fixed: fill/stroke issue on SVG elements which caused a crash within the export process. +* Fixed: Image loader which froze occasionally and caused an unexpected behaviour. ### 1.4.28 -* Fixed: Positioning / handling issue on multiline labels (injected modifed fabricJS snippet to handle it) -* Fixed: Cursor issue on regular exports which flashed the crosshair cursor for a moment +* Fixed: Positioning / handling issue on multiline labels (injected modified fabricJS snippet to handle it). +* Fixed: Cursor issue on regular exports which flashed the crosshair cursor for a moment. ### 1.4.27 * Added: [Annotations API](#annotations-api) to get or set annotations within drawing mode. ### 1.4.26 -* Fixed: IE10 SVG image handing issue, caused by an internal bug of IE10 (removes SVGs automatically to avoid triggering the security policy) +* Fixed: IE10 SVG image handing issue, caused by an internal bug of IE10 (removes SVGs automatically to avoid triggering the security policy). ### 1.4.25 -* Fixed: `export.config.advanced.js` sample config issue with drawing callbacks -* Fixed: `delay` property reset issue, did not get considered after first usage -* Fixed: `drawing.enabled` propery issue after first usage, stayed on true -* Changed: Updated fabric.js source to `1.6.2` -* Added: Advanced sample using the advanced config +* Fixed: `export.config.advanced.js` sample config issue with drawing callbacks. +* Fixed: `delay` property reset issue, did not get considered after first usage. +* Fixed: `drawing.enabled` property issue after first usage, stayed on true. +* Changed: Updated fabric.js source to `1.6.2`. +* Added: Advanced sample using the advanced config. ### 1.4.24 -* Fixed: Issue with external legends in maps -* Fixed: Resource dependency issue of xlsx with jszip -* Fixed: Issue with `forceRemoveImages` in local enviroment (includes all ":\" and "file://" sources) -* Changed: Resource loading order according to it's priority -* Changed: Loading minified resource versions by default to improve the payload significantly +* Fixed: Issue with external legends in maps. +* Fixed: Resource dependency issue of xlsx with jszip. +* Fixed: Issue with `forceRemoveImages` in local environment (includes all ":\" and "file://" sources). +* Changed: Resource loading order according to it's priority. +* Changed: Loading minified resource versions by default to improve the payload significantly. ### 1.4.23 -* Fixed: Issue with `forceRemoveImages` in local enviroment +* Fixed: Issue with `forceRemoveImages` in local environment. ### 1.4.22 -* Fixed: Local time offset issue on XLSX exports -* Added: `forceRemoveImages` to remove images regardless if they are tainted or not -* Added: Used config ([processData](#changing-the-dataprovider-when-exporting)) as additional given parameter. +* Fixed: Local time offset issue on XLSX exports. +* Added: `forceRemoveImages` to remove images regardless if they are tainted or not. +* Added: Used config ([processData](#changing-the-dataprovider-when-exporting)) as additional given parameter.. ### 1.4.21 * Fixed: Issue with file:// image origin, forced removal as it does not fit to the CORS policy and blocks the image export. ### 1.4.20 -* Fixed: Issue with disappearing images in PDFs caused by exceeding boundary box for images +* Fixed: Issue with disappearing images in PDFs caused by exceeding boundary box for images. ### 1.4.19 -* Fixed: Issue with radial gradient +* Fixed: Issue with radial gradient. ### 1.4.18 -* Fixed: Issue with the legend positioning on the left side +* Fixed: Issue with the legend positioning on the left side. ### 1.4.17 * Fixed: `clip-path` issue on XY serial charts which exposed the drawn line beyond the plotarea. @@ -1163,219 +1163,219 @@ http://www.apache.org/licenses/LICENSE-2.0 * Added: ([border](#adding-overlaying-border)) config-property to add an overlaying border on the output image. ### 1.4.13 -* Fixed: Issue on balloons showing it's content as HTML added "textContent" as alternative getter +* Fixed: Issue on balloons showing it's content as HTML added "textContent" as alternative getter. ### 1.4.12 -* Fixed: clipPath issue on SVG export (workaround until fabricJS handles that by themselves) +* Fixed: clipPath issue on SVG export (workaround until fabricJS handles that by themselves). ### 1.4.11 -* Fixed: Depth issue on value labels on columns +* Fixed: Depth issue on value labels on columns. ### 1.4.10 -* Fixed: potential vulnerability with anonymous function declaration +* Fixed: potential vulnerability with anonymous function declaration. ### 1.4.9 -* Added: Radial gradient support on pie charts (new feature in amCharts v3.18.0) +* Added: Radial gradient support on pie charts (new feature in amCharts v3.18.0). ### 1.4.8 -* Fixed: Clippath positioning issue -* Fixed: Issue removing tainted images -* Fixed: Hashbanged url interpretation issue in IE (related to reusable svg nodes) +* Fixed: Clippath positioning issue. +* Fixed: Issue removing tainted images. +* Fixed: Hashbanged URL interpretation issue in IE (related to reusable svg nodes). ### 1.4.7 -* Fixed: Zeroes were being exported to data formats as empty strings rather than numbers +* Fixed: Zeroes were being exported to data formats as empty strings rather than numbers. ### 1.4.6 -* Fixed: Loading issue with patterns in firefox +* Fixed: Loading issue with patterns in Firefox. ### 1.4.5 -* Fixed: Issue with the "canvas-container" on chart revalidations +* Fixed: Issue with the "canvas-container" on chart revalidations. ### 1.4.4 -* Added: Balloon text orientation -* Fixed: Issue with multiline label positioning +* Added: Balloon text orientation. +* Fixed: Issue with multiline label positioning. ### 1.4.3 -* Added: `exportFields` option which is an array of fields to export in data formats (if you want to export just some fields as opposed to all fields) +* Added: `exportFields` option which is an array of fields to export in data formats (if you want to export just some fields as opposed to all fields). ### 1.4.2 -* Added: `overflow` flag to overwrite the css attribute 'overflow' of the chart container +* Added: `overflow` flag to overwrite the CSS attribute 'overflow' of the chart container. ### 1.4.1 -* Fixed: cropped bullets on XY charts +* Fixed: cropped bullets on XY charts. ### 1.4.0 -* Fixed: beforeCapture issue on SVG document changes -* Added: Namespace check within globals for required third party software +* Fixed: beforeCapture issue on SVG document changes. +* Added: Namespace check within globals for required third-party software. ### 1.3.9 -* Fixed: Base tag gradient drawing issue (includes embedded hotfix for fabricjs commit #c9745ff) +* Fixed: Base tag gradient drawing issue (includes embedded hotfix for fabricjs commit #c9745ff). ### 1.3.8 -* Fixed: Base tag clip path issue which draw the lines outside the plotarea +* Fixed: Base tag clip path issue which draw the lines outside the plotarea. ### 1.3.7 -* Added: `columnNames` property, which allows overriding column names when expoerting chart data +* Added: `columnNames` property, which allows overriding column names when exporting chart data. ### 1.3.6 -* Fixed: Checking parseDates for category values for date interpretation +* Fixed: Checking parseDates for category values for date interpretation. ### 1.3.5 -* Fixed: Scrollbar issue hiding the unselected scrollbar background area +* Fixed: Scrollbar issue hiding the unselected scrollbar background area. ### 1.3.4 * Fixed: Absolute legend positioning issue. ### 1.3.3 -* Added: English as default language when define language does not exist +* Added: English as default language when define language does not exist. ### 1.3.2 -* Added: ([drawing.autoClose](#annotation-settings)) new flag to automatically close the annotation mode after download -* Fixed: Internal pdfMake issue which prevented to generate PDFs in IE10, uses custom build until officially fixed +* Added: ([drawing.autoClose](#annotation-settings)) new flag to automatically close the annotation mode after download. +* Fixed: Internal pdfMake issue which prevented to generate PDFs in IE10, uses custom build until officially fixed. ### 1.3.1 -* Added: Timestamp date fields get converted as dates -* Fixed: XLSX respects given dateFormat -* Changed: JSON exports date fields as date objects by default +* Added: Timestamp date fields get converted as dates. +* Fixed: XLSX respects given dateFormat. +* Changed: JSON exports date fields as date objects by default. ### 1.3.0 -* Fixed: Issue hiding drawing container on "drawing.done" -* Fixed: Legend positioning issue with charts created in a hidden container +* Fixed: Issue hiding drawing container on "drawing.done". +* Fixed: Legend positioning issue with charts created in a hidden container. ### 1.2.9 -* Fixed: Issue with missing `export.css` which showed the canvas -* Fixed: Issue with empty menu items; adds list only with childNodes > 1 -* Fixed: Issue with hidden bullets; caused by wrong clip-paths -* Added: Polish language file ( thanks to piernik ) +* Fixed: Issue with missing `export.css` which showed the canvas. +* Fixed: Issue with empty menu items; adds list only with childNodes > 1. +* Fixed: Issue with hidden bullets; caused by wrong clip-paths. +* Added: Polish language file (thanks to piernik). ### 1.2.8 -* Fixed: Issue in `gatherClassName` checking element type +* Fixed: Issue in `gatherClassName` checking element type. ### 1.2.7 -* Fixed: Generates true JPG file instead PNG with JPG extension -* Fixed: Drag&Drop feature does not activate automatically the annotation mode +* Fixed: Generates true JPG file instead PNG with JPG extension. +* Fixed: Drag & Drop feature does not activate automatically the annotation mode. ### 1.2.6 -* Added: Native EXCEL date cell type for date fields, forced by default -* Fixed: Issue in `getChartData` which ignored given data array ( affected API usage only ) +* Added: Native EXCEL date cell type for date fields, forced by default. +* Fixed: Issue in `getChartData` which ignored given data array (affected API usage only). ### 1.2.5 -* Added: Illustrator support; `reviver` method to `toSVG`; converts by default RGBA to HEX colors codes and places it's dedicated opacity property -* Fixed: Multiline text positioning / line heights +* Added: Illustrator support; `reviver` method to `toSVG`; converts by default RGBA to HEX colors codes and places it's dedicated opacity. property +* Fixed: Multiline text positioning/line heights. ### 1.2.4 -* Added: `exportSelection` exports the current data selection -* Added: `dataDateFormat` converts the date-strings to date objects with given format -* Added: `dateFormat` converts the date in given format -* Added: `processData` to format date fields and translate fields -* Changed: `gatherChartData` collects data, fields and titles only and uses `processData` to format +* Added: `exportSelection` exports the current data selection. +* Added: `dataDateFormat` converts the date-strings to date objects with given format. +* Added: `dateFormat` converts the date in given format. +* Added: `processData` to format date fields and translate fields. +* Changed: `gatherChartData` collects data, fields and titles only and uses `processData` to format. ### 1.2.3 -* Fixed: Positioning issue on multiline labels +* Fixed: Positioning issue on multiline labels. ### 1.2.2 -* Fixed: Issue with object changes which overwrite undo/redo object states -* Fixed: Issue with default fontSize +* Fixed: Issue with object changes which overwrite undo/redo object states. +* Fixed: Issue with default fontSize. ### 1.2.1 -* Added: Possibility to add text, lines, shapes ([details](#annotation-settings)) -* Added: Possibility to change drawing mode, color, opacity and size -* Added: Possibility to select,move,scale drawn items -* Added: Possibility to define dedicated drawing menu `drawing.menu` individual menu items get prioritised -* Added: Dropbox feature which allows to drag images into the chart `fileListener: true` -* Added: Keylistener which allows to undo/redo/remove the drawn steps `keyListener: true` -* Added: Isolated plugin to be able to initiate manually regardless of the chart setup -* Fixed: Conflict with prototypeJS which caused tainted return value from `toArray` +* Added: Possibility to add text, lines, shapes ([details](#annotation-settings)). +* Added: Possibility to change drawing mode, color, opacity and size. +* Added: Possibility to select move, scale, and drawn items. +* Added: Possibility to define dedicated drawing menu `drawing.menu` individual menu items get prioritized. +* Added: Dropbox feature which allows to drag images into the chart `fileListener: true`. +* Added: Keylistener which allows to undo/redo/remove the drawn steps `keyListener: true`. +* Added: Isolated plugin to be able to initiate manually regardless of the chart setup. +* Fixed: Conflict with prototypeJS which caused tainted return value from `toArray`. ### 1.2.0 -* Fixed: Issue with deepMerge which did not allow to modfiy the pdfMake default settings -* Fixed: Menu issue which did not allow to modify the pdfMake settings -* Fixed: Undo issue which needed double attempts in the beginning -* Added: Drag/Scale feature in annotation mode; toggles automatically between drawing/dragging while hovering over the elements +* Fixed: Issue with deepMerge which did not allow modifying the pdfMake default settings. +* Fixed: Menu issue which did not allow modifying the pdfMake settings. +* Fixed: Undo issue which needed double attempts in the beginning. +* Added: Drag/Scale feature in annotation mode; toggles automatically between drawing/dragging while hovering over the elements. ### 1.1.9 -* Added: `exportTitles` available in general or individual setup which exchanges the data field names with it's dedicated title -* Fix: Interpolates missing data fields across data provider +* Added: `exportTitles` available in general or individual setup which exchanges the data field names with it's dedicated title. +* Fix: Interpolates missing data fields across data provider. ### 1.1.8 -* Added: Temporary workaround to bypass FileSaver check; issue prevented to open blob urls in safari browser +* Added: Temporary workaround to bypass FileSaver check; issue prevented to open blob URLs in Safari browser. ### 1.1.7 -* Added: beforeCapture to be able to indicate the export process in some way -* Added: afterCapture to be able to modify the fabric instance if needed -* Added: SVG element as second argument within the "reviver" callback -* Added: Multiple arguments supported in "handleCallback" method +* Added: beforeCapture to be able to indicate the export process in some way. +* Added: afterCapture to be able to modify the fabric instance if needed. +* Added: SVG element as second argument within the "reviver" callback. +* Added: Multiple arguments supported in "handleCallback" method. ### 1.1.6 * Fix: Pattern render issue in IE; -* Added: Multiline support (workaround until fabricJS supports tspan) -* Added: General delay property to delay the capturing of the chart ([details](#delay-the-capturing-before-export)) +* Added: Multiline support (workaround until fabricJS supports tspan). +* Added: General delay property to delay the capturing of the chart ([details](#delay-the-capturing-before-export)). ### 1.1.5 -* Fix: Tainted check issue which failed if location.origin wasn't available -* Fix: Capture image check, triggers callback only if all images have been loaded -* Added: Multi language support; embedded english by default; overtakes chart language -* Added: Delay feature, which allows to delay the capturing ([details](#delay-the-capturing-before-export)) +* Fix: Tainted check issue which failed if location.origin wasn't available. +* Fix: Capture image check, triggers callback only if all images have been loaded. +* Added: Multi language support; embedded English by default; overtakes chart language. +* Added: Delay feature, which allows to delay the capturing ([details](#delay-the-capturing-before-export)). ### 1.1.4 -* Fix: Did not collect clip-path and pattern from legend -* Fix: External legend did not respect given width when positioned on left side -* Fix: Improved tainted image detection +* Fix: Did not collect clip-path and pattern from legend. +* Fix: External legend did not respect given width when positioned on left side. +* Fix: Improved tainted image detection. ### 1.1.3 -* Added: Added reviver in capturing method to filter the drawn chart elements +* Added: Added reviver in capturing method to filter the drawn chart elements. ### 1.1.2 -* Added: Generalized fallback; does a lookup on the Blob constructor -* Fix: Wait for lazy images, triggers capture callback only when all images have been fully loaded -* Discovered: [Safari 5 issue](https://github.com/kangax/fabric.js/issues/2241) please adapt fabric.js manually to solve it +* Added: Generalized fallback; does a lookup on the Blob constructor. +* Fix: Wait for lazy images, triggers capture callback only when all images have been fully loaded. +* Discovered: [Safari 5 issue](https://github.com/kangax/fabric.js/issues/2241) please adapt fabric.js manually to solve it. ### 1.1.1 -* Fix: CSV export issue on date based charts -* Fix: Enhanced migration script to obtain more settings +* Fix: CSV export issue on date based charts. +* Fix: Enhanced migration script to obtain more settings. ### 1.1.0 -* Fix: Print issue on safari which captured the actual page instead of the export -* Added: IE9 download fallback for `text/plain` and `image/*` mime types (CSS has been modified) -* Added: `toImage` method; returns `img` element with embedded base64 imagery -* Added: `getBase64` option in `toSVG` +* Fix: Print issue on safari which captured the actual page instead of the export. +* Added: IE9 download fallback for `text/plain` and `image/*` mime types (CSS has been modified). +* Added: `toImage` method; returns `img` element with embedded base64 imagery. +* Added: `getBase64` option in `toSVG`. * Added: `toImage` usage in `toPRINT` to be able to choose the image type + settings. -* Added: `lossless` option in `toPRINT` (experimental) +* Added: `lossless` option in `toPRINT` (experimental). ### 1.0.9 -* Added: IE9 base64 export -* Added: Third party updates + minified versions +* Added: IE9 base64 export. +* Added: Third party updates + minified versions. ### 1.0.8 -* Fix: IE8 issue which prevents the chart from initiating +* Fix: IE8 issue which prevents the chart from initiating. ### 1.0.7 -* Fix: issue on toCSV handling the header (first row) +* Fix: issue on toCSV handling the header (first row). ### 1.0.6 * Fix: issue on revalidation the chart/map -* Added: [path](http://docs.amcharts.com/3/javascriptcharts/AmSerialChart#path) to load the libaries by default +* Added: [path](http://docs.amcharts.com/3/javascriptcharts/AmSerialChart#path) to load the libraries by default. ### 1.0.5 -* Added: divId to be able to place the menu within an external container -* Added: menuWalker to replace the whole menu generation -* Added: menuReviver to adapt menu items before being appended to the list -* Added: libs.async to load dependencies asynchronous (default true) +* Added: divId to be able to place the menu within an external container. +* Added: menuWalker to replace the whole menu generation. +* Added: menuReviver to adapt menu items before being appended to the list. +* Added: libs.async to load dependencies asynchronous (default true). ### 1.0.4 -* Considering classNamePrefix (dont't forget to adapt export.css) -* Added: safety delay on print restore to ensure capturing the canvas +* Considering classNamePrefix (don't forget to adapt export.css). +* Added: Safety delay on print restore to ensure capturing the canvas. ### 1.0.3 -* Fix: flagged relative image paths as tainted +* Fix: Flagged relative image paths as tainted. ### 1.0.2 -* Fix: compabitily on array method extension such as PrototypeJS +* Fix: Compatibility on array method extension such as PrototypeJS. ### 1.0.1 -* Added: libs.reload: false, script tag crawling to avoid multiple insertions -* Fix: IE10 bug on print -* Fix: migration bug, replaces menu instead of appending +* Added: libs.reload: false, script tag crawling to avoid multiple insertions. +* Fix: IE10 bug on print. +* Fix: migration bug, replaces menu instead of appending. ### 1.0 -* Initial release \ No newline at end of file +* Initial release. -- 2.45.2 From 59d23dc2a7ccd90f1dfd82d5a35c046559b7035a Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Mon, 12 Nov 2018 11:42:30 -0500 Subject: [PATCH 2/2] Update LICENSE --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 93d321d..305136b 100644 --- a/LICENSE +++ b/LICENSE @@ -6,4 +6,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS-IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -- 2.45.2