Options

    • options
    • overrides[]
    • defaults

    Dataset level options

    dataset.type defaults to config.type, if not specified.

    • dataset
    • options.datasets[dataset.type]
    • options
    • overrides[config.type].datasets[dataset.type]
    • defaults.datasets[dataset.type]
    • defaults

    Dataset animation options

    • dataset.animation
    • options.datasets[dataset.type].animation
    • options.animation
    • defaults.datasets[dataset.type].animation
    • defaults.animation

    Dataset element level options

    Each scope is looked up with elementType prefix in the option name first, then without the prefix. For example, radius for point element is looked up using pointRadius and if that does not hit, then radius.

    • dataset
    • options.datasets[dataset.type]
    • options.datasets[dataset.type].elements[elementType]
    • options.elements[elementType]
    • options
    • overrides[config.type].datasets[dataset.type]
    • overrides[config.type].datasets[dataset.type].elements[elementType]
    • defaults.datasets[dataset.type]
    • defaults.datasets[dataset.type].elements[elementType]
    • defaults.elements[elementType]
    • defaults
    • options.scales
    • overrides[].scales
    • defaults.scales
    • defaults.scale

    Plugin options

    A plugin can provide additionalOptionScopes array of paths to additionally look for its options in. For root scope, use empty string: ''. Most core plugins also take options from root scope.

    • options.plugins[plugin.id]
    • (options.[...plugin.additionalOptionScopes])
    • overrides[config.type].plugins[plugin.id]
    • defaults.plugins[plugin.id]
    • (defaults.[...plugin.additionalOptionScopes])

    Scriptable options also accept a function which is called for each of the underlying data values and that takes the unique argument context representing contextual information (see option context). A resolver is passed as second parameter, that can be used to access other options in the same context.

    Note

    Example:

    Indexable options also accept an array in which each item corresponds to the element at the same index. Note that if there are less items than data, the items are looped over. In many cases, using a function is more appropriate if supported.

    Example:

    1. color: [
    2.     'red',    // color for data at index 0
    3.     'blue',   // color for data at index 1
    4.     'green',  // color for data at index 2
    5.     'black',  // color for data at index 3
    6.     //...

    The option context is used to give contextual information when resolving options and currently only applies to scriptable options. The object is preserved, so it can be used to store and pass information between calls.

    There are multiple levels of context objects:

    • chart
      • dataset
        • data
      • scale
        • tick
        • pointLabel (only used in the radial linear scale)
      • tooltip

    The context object contains the following properties:

    chart

    • chart: the associated chart
    • type: 'chart'

    dataset

    In addition to

    • : true if element is active (hovered)
    • dataset: dataset at index datasetIndex
    • datasetIndex: index of the current dataset
    • index: same as datasetIndex
    • mode: the update mode
    • type: 'dataset'

    In addition to

    • active: true if element is active (hovered)
    • dataIndex: index of the current data
    • parsed: the parsed data values for the given dataIndex and datasetIndex
    • raw: the raw data values for the given dataIndex and datasetIndex
    • element: the element (point, arc, bar, etc.) for this data
    • index: same as dataIndex
    • type: 'data'

    scale

    In addition to

    • scale: the associated scale
    • type: 'scale'

    tick

    In addition to

    • tick: the associated tick object
    • index: tick index
    • type: 'tick'

    tooltip

    • : the tooltip object