Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex DataLens
  • Getting started
  • Practical guidelines
    • All tutorials
    • Visualizing data from a CSV file
    • Creating and publishing a chart with a map of Moscow from a CSV file
    • Analyzing a retail chain's sales from a ClickHouse database
    • Analyzing public data on road accidents in Russia
    • Analyzing sales and locations of pizzerias based on data from ClickHouse DB and Marketplace
    • Web analytics with a connection to Yandex Metrica
    • Web analytics with funnels and cohorts calculated based on Yandex Metrica data
    • Mobile app analytics based on AppMetrica data
    • Analyzing Yandex Music podcast statistics (for podcasters)
    • Visualizing data with a QL chart
    • Visualizing data using parameters
    • Visualizing Yandex Monitoring data
    • Building customer journey charts based on AppMetrica data
  • Concepts
    • Service overview
    • Organizations in DataLens
    • Connection
    • Data types
    • Datasets
      • Overview
      • Data model
      • Dataset settings
    • Charts
      • Overview
      • Chart settings
      • Measure Values and Measure Names
    • Dashboards
    • Joining data
    • Using Markdown in DataLens
    • DataLens Public
    • Calculated fields
      • Overview
      • Formula syntax
    • Parameterization
    • Marketplace
    • Backups
    • Caching
    • Quotas and limits
  • Step-by-step instructions
    • All instructions
    • Working with connections
      • Creating a ClickHouse connection
      • Creating a connection to a file
      • Creating a Google Sheets connection
      • Creating a MySQL connection
      • Creating a PostgreSQL connection
      • Creating a SQL Server connection
      • Creating a BigQuery connection
      • Creating an Oracle Database connection
      • Creating a YDB connection
      • Creating a Greenplum® connection
      • Creating a Prometheus connection
      • Creating a Yandex Monitoring connection
      • Creating a Yandex Metrica API connection
      • Creating an AppMetrica connection
      • Creating a Yandex Cloud Billing connection
      • Managing connection access
    • Working with datasets
      • Creating a dataset
      • Combining data from multiple tables
      • Creating a data field
      • Creating a calculated data field
      • Creating a default filter for new charts
      • Updating fields in datasets
      • Describing a dataset via a source SQL query
      • Managing dataset access
      • Managing access to data rows
      • Adding parameters to a dataset
    • Working with charts
      • Creating a chart
      • Creating a QL chart
      • Creating a multi-dataset chart
      • Adding a hierarchy
      • Configuring the navigator
      • Publishing a chart
      • Managing chart access
      • Adding ID as a parameter
      • Adding parameters to a chart
      • Configuring the display of null values
    • Working with dashboards
      • Creating dashboards
      • Adding charts to dashboards
      • Adding selectors to dashboards
      • Creating an alias
      • Deleting an alias field
      • Publishing dashboards
      • Managing dashboard access
      • Adding parameters to a dashboard
      • Dashboard auto-update
      • Widget display order on a mobile device
    • Working with permissions
      • Granting permissions
      • Deleting permissions
      • Request permissions
    • Working with DataLens Marketplace
      • Adding a product from Marketplace
      • Removing a product from Marketplace
      • Creating and connecting a connector (for partners)
    • Working with organizations
      • Switching between DataLens instances
  • Access management
    • Managing access to DataLens
    • Managing access at the data row level
  • Pricing policy
  • Visualization reference
    • All visualizations
    • Line chart
    • Stacked area chart
    • Normalized stacked area chart
    • Column chart
    • Normalized column chart
    • Bar chart
    • Normalized bar chart
    • Scatter chart
    • Pie chart
    • Indicator
    • Tree chart
    • Donut chart
    • Table
    • Pivot table
    • Map
      • Overview
      • Point map
      • Point map with clusters
      • Polyline map
      • Choropleth map
      • Heat map
    • Combined chart
  • Function reference
    • All Functions
    • Aggregate functions
      • Overview
      • ALL_CONCAT
      • ANY
      • ARG_MAX
      • ARG_MIN
      • AVG
      • AVG_IF
      • COUNT
      • COUNTD
      • COUNTD_APPROX
      • COUNTD_IF
      • COUNT_IF
      • MAX
      • MEDIAN
      • MIN
      • QUANTILE
      • QUANTILE_APPROX
      • STDEV
      • STDEVP
      • SUM
      • SUM_IF
      • TOP_CONCAT
      • VAR
      • VARP
    • Array functions
      • Overview
      • ARRAY
      • ARR_AVG
      • ARR_MAX
      • ARR_MIN
      • ARR_PRODUCT
      • ARR_REMOVE
      • ARR_STR
      • ARR_SUM
      • CAST_ARR_FLOAT
      • CAST_ARR_INT
      • CAST_ARR_STR
      • CONTAINS
      • COUNT_ITEM
      • GET_ITEM
      • REPLACE
      • SLICE
      • STARTSWITH
      • UNNEST
    • Date/Time functions
      • Overview
      • DATEADD
      • DATEPART
      • DATETRUNC
      • DAY
      • DAYOFWEEK
      • HOUR
      • MINUTE
      • MONTH
      • NOW
      • QUARTER
      • SECOND
      • TODAY
      • WEEK
      • YEAR
    • Logical functions
      • Overview
      • CASE
      • IF
      • IFNULL
      • ISNULL
      • ZN
    • Mathematical functions
      • Overview
      • ABS
      • ACOS
      • ASIN
      • ATAN
      • ATAN2
      • CEILING
      • COMPARE
      • COS
      • COT
      • DEGREES
      • DIV
      • EXP
      • FLOOR
      • GREATEST
      • LEAST
      • LN
      • LOG
      • LOG10
      • PI
      • POWER
      • RADIANS
      • ROUND
      • SIGN
      • SIN
      • SQRT
      • SQUARE
      • TAN
    • Operators
      • Overview
      • AND
      • Addition and concatenation (+)
      • BETWEEN
      • Comparison
      • Division (/)
      • IN
      • IS FALSE
      • IS TRUE
      • LIKE
      • Modulo (%)
      • Multiplication (*)
      • NOT
      • Negation (-)
      • OR
      • Power (^)
      • Subtraction (-)
    • String functions
      • Overview
      • ASCII
      • CHAR
      • CONCAT
      • CONTAINS
      • ENDSWITH
      • FIND
      • ICONTAINS
      • IENDSWITH
      • ISTARTSWITH
      • LEFT
      • LEN
      • LOWER
      • LTRIM
      • REGEXP_EXTRACT
      • REGEXP_EXTRACT_NTH
      • REGEXP_MATCH
      • REGEXP_REPLACE
      • REPLACE
      • RIGHT
      • RTRIM
      • SPACE
      • SPLIT
      • STARTSWITH
      • SUBSTR
      • TRIM
      • UPPER
      • UTF8
    • Text markup functions
      • Overview
      • BOLD
      • ITALIC
      • MARKUP
      • URL
    • Time series functions
      • Overview
      • AGO
      • AT_DATE
    • Type conversion functions
      • Overview
      • BOOL
      • DATE
      • DATETIME
      • DATETIME_PARSE
      • DATE_PARSE
      • DB_CAST
      • FLOAT
      • GEOPOINT
      • GEOPOLYGON
      • INT
      • STR
    • Window functions
      • Overview
      • AVG
      • AVG_IF
      • COUNT
      • COUNT_IF
      • FIRST
      • LAG
      • LAST
      • MAVG
      • MAX
      • MCOUNT
      • MIN
      • MMAX
      • MMIN
      • MSUM
      • RANK
      • RANK_DENSE
      • RANK_PERCENTILE
      • RANK_UNIQUE
      • RAVG
      • RCOUNT
      • RMAX
      • RMIN
      • RSUM
      • SUM
      • SUM_IF
    • Function Availability
  • Function tutorials
    • Aggregate functions
    • Window functions
    • LOD expressions and filtering in aggregate functions
  • Public materials
    • Educational projects
    • Webinars and conferences
    • Articles and publications
    • Public dashboards and charts
  • Troubleshooting
    • Questions and answers
    • DataLens errors
  1. Concepts
  2. Using Markdown in DataLens

