AnyChart Products API Reference
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_media
_samples
api-generator Merge DVF-3076-stock-scale-extension Nov 14, 2018
charts
core
data
editor
format
graphics
math
modules
palettes
scales
standalones
ui
.api-config.edn
.gitignore
README.md
adoc_checker.py
anychart.adoc
checker.sh
color.adoc
config.edn
config.toml
enums.adoc
export.adoc
gendoc.sh
typedefFunctionList.adoc
utils.adoc

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.