next/en/documents/option-parts/option.aria.json

{
  "show": {
    "desc": "<p>Whether to enable ARIA. When enabled, there should be an <code class=\"codespan\">aria-label</code> label.</p>\n"
  },
  "description": {
    "desc": "<p>By default, the description is generated by our algorithm based on charts. If user wants to set their own description, <code class=\"codespan\">description</code> should be set to the whole description.</p>\n<p>This is useful when single data values cannot represent what the chart means. For example, if the chart is a map containing many scatter points. Default description can only show the data, but the users may find it hard to interpret. In this case, <code class=\"codespan\">description</code> should be set to describe the meaning of chart.</p>\n"
  },
  "general": {
    "desc": "<p>General description of chart.</p>\n"
  },
  "general.withTitle": {
    "desc": "<p>If <a href=\"#title.text\">title.text</a> exists, then this is used. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{title}</code>: will be replaced by <a href=\"#title.text\">title.text</a>.</li>\n</ul>\n"
  },
  "general.withoutTitle": {
    "desc": "<p>If <a href=\"#title.text\">title.text</a> does not exist, then this is used.</p>\n"
  },
  "series": {
    "desc": "<p>Series-related configures.</p>\n"
  },
  "series.maxCount": {
    "desc": "<p>Maximum series number.</p>\n"
  },
  "series.single": {
    "desc": "<p>Description used when there is only one chart.</p>\n"
  },
  "series.single.prefix": {
    "desc": "<p>General description for all series. This displays before all series descriptions. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{seriesCount}</code>: will be replaced by series count, which is 1.</li>\n</ul>\n"
  },
  "series.single.withName": {
    "desc": "<p>If chart contains <code class=\"codespan\">name</code> attribute, then this is used. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{seriesName}</code>: will be replaced by the series <code class=\"codespan\">name</code>;</li>\n<li><code class=\"codespan\">{seriesType}</code>: will be replaced by the series type name.</li>\n</ul>\n"
  },
  "series.single.withoutName": {
    "desc": "<p>If chart doesn&#39;t contain <code class=\"codespan\">name</code> attribute, then this is used. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{seriesType}</code>: will be replaced by series type name.</li>\n</ul>\n"
  },
  "series.multiple": {
    "desc": "<p>Description used when there are more than one chart.</p>\n"
  },
  "series.multiple.prefix": {
    "desc": "<p>General description for all series. This displays before all series descriptions. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{seriesCount}</code>: will be replaced by series count.</li>\n</ul>\n"
  },
  "series.multiple.withName": {
    "desc": "<p>If series contains <code class=\"codespan\">name</code> attribute, then this is used. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{seriesName}</code>: will be replaced by series <code class=\"codespan\">name</code>;</li>\n<li><code class=\"codespan\">{seriesType}</code>: will be replaced by series type name.</li>\n</ul>\n"
  },
  "series.multiple.withoutName": {
    "desc": "<p>If series doesn&#39;t contain <code class=\"codespan\">name</code> attribute, then this is used. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{seriesType}</code>: will be replaced by series type name.</li>\n</ul>\n"
  },
  "series.multiple.separator": {
    "desc": "<p>Separators between series and series.</p>\n"
  },
  "series.multiple.separator.middle": {
    "desc": "<p>Separators other than the last one.</p>\n"
  },
  "series.multiple.separator.end": {
    "desc": "<p>The last series seperator.</p>\n"
  },
  "data": {
    "desc": "<p>Data-related configures.</p>\n"
  },
  "data.maxCount": {
    "desc": "<p>Maximum data number.</p>\n"
  },
  "data.allData": {
    "desc": "<p>Description used when all data is displayed. Note that this option will <strong>not</strong> set to display all data. If all data should be displayed, <a href=\"#aria.data.maxCount\">aria.data.maxCount</a> should be set to be <code class=\"codespan\">Number.MAX_VALUE</code>.</p>\n"
  },
  "data.partialData": {
    "desc": "<p>Description used when only part of data is displayed. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{displayCnt}</code>: number of data displayed.</li>\n</ul>\n"
  },
  "data.withName": {
    "desc": "<p>If data contains <code class=\"codespan\">name</code> attribute, then this is used. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{name}</code>: will be replaced by data <code class=\"codespan\">name</code>;</li>\n<li><code class=\"codespan\">{value}</code>: will be replaced by data value.</li>\n</ul>\n"
  },
  "data.withoutName": {
    "desc": "<p>If data doesn&#39;t contain <code class=\"codespan\">name</code> attribute, then this is used. Template variable:</p>\n<ul>\n<li><code class=\"codespan\">{value}</code>: will be replaced by data value.</li>\n</ul>\n"
  },
  "data.separator": {
    "desc": "<p>Separators between data and data.</p>\n"
  },
  "data.separator.middle": {
    "desc": "<p>Separators other than the last one.</p>\n"
  },
  "data.separator.end": {
    "desc": "<p>The last data separator.</p>\n<p>Note that since series <code class=\"codespan\">separator.end</code> is used after the last data, <code class=\"codespan\">data.separator.end</code> is not needed in most cases.</p>\n"
  }
}