=============
Orbit
=============

.. include:: ../../incomplete.rst

.. contents::

In an Orbit slice, data is presented as nodes on a circle. Each node shows how a group of entities are connected. 


Orbit config
============

Orbit slices support the :doc:`common_configuration`. Additional config options are:

showLinks
---------

If true, show the orbit slice with lines connecting each level.

.. image:: https://user-images.githubusercontent.com/37118/179015426-36f3f27c-d613-412b-92a5-8c4f298107be.png
        :width: 640

If false, show the orbit slice as a series of circles.

.. image:: https://user-images.githubusercontent.com/37118/178973853-b7a3ba66-47fb-4b01-a0c8-40c177ef4b9a.png
        :width: 640

:Optional: Yes, default is false
:Values: true|false
:Example:
  .. code-block:: python

      config:
        showLinks: true

sizeField (orbit)
------------------

The field in each response item to use for sizing

:Optional: Yes, default "value"
:Values: a string representing a key in each response row
:Example:
  .. code-block:: python

      config:
        sizeField: sizeField

sizeRange (orbit)
------------------

The range of values to use when sizing circles

:Optional: Yes
:Values: A list of two numbers
:Example:
  .. code-block:: python

      config:
        sizeField: average_tenure
        sizeRange: [10, 200]

colorField (orbit)
------------------

The field in each response item to use for coloring circles

:Optional: Yes, default "value"
:Values: a string representing a key in each response row
:Example:
  .. code-block:: python

      config:
        colorField: average_tenure

colorRange (orbit)
------------------

The range of colors to use for colored circles.

:Optional: Yes, default "value"
:Values: a list of color strings
:Example:
  .. code-block:: python

      config:
        colorField: average_tenure
        colorRange: ["#666666", "#ff7700"]

visibleNodeDepths
-----------------

The range of values relative to the selected node that determines
if other nodes are visible. Higher numbers will show more nodes.

:Optional: Yes, default [1, 1]
:Values: A pair of numbers
:Example:
  .. code-block:: python

      config:
        visibleNodeDepths: [1, 1]

visibleRingDepths
-----------------

The range of values relative to the selected node that determines
if other rings are visible. Higher numbers will show more rings.

:Optional: Yes, default [1, 0]
:Values: A pair of numbers
:Example:
  .. code-block:: python

      config:
        visibleRingDepths: [1, 1]



Flavors of Orbit
================

.. todo::
  Describe how there are no flavors of Orbit and it needs a custom data
  service.