***************
Slice Reference
***************

.. include:: ../../complete.rst

This is a collection of recipes and examples that describe the files in a
Juicebox app.

.. toctree::
        :maxdepth: 2

        global_filters
        bubble
        card
        distribution
        flower
        freeform
        keymetrics_hierarchy
        leaderboard
        lollipop
        matchup
        map
        nine_box
        option_chooser
        orbit
        ranked_list
        ranked_list_v2
        sankey
        table
        trend
        timeseries


Built-in slices
===============

.. list-table::
 :header-rows: 1

 * - Slice
   - What it looks like
   - Shortcuts

 * - :doc:`global_filters`
   -
   - .. toctree::
        :maxdepth: 2

        global_filters

 * - :doc:`bubble`
   - .. image:: images/bubble.png
      :width: 200 px
      :target: ./bubble.html
   - .. toctree::
        :maxdepth: 2

        bubble

 * - :doc:`card`
   - .. image:: images/card-default.png
      :width: 200 px
      :target: ./card.html
   - .. toctree::
        :maxdepth: 2

        card

 * - :doc:`distribution`
   - .. image:: images/distribution-default.png
      :width: 200 px
      :target: ./distribution.html
   - .. toctree::
        :maxdepth: 2

        distribution

 * - :doc:`flower`
   - .. image:: images/flower-default.png
      :width: 200 px
      :target: ./flower.html
   - .. toctree::
        :maxdepth: 2

        flower

 * - :doc:`freeform`
   - .. image:: images/freeform-default.png
      :width: 200 px
      :target: ./freeform.html
   - .. toctree::
        :maxdepth: 2

        freeform

 * - :doc:`keymetrics_hierarchy`

     .. note:: This is sometimes called the "squid" slice.

   - .. image:: images/keymetrics_hierarchy-default.png
      :width: 200 px
      :target: ./keymetrics_hierarchy.html
   - .. toctree::
        :maxdepth: 2

        keymetrics_hierarchy

 * - :doc:`leaderboard`
   - .. image:: images/leaderboard-default.png
      :width: 200 px
      :target: ./leaderboard.html
   - .. toctree::
        :maxdepth: 2

        leaderboard

 * - :doc:`lollipop`
   - .. image:: images/lollipop-singledimension.png
      :width: 200 px
      :target: ./lollipop.html
   - .. toctree::
        :maxdepth: 2

        lollipop

 * - :doc:`matchup`
   - .. image:: images/matchup-default.png
      :width: 200 px
      :target: ./matchup.html
   - .. toctree::
        :maxdepth: 2

        matchup

 * - :doc:`map`
   - .. image:: images/map-default.png
      :width: 200 px
      :target: ./map.html
   - .. toctree::
        :maxdepth: 2

        map

 * - :doc:`nine_box`
   - .. image:: images/ninebox-dualmetric.png
      :width: 200 px
      :target: ./nine_box.html
   - .. toctree::
        :maxdepth: 2

        nine_box

 * - :doc:`option_chooser`
   - .. image:: images/optionchooser-default.png
      :width: 200 px
      :target: ./option_chooser.html
   - .. toctree::
        :maxdepth: 2

        option_chooser

 * - :doc:`orbit`
   - .. image:: images/orbit-default.png
      :width: 200 px
      :target: ./orbit.html
   - .. toctree::
        :maxdepth: 2

        orbit

 * - :doc:`ranked_list`

     .. warning::

        Deprecated, support will drop in jb4. Use ranked list v2 instead.

   - .. image:: images/rankedlist-singledim.png
      :width: 200 px
      :target: ./ranked_list.html
   - .. toctree::
        :maxdepth: 2

        ranked_list

 * - :doc:`ranked_list_v2`
   - .. image:: images/ranked-list-v2.gif
      :width: 200 px
      :target: ./ranked_list_v2.html
   - .. toctree::
        :maxdepth: 2

        ranked_list_v2

 * - :doc:`sankey`
   - .. image:: images/sankey-bilevel.png
      :width: 200 px
      :target: ./sankey.html
   - .. toctree::
        :maxdepth: 2

        sankey

 * - :doc:`table`
   - .. image:: images/table-default.png
      :width: 200 px
      :target: ./table.html
   - .. toctree::
        :maxdepth: 2

        table

 * - :doc:`trend`
   - .. image:: images/trend-ranged.png
      :width: 200 px
      :target: ./trend.html
   - .. toctree::
        :maxdepth: 2

        trend

 * - :doc:`timeseries`
   - .. image:: images/timeseries.jpg
      :width: 200 px
      :target: ./timeseries.html
   - .. toctree::
        :maxdepth: 2

        timeseries