* Docs : fixes and enhancements for the documentation template.
This is an evolutionary update for the `jsdoc` document generation.
- Added functionality to retrieval of data comments
- Added partial for generating documentation in the method tables.
- Moved commenting to source for `Network#clusterOutliers`. This was used as a case example.
- Adjustment to CSS to get the decription text margins same as original
- Added step to generate documentation to release checklist
- Fixed some commenting which `jsdoc` couldn't handle
* Fixes for linting
* Moved navbar elements in all html documentation files to partial
This consolidates the common menu elements in all documentation files to a partial.
* Moved test-exclamation mark
* Added partial, tested with some pages
* Docs: Moved end block in all html documentation files to partiel
This rcConsolidatersd common footer in all documentation files to a partial.
I'm hoping this serves as an example for others to isolate more common blocks (the menu would be the perfect candidate). It's straightforward work.
* Add template for document generation with 'jsdoc'.
In essence, it defines the subdirectory `docs` as a `jsdoc` template. Benefits:
- allows the usage of partials, in order to DRY common parts of the html files.
- makes available the jsdoc-comments, for addition into the documentation.
- enables extraction of data from the source code. For example, the list of edge endpoints `['arrow', 'bar', 'circle']` can now be extracted from the source and inserted into the documentation on generation.
In this initial version, the only file that has been changed is `docs/data/dataset.html`.
In here, partials have been added to illustrate how common page elements can be DRY'd.
The template has been set up in such a way, that resource files will be copied and that html files can pass through unchanged if no special template tags (`<?js...?>`) are used. This allows for a gradual transition of the html files to templates.
**Usage:** `gulp docs`
- The result files are placed in subdirectory `gen/docs/`.
**NOTE:** The release procedure will have to be adjusted by adding this gulp command.
The docs-files will then have to be taken from `gen/docs`.
* Edits to docs/README
* Adjusted layout of README.md
* Further edits to README.md
* Removed pre tags again in README.md - don't work in code block
* Linted the gulpfile
* Added proof of concept for docs generation from source
Some browsers cannot handle very large DIVs so by default range DIVs
can be truncated outside the visible area. This change allows the use
of a new `limitSize` item option which disables this functionality,
allowing the creation of full-width DIVs.
I don’t see an existing test spec that covers RageItem.js so I’m
submitting without tests. However we’ve using Timeline in production on
a fairly large project with these changes in place for several months
and it works fine.
* - Added support for stacking items within individual subgroups while subgroupStack is on
* - Adjusted location of visibility check to cover subgroup stacking
* - Fixing linting issues
* - Updated subgroup stacking to optionally take a 'subgroupStack' parameter of "true", which enables stacking in all subgroups
- Fixed code to meet style guidelines
- Updated documentation
* Small refactoring in Label._drawBackground()
* Added size calculation to Label, basic framework for detecting click on label.
* First fully working version of label click.
* Put in extra checks, refactored visibility of labels for more general usage.
* Final fixes to code; added to example and in docs
* Adressed review comments
* Add next attempt to fix Travis unit test bug
* Addressed review issues
* Network: Adjust documentation for arrows.middle.scaleFactor
Addendum to #3474.
Updated the documentation, so that users can know about flipping the middle arrow with a negative scale factor.
* Adjusted text for review
* Add endpoint 'bar' to Network
Fixes#3412
- Adds class `Bar` and handling to `EndPoints.js`
- Adjusted `options.js` for endpoint, minor code changes
- Added to example `network/edgeTypes/arrowTypes`.
- Added to edges documentation
* Grumbl fix travis unit test yet again. Go die already!
* added hexagon shape to the node.
* Updated function for hexagon shape.js
* Modifid the shape login for hexagon
* Remove this.translate from the Shape.js for hexagon
* updated hexagon draw logic
* Fixed code review comments and update the branch
* Updated changes in test.js
* Fixes Issue #3316 - Updates network documentation to account for edge-case of how clusterByConnection uses the joinCondition callback
* Move the text 'clusterByConnection will pass ... callback.' to under 'Optional for all but the cluster method'.
Make it clear that clusterByConnection is the only one that uses the second call.
Instead of bold, make it a distinct paragraph.
* Proof of concept with copied options + handling from network
* Added unit test for Graph3d, for checking default syntax; completed def's of all options, autoByDefault not handled yet.
* Fixes for options in playground example
* Added onclick options to graph3d documentation
* Fixes in graph3d examples
* Final fixes for option definitions in Graph3d
* Fixed handling of 'undefined' in options, enhanced graph3d unit test
* Disabled console output in graph3d unit test
* Upgrade webpack module
* First interim commit
* Fixes during testing
* Allow multiple edges to be hidden by a clustered edge.
Fix for #3245.
This fix adjusts the clustering edges so that theyi can refer to multiple edges instead of just one.
This API method is now insufficient, since multiple base edges can be returned.
- Added replacing method `clustering.getBaseEdges()`
- Adjusted example `changingClusteredEdgeNodes` for the new method. This is the *only* place where `getBaseEdge()` was used
- Adjusted documentation for new method and deprecation old method.
Method `getbaseEdge()` should now be considered `deprecated`, and in due time should be removed.
* Edits of method name in example
* Edits of method name in example
* adjusted deprecation method getBaseEdge() in docs
* Adjusted deprecation method for getBaseEdge() in docs
* Bidirectional scrolling.
Make horizontalScroll and verticalScroll work together.
* Fix delta variable declaration
Using ?: operator
* Remove notice about vertical and horizontal scroll conflict
There is no sense considering #3162
* Protect Network from zero and negative mass values
Fix for #3133
Option-field 'node.mass` must be >= 0.
Checks have been added at the nodes level, for both nodes-global and nodes specific options.
In addition, an internal check has been added for `NodeHandler.defaultOptions`.
The documentation has been adjusted for this change.
* Fix whitespace
* Prevent crashes from invalid id's in `Clustering.findNode()`
Fix for #3163
- Added safeguards in said method, to prevent exceptions happening when invalid id's are passed in.
- Adjusted documentation for said method
- Added notes to flag unused methods in `Clustering.js`
* Removed incorrect NOTE-comments from methods that are indeed used
* Add 'showTooltips' timeline option
* Only show timeline popup if option showTooltips is true
* Add 'showTooltips' option to timeline docs
* Add tooltips disabled timeline example
Sorry for the delay on this... It took me a while to confirm this PR again. I don;t know why I didn't merge it at the time I reviewed it. Looks great to me!
* Add Gitter badge (#2179)
* do not generate source-maps in distribution version
* add 'dist' folder for deployment
* added Badges
* added codeclimate badge
* added @Tooa to the support team
* added badges from isitmaintained.com (#2517)
* do not ignore dist and test folders in master
* generated dist files for v4.18.0
* generated dist files for v4.18.1
* Cheap fix for bug #2795
* Update to PR #2826 to use newline format
* changed to v4.18.1-SNAPSHOT
* chore(docs): general improvements (#2652)
* removed NOTICE file
* updated license date range to include 2017
* chore(docs): updated support team members
* chore: updated dependencies and devDependencies (#2649)
* Fixes instanceof Object statements for objects from other windows and iFrames. (#2631)
* Replaces instanceof Object checks with typeof to prevent cross tab issues.
* Adds missing space.
* chore: removed google-analytics from all examples (#2670)
* chore(docs): Add note that PRs should be submitted against the `develop` branch (#2623)
Related to: https://github.com/almende/vis/pull/2618
Related to: https://github.com/almende/vis/pull/2620
* feat(timeline): Change setCustomTimeTitle title parameter to be a string or a function (#2611)
* change setCustomTimeTitle title parameter, Now could be an string or a function
* Fixed indent and spacing
* feat(timeline): refactor tooltip to only use one dom-element (#2662)
* feat(network): Allow for image nodes to have a selected or broken image (#2601)
* feat(tests): run mocha tests in travis ci (#2687)
* Added showX(YZ)Axis options to Graph3d (#2686)
* Added showX(YZ)Axis to Graph3d
* Added show_Axis options to docs and playground example
* Resolved merge conflict
* Added show_Axis options to docs and playground example
* fix(build): use babel version compatible with webpack@1.14 (#2693)
fixes#2685
* feat(docs): use babel preset2015 for custom builds (#2678)
* add link to a mentioned example (#2709)
* chore(lint): added support for eslint (#2695)
* Trivial typo fix in how_to_help doc. (#2714)
* fix(timeline): #2598 Flickering onUpdateTimeTooltip (#2702)
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Add animation to onUpdateTooltip
* fix(timeline): #778 Tooltip does not work with background items in timeline (#2703)
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Make items z-index default to 1
* Add initial tests for Timeline PointItem (#2716)
* fix(timeline): #2679 TypeError: Cannot read property 'hasOwnProperty' of null (#2735)
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Fix bug in item editable
* feat(timeline): #2647 Dynamic rolling mode option (#2705)
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Add toggleRollingMode option
* Update docs with toggleRollingMode option
* fixes timestep next issue (#2732)
* feat(timeline): added new locales for french and espanol (#2723)
* Fix eslint problem on Travis. (#2744)
* fix: Range.js "event" is undeclared (#2749)
* fix(timeline): #2720 Problems with option editable (#2743)
Clean up and centralise edit status for Timeline Items.
* feat(network): Improve the performance of the network layout engine (#2729)
* Improve the performance of the network layout engine
Short-cut the execution of a number of methods in LayoutEngine to make them
handle highly-connected graphs better.
* Demonstrations of layouts of large networks
* Added support to supply an end to bar charts to have them scale (#2760)
* Added support to supply an X2 to bar charts to have them scale
* Fixed graph2d stacking issue. It no longer takes into account hidden items
* Changed x2 to end per recommendation and added this to the docs
* Initial tests for timeline ItemSet. (#2750)
Somewhat more complicated setup, associated with the need for a real window.
* [Timeline] Modify redraw logic to treat scroll as needing restack. (#2774)
This addresses #1982 and #1417.
It possibly reduces performance, but correctness seems better.
* fix(timeline): #2672 Item events original event (#2704)
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Fix events returned from mouse events
* Fix example
* Rename censor to stringifyObject in example
* [timeline] Update examples to use ISOString format. (#2791)
Resolves#2790
* [timeline] Update serialization example to use ISOString dates. (#2789)
Resolves#2696
* added github templates for issues and pull-requests (#2787)
fixes#2418
* feat(timeline): Add item data as argument to the template function (#2799)
* Fix regression introduced in #2743. (#2796)
* Fix for issue #2536 (#2803)
* Fix for issue #2536
* Adjusted documentation for fix.
* Adjustments due to review
* Grrrrr whitespace
* Fixed Travis issue
* Cheap fix for bug #2795
* Update to PR #2826 to use newline format
* Update to gitignore to reflect changes on remote
* clean dist folder
* Local gitignore update
* Just a first example file for the week scale feature
* Allowing sourcemap creation
* Initial (non-functional) commit to ensure we insert code at the right places (check TODOs)
* Functional, not bug-free version which works with locale aware week numbers.
* Locale-aware implementation and simplified major labels to a full year
* Trying to make the major labels show the correct start date
* Working implementation of week numbers using localization.
* removing development leftovers
* Updated package.json
* Reintagrate package.json from accidental deletion
* Updates for package.json
* Fixing package.json
* Integrate the week numbers feature in the documentation.
* Reverting local changes to .gitignore
* Reverting local changes
* Extending examples to cover the case when 1st day of week and 1st day of month align; Fixing display bug so that week numbers are not repeated in minorLabels
* Putting the examples into a loop
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Add drop event info
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Add callback functions to moveTo, zoomIn, zoomOut and setWindow
* styling support for graph3d tooltips
* styling support for graph3d tooltips
* graph3d styling example, deleted new example and altered the original
* graph3d tooltip styling, documentation
* graph3d tooltip styling, use the util module's method for merging objects
* Fix redraw order
* Fix error when option is not defined
* Allow template labels
* Add .travis.yml file
* Add experiment travis code
* Fix react example
* Add animation options for zoomIn and zoomOut
* Added support to supply an X2 to bar charts to have them scale
* Fixed graph2d stacking issue. It no longer takes into account hidden items
* Changed x2 to end per recommendation and added this to the docs
* Added showX(YZ)Axis to Graph3d
* Added show_Axis options to docs and playground example
* Resolved merge conflict
* Added show_Axis options to docs and playground example