=======================
Key Metrics Hierarchy
=======================

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

.. contents::

A Key Metrics Hierarchy slice consists of a series of ranked nodes. Arrows can emanate to or from nodes to show the direction of flow. Some nodes include multiple pieces of data in it. The metrics in each node of the tree are comprised of the metrics that point to it.

This slice is sometimes called the “squid” slice.


Key Metrics Hierarchy config
================================

Key Metrics Hierarchy slices support the :doc:`common_configuration`.
Additional options are:

height (kmh)
------------------

The height of the visual component.

:Optional: Yes, defaults to 420.

:Values: numbers (in pixels)
:Example:
  .. code-block:: python

      config:
        height: 800

width (kmh)
---------------

The width of the visual component.

:Optional: Yes, defaults to 800

:Values: numbers (in pixels)
:Example:
  .. code-block:: python

      config:
        width: 600

margin (kmh)
------------

The margins of the visual component.

:Optional: Yes, defaults to ``{top: 40, right: 10, bottom: 10, left: 40}``

:Values: JS object with "top", "bottom", "left" and "right" properties
:Example:
  .. code-block:: python

      config:
        margin: {top: 60, right: 20, bottom: 100, left: 20}

orient
-----------

Orientation of the hierarchy.

:Optional: Yes, default is "top-to-bottom"

:Values: "top-to-bottom" or "bottom-to-top" or "left-to-right" or "right-to-left"
:Example:
  .. code-block:: python

      config:
        orient: "left-to-right"

radius
---------
The radius of the nodes.

:Optional: Yes, default is 25.

:Values: number (in pixels)
:Example:
  .. code-block:: python

      config:
        radius: 20

groupLeafNodes
--------------------------

A flag that indicates if the leaf nodes should be grouped.

:Optional: Yes, default is ``true``.

:Values: true|false
:Example:
    .. code-block:: python

        config:
            groupLeafNodes: false


Flavors of Key Metrics Hierarchy
================================

TBD