# _labels

<table class=".origin_table">
    <tr>
        <td style="text-align: left; border-style: hidden">*module*  of [dascore.viz](`dascore.viz`)</td>
        <td style="text-align: right; border-style: hidden">[source](https://github.com/DASDAE/dascore/blob/dev/dascore/viz/_labels.py#L1-L452)</td>
    </tr>
</table>


Drawing where a label coordinate starts and stops over a patch dimension.

An inventory's label groups arrive on a patch as ordinary coordinates over
one dimension: a string naming each sample, a boolean stating membership,
or a number. Each states a stretch of the dimension rather than a value at
a point, so what a figure owes it is that stretch marked off and named:
a bar along the axis, rather than a color per sample.

The bars sit on the spines rather than over the image. A wash over the
data would have to be strong enough to see, and a wash that strong has
recolored the data under it -- which on a diverging colormap is the
measurement itself.

## Functions

<table class="table">
  <thead>
    <tr>
            <th scope="col"> Name</th>
            <th scope="col"> Description</th>
    </tr>
  </thead>
  <tbody>
        <tr>
            <td>[draw_labels](`dascore.viz._labels.draw_labels`)</td>
            <td>Mark the stretch every label a coordinate states covers, and name them.</td>
        </tr>
        <tr>
            <td>[image_cell_edges](`dascore.viz._labels.image_cell_edges`)</td>
            <td>Where each cell of an image starts and ends, in axis units.</td>
        </tr>
        <tr>
            <td>[label_plan](`dascore.viz._labels.label_plan`)</td>
            <td>Return the coordinate to draw as labels, and the axis it lands on.</td>
        </tr>
        <tr>
            <td>[label_runs](`dascore.viz._labels.label_runs`)</td>
            <td>Return where the label changes, what it states, and of which kind.</td>
        </tr>
        <tr>
            <td>[mesh_cell_edges](`dascore.viz._labels.mesh_cell_edges`)</td>
            <td>Where each cell of a mesh starts and ends, in axis units.</td>
        </tr>
  </tbody>
</table>

## Classes

<table class="table">
  <thead>
    <tr>
            <th scope="col"> Name</th>
            <th scope="col"> Description</th>
    </tr>
  </thead>
  <tbody>
        <tr>
            <td>[LabelPlan](`dascore.viz._labels.LabelPlan`)</td>
            <td>Which coordinate a figure draws as labels, and where it goes.</td>
        </tr>
        <tr>
            <td>[LabelRuns](`dascore.viz._labels.LabelRuns`)</td>
            <td>Where a label coordinate changes, and what it states between.</td>
        </tr>
  </tbody>
</table>

