Topic Sections

Below is the list of sections that the API reference documentation contains. Note their order.

• Configuration
• Fields
• Methods
• Events

These should be implemented as H2 sections—## in markdown terms. If sections do have no members, omit them.

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.

EXAMPLE

ruby api_sort.rb api/javascript/dataviz/ui/chart

Links

As multiple widgets often share the same events or methods, provide the convention demonstrated below when linking methods, events, or configuration options.

EXAMPLE

[filterable](#configuration-filterable)

[addRow](#methods-addRow)

[cancel](#events-cancel)