xdas.plot_availability#

xdas.plot_availability(obj, dim='first', **kwargs)[source]#

Plot the availability of a given dimension in a timeline chart.

The availability is determined by finding the discontinuities and availabilities of the specified dimension in the object. The resulting timeline chart shows the start and end values of each availability period, as well as any gaps or overlaps in the data. If a data collection is provided, the timeline chart will show the availability of each data array in the collection. Note that data arrays in the same data sequence will be on the same timeline whereas data arrays in data mappings will be on separate timelines.

This function only works on interpolated coordinates.

Parameters:

  • obj (DataArray or DataCollection) – The data array containing the dimension to plot.

  • dim (str) – The name of the dimension to plot.

  • **kwargs – Additional keyword arguments to be passed to the px.timeline function.

Returns:

fig – The timeline

Return type:

plotly.graph_objects.Figure

Notes

This function uses the px.timeline function from the plotly.express library.