github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

Updates field formatters documentation.

Browse source
This commit is contained in:
Paul Echeverri 2015-08-04 12:42:35 -07:00 • committed by Paul Echeverri
parent c5f85c3f94
commit 53c43f01b6
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/url-formatter.asciidoc
View file

@ -1,7 +1,7 @@
The `Url` field formatter can take on the following types:
* The *Link* type turn the contents of the field into an URL.
* The *Image* type can be used to // what?
* The *Image* type can be used to specify an image directory where a specified image is located.
You can customize either type of URL field formats with templates. A _URL template_ enables you to add specific values
to a partial URL. Use the string `{{value}}` to add the contents of the field to a fixed URL.
@ -18,9 +18,11 @@ The `{{value}}` template string URL-encodes the contents of the field. When a fi
non-ASCII characters, these characters are replaced with a `%` character and the appropriate hexadecimal code. For
example, field contents `users/admin` result in the URL template adding `users%2Fadmin`.
When the formatter type is set to *Image*, the `{{value}}` template string specifies the name of an image at the
specified URI.
In order to pass unescaped values directly to the URL, use the `{{rawValue}}` string.
A _Label Template_ enables you to specify a text string that displays instead of the raw URL. You can use the
`{{value}}` template string normally in label templates. You can also use the `{{url}}` template string to display
the formatted URL
//why would you do this since the use case for label templates is to replace the formatted URL in display entirely?
the formatted URL.