Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Canvas docs 7.9 refresh #74000

Merged
merged 13 commits into from
Aug 12, 2020
136 changes: 136 additions & 0 deletions docs/canvas/canvas-edit-workpads.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
[role="xpack"]
[[edit-workpads]]
== Edit workpads

To create the look and feel that you want, apply format settings to the entire workpad, or individual elements.

[float]
[[create-variables]]
=== Create variables

When you frequently use copy and paste, create variables to easily reuse strings and patterns. For example, when you clone a large workpad and need to connect your elements to a new index, use variables to update
each element instead of updating them manually.

. Create the variables.
.. Click *Add a variable*.
.. Specify the variable options, then click *Save changes*.

. Apply the variable.
.. Copy the variable.
.. Select the element you want to change, then open the expression editor.
.. Paste the variable.

For example, to change the index pattern for a set of charts:

Specify the variable options.

[role="screenshot"]
image::images/specify_variable_syntax.png[Specify the variable syntax]

Copy the variable, then apply it to each element you want to update in the *Expression editor*.

[role="screenshot"]
image::images/copy_variable_syntax.png[Copy the variable syntax]

[float]
[[apply-changes-to-the-entire-workpad]]
=== Apply changes to the entire workpad

With stylesheets, you can change the look of the entire workpad, including fonts, colors, layout, and more.

To get started, enter the changes you want to make in the *Global CSS overrides* text editor, then click *Apply stylesheet*.

For example, to change the background for the entire workpad, enter:

[source,text]
--------------------------------------------------
.canvasPage {
background-color: #3990e6;
}
--------------------------------------------------

[float]
[[change-the-element-settings]]
=== Change the element settings

Element settings enable you to change the display options at the element level. For example, use the element settings to change the dimensions, style, or location of an element.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide an example here?


[float]
[[change-the-display-options]]
==== Change the display options

Choose the display options for your elements. The options available depend on the element you select.

To change the element display options, click *Display*, then make your changes in the editor.

To use CSS overrides:

. Click *+* next to *Element style*, then select *CSS*.
. In the *CSS* text editor, enter the changes you want to make, then click *Apply stylesheet*.

For example, to center an element, enter:

[source,text]
--------------------------------------------------
.canvasRenderEl h1 {
text.align: center;
}
--------------------------------------------------

[float]
[[clone-elements]]
==== Clone elements
To use an element with the same functionality and appearance in multiple places, clone the element.

Select the element, then click *Edit > Clone*.

[role="screenshot"]
image::images/clone_element.gif[Clone elements]

[float]
[[move-and-resize-elements]]
==== Move and resize elements

Canvas provides you with many options to move and resize the elements on your workpad.

* To move elements, click and hold the element, then drag to the new location.

* To move elements by 1 pixel, select the element, press and hold Shift, then use your arrow keys.

* To move elements by 10 pixels, select the element, then use your arrow keys.

* To resize elements, click and drag the resize handles to the new dimensions.

[float]
[[edit-elements]]
==== Edit elements
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use a more specific title? Align, distribute, and reorder elements?


The element editing options allow you to arrange and organize the elements on your workpad page.

To align two or more elements:

. Press and hold Shift, then select the elements you want to align.

. Click *Edit > Alignment*, then select the alignment option.

To distribute three or more elements:

. Press and hold Shift, then select the elements you want to distribute.

. Click *Edit > Distribution*, then select the distribution option.

To reorder elements:

. Select the element you want to reorder.

. Click *Edit > Order*, then select the order option.

[float]
[[delete-elements]]
==== Delete elements

When you no longer need an element, delete it from your workpad.

. Select the element you want to delete.

. Click *Edit > Delete*.
167 changes: 0 additions & 167 deletions docs/canvas/canvas-elements.asciidoc

This file was deleted.

30 changes: 29 additions & 1 deletion docs/canvas/canvas-present-workpad.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[canvas-present-workpad]]
=== Present your workpad
== Present your workpad

When you are ready to present your workpad, use and enable the presentation options.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a little more explanation about what it means to "present your workpad."


Expand All @@ -21,3 +21,31 @@ image::images/canvas-autoplay-interval.png[Element autoplay interval]
image::images/canvas-fullscreen.png[Fullscreen mode]

. When you are ready to exit fullscreen mode, press the Esc (Escape) key.

[float]
[[zoom-in-out]]
=== Use the zoom options

To get a closer look at a portion of your workpad, use the zoom options.

. Click *View > Zoom*.

. Select the zoom option.
+
[role="screenshot"]
image::images/canvas-zoom-controls.png[Zoom controls]

[float]
[[configure-auto-refresh-interval]]
=== Change the auto-refresh interval

Change how often the data refreshes on your workpad.

. Click *View > Auto refresh settings*.

. Select the interval you want to use, or *Set a custom interval*.
+
[role="screenshot"]
image::images/canvas-refresh-interval.png[Element data refresh interval]
+
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[].
14 changes: 7 additions & 7 deletions docs/canvas/canvas-share-workpad.asciidoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[role="xpack"]
[[workpad-share-options]]
=== Share your workpad
== Share your workpad

When you've finished your workpad, you can share it outside of {kib}.

[float]
[[export-single-workpad]]
==== Export workpads
=== Export workpads

Create a JSON file of your workpad that you can export outside of {kib}.

Expand All @@ -19,9 +19,9 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp

[float]
[[create-workpad-pdf]]
==== Create a PDF
=== Create a PDF

If you have a license that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.
If you have a subscription that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.

Click *Share > PDF reports > Generate PDF*.

Expand All @@ -32,9 +32,9 @@ For more information, refer to <<reporting-getting-started, Reporting from Kiban

[float]
[[create-workpad-URL]]
==== Create a POST URL
=== Create a POST URL

If you have a license that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using Watcher or a script.
If you have a subscription that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using <<watcher-ui,Watcher>> or a script.

Click *Share > PDF reports > Copy POST URL*.

Expand All @@ -45,7 +45,7 @@ For more information, refer to <<automating-report-generation, Automating report

[float]
[[add-workpad-website]]
==== Share the workpad on a website
=== Share the workpad on a website

beta[] Canvas allows you to create _shareables_, which are workpads that you download and securely share on any website. To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.

Expand Down
Loading