Topic Sections

The API reference contains the following sections (note order):

• Configuration
• Fields
• Methods
• Events

These should be H2 sections (## in markdown terms). Sections should be omitted if they don't have any members.

Subsections

Every ## section contains subsections ### which list the configuration options, methods or events. Those subsections may have subsections of their own - method parameters, examples or event arguments.

Order

All subsections must be listed in alphabetical order.

There is a handy ruby script which does that automatically. ruby api_sort.rb api/javascript/dataviz/ui/chart

Links

As often multiple widgets share the same events or methods, when links to methods, events or configuration options are provided they should follow this convention:

[filterable](#configuration-filterable)

[addRow](#methods-addRow)

[cancel](#events-cancel)