Using Markdown in DataLens

Written by
Yandex Cloud
  • Headers
  • Highlighting text
  • Lists
    • Simple unordered list
    • Nested unordered list
    • Simple ordered list
    • Nested ordered list
  • Tables
  • Links
  • Code formatting
    • Inline code snippet
    • Code block
  • Image
  • Cuts

DataLens allows you to use the Markdown markup language in the Text widget on the dashboard.
You can insert explanatory text, links, tables, images, or use formatting to highlight key points.

In text widgets, you can use the following elements:

  • Headers
  • Bold and italics
  • Lists
    • Simple unordered list
    • Nested unordered list
    • Simple ordered list
    • Nested ordered list
  • Tables
  • Links
  • Code formatting
    • Inline code snippet
    • Code block
  • Image
  • Cuts

Headers

You can use four levels of headings in the widget.
Use # to mark up headings.

Syntax example:

# Level 1 heading
## Level 2 heading
### Level 3 heading
#### Level 4 heading

Highlighting text

Use formatting to highlight key points in your text:

  • To make text bold, use double *:

    This text will be **bold**.
    
  • To make text italic, use _:

    This text will be _italic_.
    
  • To combine bold and italics, use double * and _ at the same time:

    This text will be _**bold and italic**_.
    This text will be **_bold and italic_**.
    

