IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Canvas Create a workpad »
Elastic Docs ›Kibana Guide [7.8] ›Canvas

Canvas tutorial

edit

Canvas tutorial

edit

To get up and running with Canvas, use the following tutorial where you’ll create a display for monitoring sales at an eCommerce store.

Before you begin

edit

For this tutorial, you’ll need to add the Sample eCommerce orders data.

Create your workpad

edit

Your first step to working with Canvas is to create a workpad.

  1. Open the menu, then go to Canvas.
  2. On the Canvas workpads page, click Create workpad.

Customize your workpad with images

edit

To customize your workpad to look the way you want, add your own images.

  1. Click Add element > Image > Image.

    The default Elastic logo image appears on the page.

  2. To replace the Elastic logo with your own image, select the image, then use the editor.
canvas image element

Customize your data with metrics

edit

Customize your data by connecting it to the Sample eCommerce orders data.

  1. Click Add element > Chart > Metric.

    By default, the element is connected to the demo data, which enables you to experiment with the element before you connect it to your own data source.

  2. To connect the element to your own data source, make sure that the element is selected, click Data > Demo data > Elasticsearch SQL.

    1. In the Query field, enter the following:

      SELECT sum(taxless_total_price) AS sum_total_price FROM "kibana_sample_data_ecommerce"

    2. Click Save.

      The query selects the total price field and sets it to the sum_total_price field. All fields are pulled from the kibana_sample_data_ecommerce index.

  3. At this point, the element appears as an error, so you need to change the element display options.

    1. Click Display
    2. From the Value drop-down lists, make sure that Unique is selected, then select sum_total_price.
    3. Change the Label to Total sales.

  4. The error is gone, but the element could use some formatting. To format the number, use the Canvas expression language.

    1. Click Expression editor.

      You’re now looking at the raw data syntax that Canvas uses to display the element.

    2. Change metricFormat="0,0.[000]" to metricFormat="$0a".
    3. Click Run.
canvas metric element

Show off your data with charts

edit

To show what your data can do, add charts, graphs, progress monitors, and more to your workpad.

  1. Click Add element > Chart > Area.

  2. Make sure that the element is selected, then click Data > Demo data > Elasticsearch SQL.

    1. To obtain the taxless total price by date, enter the following in the Query field:

      SELECT order_date, taxless_total_price FROM "kibana_sample_data_ecommerce" ORDER BY order_date

    2. Click Save.

  3. Change the display options.

    1. Click Display
    2. From the X-axis drop-down lists, select Value, then select order_date.
    3. From the Y-axis drop-down lists, select Value, then select taxless_total_price.
canvas chart element

Show how your data changes over time

edit

To focus your data on a specific time range, add the time filter.

  1. Click Add element > Filter > Time filter.
  2. Click Display
  3. To use the date time field from the sample data, enter order_date in the Column field, then click Set.
canvas timefilter element

To see how the data changes, set the time filter to Last 7 days. As you change the time filter options, the elements automatically update.

Your workpad is now complete!

Next steps

edit

Now that you know the Canvas basics, you’re ready to explore on your own.

Here are some things to try:

« Canvas Create a workpad »