Permalink
Browse files

Make index page for widgets

  • Loading branch information...
thomashumio committed Oct 11, 2018
1 parent d6d199c commit 99c7927b116c0f2f50d87d2f534b587958130ac0
@@ -0,0 +1,16 @@
---
title: Widgets
category_title: "Overview"
weight: 590
---

Widgets are the UI elements that visualize query results. E.g. you can show
results as a table or time chart.

This section introduces each widget and give examples of queries that could
be used along with them.

The widget that is used most frequently is the [Time Chart Widget]({{< ref "time-chart.md" >}})
and working with time charts is a good skill to master when working with Humio.

{{%children%}}
@@ -1,6 +1,7 @@
---
title: Bar Chart
aliases: ['ref/chart/bar-chart']
weight: 700
---

The _Bar Chart_ widget can be used to visualize results of the {{< function "groupBy" >}}
@@ -1,6 +1,7 @@
---
title: Event List
aliases: ['ref/chart/event-list']
weight: 100
---

The _Event List_ widget is meant to display events as their roll into Humio. It
@@ -24,7 +25,7 @@ The inspection panel contains buttons to quickly drill down the data.

The event list will as many results as returned by the Humio server which defaults
to the `200` most recent events of the search interval. You can increase this
my using the {{< function "tail" >}} function, e.g. {{< code "tail(1000)" >}},
my using the {{< function "tail" >}} function, e.g. {{< query "tail(1000)" >}},
but this can cause performance issues in the UI if too elements have to be rendered.

### Keyboard Navigation
@@ -1,6 +1,7 @@
---
title: Gauge Widget
title: Gauge
aliases: ['ref/chart/gauge']
weight: 600
---

The _Gauge_ Widget be used to display a single number. This is useful for displaying
@@ -1,6 +1,7 @@
---
title: Pie Chart Widget
title: Pie Chart
aliases: ['ref/chart/pie-chart']
weight: 800
---

The _Pie Chart_ widget can be used to visualize results of the {{< function "groupBy" >}}
@@ -1,6 +1,7 @@
---
title: Sankey Widget
title: Sankey
aliases: ['ref/chart/sankey']
weight: 400
---

The _Sankey_ Widget can render results as a 2 level sankey diagram. It is good at displaying
@@ -1,6 +1,7 @@
---
title: Table Widget
title: Table
aliases: ['ref/chart/table']
weight: 300
---

The _Table_ widget can be used to display data in rows and columns.
@@ -1,6 +1,7 @@
---
title: Time Chart Widget
title: Time Chart
aliases: ['ref/chart/time-chart']
weight: 200
---

The _time chart_ widget can display bucketed time series data on a time line. It is
@@ -1,6 +1,7 @@
---
title: World Map Widget
title: World Map
aliases: ['ref/chart/world-map']
weight: 500
---

The _world map_ widget can display geographical data on a world map. Different

0 comments on commit 99c7927

Please sign in to comment.