Lists

You can use multiple list types to arrange the data on the dashboard.

Simple unordered list

To make an unordered bulleted list, use characters such as *, -, or +.

For example, the following markup:

* Item 1
* Item 2
* Item 3

will be displayed as:

  • Item 1
  • Item 2
  • Item 3

Nested unordered list

To make a nested unordered list, add an indent for the lines with the nested list items. The indent can be from two to five spaces.

For example, the following markup:

- Item 1
   - Item A
   - Item B
- Item 2

will be displayed as:

  • Item 1
    • Item A
    • Item B
  • Item 2

Simple ordered list

To make an ordered list, use numbers with a . or ).

For example, the following markup:

1. First item
1. Second item
1. Third item

will be displayed as:

  1. First item
  2. Second item
  3. Third item

Nested ordered list

To make a nested ordered list, add an indent for the lines with the nested list items. The indent can be from three to six spaces.

For example, the following markup:

1. First item
   1. Nested item
   1. Nested item
1. Second item

will be displayed as:

  1. First item

    1.1. Nested item

    1.2 Nested item

  2. Second item

Tables

A table consists of a single row with headers, a separator row, and rows with data.

Each row in a table consists of cells that are separated from each other by a |.

The cells of the separator row only allow the - character and : character. The colon (:) is used at the beginning, end, or on both sides of the cell content of the separator row to indicate left, right, or center alignment of text in the corresponding column, respectively.

A table should be separated from the surrounding text with empty lines.

For example, the following markup:

Left-aligned | Right-aligned | Centered
:--- | ---: | :---:
Text | Text | Text

will be displayed as:

Left-aligned Right-aligned Centered
Text Text Text

To add a line break or a more complex element (such as a list or code block) to a table cell, use an alternative markup:

#|
|| **Header1** | **Header2** ||
|| Text | Text ||
|#

Sample markup with line breaks and a list:

#|
||Text
on two lines
|
- Item 1
- Item 2
- Item 3
- Item 4||
|#

See learn more in the YFM documentation.

Links

You can use links to enter information related to the dashboard or charts.
For example, you can add links to other dashboards and specify data sources.

A link consists of two parts:

  • [text] is the link text.
  • (link) is the URL or path to the file referenced.

For example, the following markup:

[link to yandex.ru](https://yandex.ru).

will be displayed as:

link to yandex.ru.

Code formatting

You can use inline code snippets or code blocks.

Inline code snippet

Use ` to format inline code snippets.

For example, the following markup:

A sentence with a `code snippet`.

will be displayed as:

A sentence with a code snippet.

Code block

Use triple ` and the programming language name to format your snippet as a code block.

For example, the following markup:

    ```kotlin
    val a: Int = 1
    ```

will be displayed as a highlighted Kotlin code snippet:

val a: Int = 1

Image

To insert an image in the widget, use Yandex Object Storage. You can use it for free for up to 1 GB of standard storage per month.

To upload an image to the widget:

  1. Open the management console and select Object Storage in the menu on the left.

  2. Create a bucket with public access.

  3. Upload the image to the bucket

  4. Go to the resulting object and click Get link.

  5. Copy the link to the image.

  6. Go to your DataLens dashboard and create a widget named Text.

  7. Paste the following code in the widget:

    ![alt text](https://image_link "Text of a hint displayed when hovering over the image" =100x200)
    

Cuts

Use cuts to hide content. For example, additional information or long blocks of code.

For example, the following markup:


{% cut "Title of the text to cut" %}

The content to be displayed when you click it.

{% endcut %}

will be displayed as:

Title of the text to cut

The content to be displayed when you click it.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • Headers
  • Highlighting text
  • Lists
  • Simple unordered list
  • Nested unordered list
  • Simple ordered list
  • Nested ordered list
  • Tables
  • Links
  • Code formatting
  • Inline code snippet
  • Code block
  • Image
  • Cuts