You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by sr...@apache.org on 2021/12/04 15:28:19 UTC

[superset] branch master updated: add a native filters section to the exploring data docs (#17605)

This is an automated email from the ASF dual-hosted git repository.

srini pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/master by this push:
     new 8e02d11  add a native filters section to the exploring data docs (#17605)
8e02d11 is described below

commit 8e02d119098c772d0613af69fd44f92eb31dca59
Author: Moriah Kreeger <mo...@gmail.com>
AuthorDate: Sat Dec 4 07:26:34 2021 -0800

    add a native filters section to the exploring data docs (#17605)
---
 docs/gatsby-node.js                                |   5 +++
 .../exploring-data.mdx                             |  45 +++++++++++++++++++++
 docs/static/images/native_filters_empty_panel.png  | Bin 0 -> 19674 bytes
 docs/static/images/native_filters_menu_open.png    | Bin 0 -> 17968 bytes
 docs/static/images/native_filters_modal.png        | Bin 0 -> 196153 bytes
 docs/static/images/native_filters_num_range.png    | Bin 0 -> 22073 bytes
 .../images/native_filters_origin_country.png       | Bin 0 -> 196016 bytes
 .../native_filters_origin_country_dropdown.png     | Bin 0 -> 71696 bytes
 8 files changed, 50 insertions(+)

diff --git a/docs/gatsby-node.js b/docs/gatsby-node.js
index 6c08f6d..0ffff7f 100644
--- a/docs/gatsby-node.js
+++ b/docs/gatsby-node.js
@@ -315,6 +315,11 @@ exports.createPages = ({ actions }) => {
     isPermanent: true,
   });
   createRedirect({
+    fromPath: '/usertutorial.html#native-filters',
+    toPath: '/docs/creating-charts-dashboards/exploring-data',
+    isPermanent: true,
+  });
+  createRedirect({
     fromPath: '/usertutorial.html#publishing-your-dashboard',
     toPath: '/docs/creating-charts-dashboards/exploring-data',
     isPermanent: true,
diff --git a/docs/src/pages/docs/Creating Charts and Dashboards/exploring-data.mdx b/docs/src/pages/docs/Creating Charts and Dashboards/exploring-data.mdx
index 0857f36..dd125da 100644
--- a/docs/src/pages/docs/Creating Charts and Dashboards/exploring-data.mdx	
+++ b/docs/src/pages/docs/Creating Charts and Dashboards/exploring-data.mdx	
@@ -223,6 +223,51 @@ Dashboard and then Save & go to dashboard. Once on the Dashboard, try using the
 those flights that departed from the United Kingdom – you will see the filter is applied to all of
 the other visualizations on the dashboard.
 
+### Native Filters
+
+As Filter Box is set to be deprecated, this section will instruct you on how to use its replacement,
+**Native Filters**. These are built into the dashboard view itself. Go to the Tutorial Dashboard and
+select the filter icon in the top left corner:
+
+<img src="/images/native_filters_menu_open.png" />
+
+This will open the Native Filters panel, which is currently empty:
+
+<img src="/images/native_filters_empty_panel.png" />
+
+Click on the pencil icon to open up the **Filters Configuration** modal. From here, you can create new filters or
+manage existing ones.
+
+<img src="/images/native_filters_modal.png" />
+
+We're going to create a numerical range for ticket cost:
+
+- Select Numerical Range from the Filter Type dropdown
+- Give the filter a name
+- Select tutorial_flights from the Dataset dropdown if it's not been selected yet
+- Select Cost from the Column dropdown
+
+Click the **Save** button. Your filter will load in the panel.
+
+<img src="/images/native_filters_num_range.png" />
+
+You can adjust the slider to only include datapoints that fall within the selected range for Ticket
+Cost! Set your range and click **Apply** to see how it affects your charts.
+
+We can also recreate the Origin Country filter from the Filter Box section. In the **Filters
+Configuration** modal, click the Add button in the bottom left and select Filter. Set your filter up as
+follows:
+
+- Select Value from Filter Type dropdown
+- Select tutorial_flights from Dataset dropdown
+- Select Origin Country from Column dropdown
+- In Advanced, you can tick the Sort filter values checkbox to list country names alphabetically
+
+**Save** your filters! You can now select origin countries to include from the resulting dropdown.
+
+<img src="/images/native_filters_origin_country.png" />
+<img src="/images/native_filters_origin_country_dropdown.png" />
+
 ### Publishing Your Dashboard
 
 If you have followed all of the steps outlined in the previous section, you should have a dashboard
diff --git a/docs/static/images/native_filters_empty_panel.png b/docs/static/images/native_filters_empty_panel.png
new file mode 100644
index 0000000..999cc70
Binary files /dev/null and b/docs/static/images/native_filters_empty_panel.png differ
diff --git a/docs/static/images/native_filters_menu_open.png b/docs/static/images/native_filters_menu_open.png
new file mode 100644
index 0000000..82b539e
Binary files /dev/null and b/docs/static/images/native_filters_menu_open.png differ
diff --git a/docs/static/images/native_filters_modal.png b/docs/static/images/native_filters_modal.png
new file mode 100644
index 0000000..c27e7c5
Binary files /dev/null and b/docs/static/images/native_filters_modal.png differ
diff --git a/docs/static/images/native_filters_num_range.png b/docs/static/images/native_filters_num_range.png
new file mode 100644
index 0000000..17d2534
Binary files /dev/null and b/docs/static/images/native_filters_num_range.png differ
diff --git a/docs/static/images/native_filters_origin_country.png b/docs/static/images/native_filters_origin_country.png
new file mode 100644
index 0000000..06096e90
Binary files /dev/null and b/docs/static/images/native_filters_origin_country.png differ
diff --git a/docs/static/images/native_filters_origin_country_dropdown.png b/docs/static/images/native_filters_origin_country_dropdown.png
new file mode 100644
index 0000000..296d413
Binary files /dev/null and b/docs/static/images/native_filters_origin_country_dropdown.png differ