Skip to content

Commit

Permalink
Changes to add custom labeling to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Echeverri committed Mar 21, 2016
1 parent d5a7956 commit 1f2d966
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/datatable.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ sub-aggregation from the list of types.

You can use the up or down arrows to the right of the aggregation's type to change the aggregation's priority.

Enter a string in the *Custom Label* field to change the display label.

You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation:

*Exclude Pattern*:: Specify a pattern in this field to exclude from the results.
Expand Down
3 changes: 2 additions & 1 deletion docs/metric.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
A metric visualization displays a single number for each aggregation you select:

include::y-axis-aggs.asciidoc[]

You can click the *Advanced* link to display more customization options:

*JSON Input*:: A text field where you can add specific JSON-formatted properties to merge with the aggregation
Expand All @@ -17,7 +18,7 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you

The availability of these options varies depending on the aggregation you choose.

Click the *Options* tab to change the font used to display the metrics.
Click the *Options* tab to display the font size slider.

[float]
[[metric-viewing-detailed-information]]
Expand Down
4 changes: 4 additions & 0 deletions docs/pie.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ field. Select a field from the drop-down.
*Unique Count*:: The {ref}search-aggregations-metrics-cardinality-aggregation.html[_cardinality_] aggregation returns
the number of unique values in a field. Select a field from the drop-down.

Enter a string in the *Custom Label* field to change the display label.

The _buckets_ aggregations determine what information is being retrieved from your data set.

Before you choose a buckets aggregation, specify if you are splitting slices within a single chart or splitting into
Expand Down Expand Up @@ -57,6 +59,8 @@ aggregation's type to change the aggregation's priority.

include::color-picker.asciidoc[]

Enter a string in the *Custom Label* field to change the display label.

You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation:

*Exclude Pattern*:: Specify a pattern in this field to exclude from the results.
Expand Down
4 changes: 4 additions & 0 deletions docs/tilemap.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ numeric field. Select a field from the drop-down.
*Unique Count*:: The {ref}search-aggregations-metrics-cardinality-aggregation.html[_cardinality_] aggregation returns
the number of unique values in a field. Select a field from the drop-down.

Enter a string in the *Custom Label* field to change the display label.

The _buckets_ aggregations determine what information is being retrieved from your data set.

Before you choose a buckets aggregation, specify if you are splitting the chart or displaying the buckets as *Geo
Expand Down Expand Up @@ -71,6 +73,8 @@ based on the geohash coordinates.

NOTE: By default, the *Change precision on map zoom* box is checked. Uncheck the box to disable this behavior.

Enter a string in the *Custom Label* field to change the display label.

You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation:

*Exclude Pattern*:: Specify a pattern in this field to exclude from the results.
Expand Down
4 changes: 4 additions & 0 deletions docs/vertbar.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ values field. Click *+Add* to add a values field.

You can add an aggregation by clicking the *+ Add Aggregation* button.

Enter a string in the *Custom Label* field to change the display label.

The _buckets_ aggregations determine what information is being retrieved from your data set.

Before you choose a buckets aggregation, specify if you are splitting slices within a single chart or splitting into
Expand All @@ -36,6 +38,8 @@ include::x-axis-aggs.asciidoc[]

include::color-picker.asciidoc[]

Enter a string in the *Custom Label* field to change the display label.

You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation:

*Exclude Pattern*:: Specify a pattern in this field to exclude from the results.
Expand Down
6 changes: 4 additions & 2 deletions docs/x-axis-aggs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ remove a range.
or bottom _n_ elements of a given field to display, ordered by count or a custom metric.
*Filters*:: You can specify a set of {ref}/search-aggregations-bucket-filters-aggregation.html[_filters_] for the data.
You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to
add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type in a
name to display on the visualization.
add another filter. Click the image:images/labelbutton.png[Label button icon] *label* button to open the label field, where
you can type in a name to display on the visualization.
*Significant Terms*:: Displays the results of the experimental
{ref}/search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation.

Expand All @@ -39,3 +39,5 @@ from the list of types.

When multiple aggregations are defined on a chart's axis, you can use the up or down arrows to the right of the
aggregation's type to change the aggregation's priority.

Enter a string in the *Custom Label* field to change the display label.
2 changes: 2 additions & 0 deletions docs/y-axis-aggs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ from the drop-down, then specify one or more percentile rank values in the *Valu
values field. Click *+Add* to add a values field.

You can add an aggregation by clicking the *+ Add Aggregation* button.

Enter a string in the *Custom Label* field to change the display label.

0 comments on commit 1f2d966

Please sign in to comment.