From 5cdd8dfed1af03e4c66b94a6e37951ab65e49a16 Mon Sep 17 00:00:00 2001 From: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Date: Tue, 6 Jul 2021 15:13:25 -0400 Subject: [PATCH] Docs: Removed folder and 3 files within. (#36487) --- docs/sources/panels/field-options/_index.md | 36 ----------- .../field-options/configure-all-fields.md | 51 --------------- .../configure-specific-fields.md | 64 ------------------- 3 files changed, 151 deletions(-) delete mode 100644 docs/sources/panels/field-options/_index.md delete mode 100644 docs/sources/panels/field-options/configure-all-fields.md delete mode 100644 docs/sources/panels/field-options/configure-specific-fields.md diff --git a/docs/sources/panels/field-options/_index.md b/docs/sources/panels/field-options/_index.md deleted file mode 100644 index 0a08b7c7fb5..00000000000 --- a/docs/sources/panels/field-options/_index.md +++ /dev/null @@ -1,36 +0,0 @@ -+++ -title = "Field options and overrides" -keywords = ["grafana", "field options", "documentation", "format fields"] -aliases = ["/docs/grafana/latest/panels/field-configuration-options/", "/docs/grafana/latest/panels/field-options/"] -weight = 500 -+++ - -# Field options and overrides - -This section explains what field options and field overrides in Grafana are and how to use them. It also includes [examples](#examples) if you need an idea of how this feature might be useful in the real world. - -The data model used in Grafana, the [data frame]({{< relref "../../developers/plugins/data-frames.md" >}}), is a columnar-oriented table structure that unifies both time series and table query results. Each column within this structure is called a _field_. A field can represent a single time series or table column. - -Field options allow you to change how the data is displayed in your visualizations. Options and overrides that you apply do not change the data, they change how Grafana displays the data. - -## Field options - -_Field options_, both standard and custom, can be found in the Field tab in the panel editor. Changes on this tab apply to all fields (i.e. series/columns). For example, if you change the unit to percentage, then all fields with numeric values are displayed in percentages. Learn how to apply a field option in [Configure all fields]({{< relref "configure-all-fields.md" >}}). - -## Field overrides - -_Field overrides_ can be added in the Overrides tab in the panel editor. There you can add the same options as you find in the Field tab, but they are only applied to specific fields. Learn how to apply an override in [Configure specific fields]({{< relref "configure-specific-fields.md" >}}). - -## Available field options and overrides - -Field option types are common to both field options and field overrides. The only difference is whether the change will apply to all fields (apply in the Field tab) or to a subset of fields (apply in the Overrides tab). - -- [Standard options]({{< relref "../standard-options.md" >}}) apply to all panel visualizations that allow transformations. -- [Table field options]({{< relref "../visualizations/table/table-field-options.md" >}}), which only apply to table panel visualizations. - -## Examples - -Here are some examples of how you might use this feature: - -- [Field option example]({{< relref "configure-all-fields.md#field-option-example" >}}) -- [Field override example]({{< relref "configure-specific-fields.md#field-override-example" >}}) diff --git a/docs/sources/panels/field-options/configure-all-fields.md b/docs/sources/panels/field-options/configure-all-fields.md deleted file mode 100644 index 834935a2246..00000000000 --- a/docs/sources/panels/field-options/configure-all-fields.md +++ /dev/null @@ -1,51 +0,0 @@ -+++ -title = "Configure all fields" -keywords = ["grafana", "field options", "documentation", "format fields", "change all fields"] -weight = 200 -+++ - -# Configure all fields - -To change how all fields display data, you can change an option in the Field tab. In the Overrides tab, you can then override the field options for [specific fields]({{< relref "configure-specific-fields.md" >}}). - -For example, you could change the number of decimal places shown in all fields by changing the **Decimals** option. For more information about options, refer to: - - [Standard options]({{< relref "../standard-options.md" >}}), apply to all visualizations that allow transformations. - - [Table field options]({{< relref "../visualizations/table/table-field-options.md" >}}), which only apply to table panel visualizations. - -## Change a field option - -You can change as many options as you want to. - -1. Navigate to the panel you want to edit, click the panel title, and then click **Edit**. -1. Click the **Field** tab. -1. Find the option you want to change. You can define: - - [Standard options]({{< relref "../standard-options.md" >}}), which apply to all panel visualizations that allow transformations. - - [Table field options]({{< relref "../visualizations/table/table-field-options.md" >}}), which only apply to table panel visualizations. -1. Add options by adding values in the fields. To return options to default values, delete the white text in the fields. -1. When finished, click **Save** to save all panel edits to the dashboard. - -## Field option example - -Let’s assume that our result set is a data frame that consists of two fields: time and temperature. - -| time | temperature | -| :-----------------: | :---------: | -| 2020-01-02 03:04:00 | 45.0 | -| 2020-01-02 03:05:00 | 47.0 | -| 2020-01-02 03:06:00 | 48.0 | - -Each field (column) of this structure can have field options applied that alter the way its values are displayed. This means that you can, for example, set the Unit to Temperature > Celsius, resulting in the following table: - -| time | temperature | -| :-----------------: | :---------: | -| 2020-01-02 03:04:00 | 45.0 °C | -| 2020-01-02 03:05:00 | 47.0 °C | -| 2020-01-02 03:06:00 | 48.0 °C | - -While we're at it, the decimal place doesn't add anything to this display. You can change the Decimals from `auto` to zero (`0`), resulting in the following table: - -| time | temperature | -| :-----------------: | :---------: | -| 2020-01-02 03:04:00 | 45 °C | -| 2020-01-02 03:05:00 | 47 °C | -| 2020-01-02 03:06:00 | 48 °C | diff --git a/docs/sources/panels/field-options/configure-specific-fields.md b/docs/sources/panels/field-options/configure-specific-fields.md deleted file mode 100644 index 49dcfcfd54a..00000000000 --- a/docs/sources/panels/field-options/configure-specific-fields.md +++ /dev/null @@ -1,64 +0,0 @@ -+++ -title = "Configure specific fields" -keywords = ["grafana", "field options", "documentation", "format fields", "overrides", "override fields"] -weight = 300 -+++ - -# Configure specific fields - -Overrides allow you to change the settings for one or more fields. Field options for overrides are exactly the same as the field options available in a particular visualization. The only difference is that you choose which fields to apply them to. - -For example, you could change the number of decimal places shown in all numeric fields or columns by changing the **Decimals** option for **Fields with type** that matches **Numeric**. For more information about options, refer to: - - [Standard options]({{< relref "../standard-options.md" >}}), which apply to all panel visualizations that allow transformations. - - [Table field options]({{< relref "../visualizations/table/table-field-options.md" >}}), which only apply to table panel visualizations. - -## Add a field override - -You can override as many field options as you want to. - -1. Navigate to the panel you want to edit, click the panel title, and then click **Edit**. -1. Click the **Overrides** tab. -1. Click **Add an override for**. -1. Select which fields an override rule will be applied to: - - **Fields with name -** Select a field from the list of all available fields. Properties you add to a rule with this selector are only applied to this single field. - - **Fields with name matching regex -** Specify fields to override with a regular expression. Properties you add to a rule with this selector are applied to all fields where the field name match the regex. - - **Fields with type -** Select fields by type, such as string, numeric, and so on. Properties you add to a rule with this selector are applied to all fields that match the selected type. - - **Fields returned by query -** Select all fields returned by a specific query, such as A, B, or C. Properties you add to a rule with this selector are applied to all fields returned by the selected query. -1. Click **Add override property**. -1. Select the field option that you want to apply. - - [Standard options]({{< relref "../standard-options.md" >}}), which apply to all panel visualizations that allow transformations. - - [Table field options]({{< relref "../visualizations/table/table-field-options.md" >}}), which only apply to table panel visualizations. -1. Enter options by adding values in the fields. To return options to default values, delete the white text in the fields. -1. Continue to add overrides to this field by clicking **Add override property**, or you can click **Add override** and select a different field to add overrides to. -1. When finished, click **Save** to save all panel edits to the dashboard. - -## Delete a field override - -1. Navigate to the Overrides tab that contains the override that you want to delete. -1. Click the trash can icon next to the override. - -## Field override example - -Let’s assume that our result set is a data frame that consists of four fields: time, high temp, low temp, and humidity. - -| time | high temp | low temp | humidity | -| ------------------- | --------- | -------- | -------- | -| 2020-01-02 03:04:00 | 45.0 | 30.0 | 67 | -| 2020-01-02 03:05:00 | 47.0 | 34.0 | 68 | -| 2020-01-02 03:06:00 | 48.0 | 31.0 | 68 | - -Let's apply the field options from the [field option example]({{< relref "configure-all-fields.md#field-option-example" >}}) to apply the Celsius unit and get rid of the decimal place. This results in the following table: - -| time | high temp | low temp | humidity | -| ------------------- | --------- | -------- | -------- | -| 2020-01-02 03:04:00 | 45 °C | 30 °C | 67 °C | -| 2020-01-02 03:05:00 | 47 °C | 34 °C | 68 °C | -| 2020-01-02 03:06:00 | 48 °C | 31 °C | 68 °C | - -The temperature fields look good, but the humidity is nonsensical. We can fix this by applying a field option override to the humidity field and change the unit to Misc > percent (0-100). This results in a table that makes a lot more sense: - -| time | high temp | low temp | humidity | -| ------------------- | --------- | -------- | -------- | -| 2020-01-02 03:04:00 | 45 °C | 30 °C | 67% | -| 2020-01-02 03:05:00 | 47 °C | 34 °C | 68% | -| 2020-01-02 03:06:00 | 48 °C | 31 °C | 68% |