AnyChart Products API Reference
Latest commit c937dd7 Nov 15, 2018
Permalink
Failed to load latest commit information.
_media Rework media Aug 6, 2018
_samples Merge DVF-3987_add_missing_methods Nov 6, 2018
api-generator Merge DVF-3076-stock-scale-extension Nov 14, 2018
charts Fixed samples #pg Nov 15, 2018
core Merge DVF-4050_gantt_inherited_methods Nov 15, 2018
data Merge DVF-3939_minor_fixes_api Oct 8, 2018
editor Merge DVF-3642_rework_function Aug 7, 2018
format Merge DVF-3962_other_event_types_rework Oct 23, 2018
graphics Merge DVF-3987_add_missing_methods Nov 6, 2018
math Added methods for ts Oct 8, 2018
modules Merge DVF-3929_rework_fill_doclet Oct 2, 2018
palettes Fixed descriptions Oct 31, 2018
scales Fixed links Nov 14, 2018
standalones Merge DVF-3987_add_missing_methods Nov 6, 2018
ui Merge DVF-3939_minor_fixes_api Oct 8, 2018
.api-config.edn Release 7.0.0 Sep 2, 2015
.gitignore Release 7.0.0 Sep 2, 2015
README.md Merge DVF-3171-sankey-diagram Oct 1, 2018
adoc_checker.py another fix of adoc_checker Sep 3, 2015
anychart.adoc Merge DVF-3987_add_missing_methods Nov 6, 2018
checker.sh update checker.sh added links parameter May 23, 2018
color.adoc Merge DVF-3917_ui_rework_parameter_names Sep 20, 2018
config.edn Release 7.4.0 Sep 2, 2015
config.toml Fixed links May 10, 2018
enums.adoc Merge DVF-3985_remaining_event_types Oct 29, 2018
export.adoc Merge DVF-3939_minor_fixes_api Oct 8, 2018
gendoc.sh Changed gendoc Oct 6, 2015
typedefFunctionList.adoc Fixed function Sep 20, 2018
utils.adoc Merge DVF-3917_ui_rework_parameter_names Sep 20, 2018

README.md

AnyChart API Reference

Overview

The AnyChart Technical Documentation Team welcomes you!

This repo contains AnyChart JavaScript HTML5 Charts API Reference sources. We appreciate your interest and will do our best to make AnyChart documentation as good as possible.

If you have any suggestions how to improve this documentation, feel free to use one of the following methods:

  • Create an issue in repo issues tracker, we will answer you in a 24 hours on weekdays and in 48 hours during weekends.
  • Fork this repo, fix whatever you think needs fixing, and send us a pull request. Learn more about github collaboration model.

Documentation format

We use JSDoc-like formatting in AnyChart API Reference pages, so the simple method doclet looks like this:

/**
 * Add callback for document ready event.<br/>
 * It is called when the DOM is ready, this can happen prior to images and 
 * other external content is loaded.
 * @param {Function} func Function which will called on document load event.
 * @param {*=} opt_scope Function call context.
 */
anychart.onDocumentReady;

Besides common JSDoc annotations, we use several custom annotations, here is the full list of them:

  • @ignoreDoc - indicates that this doclet should be ignored when is HTML generated.
  • @example - provide an absolute or relative path to a file with method.
  • @listing - code sample with comments.
  • @detailed - extended description of a doclet.