MAIDR Documentation - v4.4.0
    Preparing search index...
    • Claims a chart for examination, so a caller examines it once per set of inputs rather than once per DOM mutation.

      A verdict is reached from plotly's _fullData and calcdata, which it builds afresh whenever it recomputes a chart and leaves alone otherwise — a pan or a zoom keeps them, as does a mutation elsewhere on the page. An unchanged pair therefore means an unchanged verdict and no claim, while new traces, or the points a chart was drawn without, yield a new pair and a fresh one. (Were a future plotly to recompute a chart in place instead, the pair would look unchanged and the chart would stop being re-examined.)

      A chart plotly has not computed yet is not claimed either, and nothing is recorded for it, so it can be claimed once it has been.

      Parameters

      • element: HTMLElement

        Any element inside the plotly graph div, or the div itself.

      Returns boolean

      Whether the caller should examine the chart now.