Dashboard.showSlide

Syntax

showSlide({

    params

});

Parameters

params. JSON object with parameters of displaying dashboard slide.

The following parameters are available:

Parameter name Type Brief description
SlideKey number Dashboard slide key.
SlideIndex number Dashboard slide index.

Description

The showSlide method displays dashboard slide by key and by index.

Comments

To get slide key, use the tooltip:

  1. Select dashboard slide.

  2. Go to the side panel title and hover the cursor on the slide name.

After executing the operations, a tooltip is displayed containing slide name and key.

To get slide index, use the Dashboard.getActiveSlideIndex method.

Example

To execute the example, make sure that the repository contains a dashboard with the 88665 key. The dashboard must contain at least three slides.

Create an HTML page with example of placing the KapBox component and execute the following operations:

  1. Open the dashboard with the 88665 key:

kapBox.open({
    Key: 88665
});

  1. Execute the following in the console:

kapBox.moveSlideTop();
kapBox.showSlide({
    SlideIndex: 1
})
kapBox.moveSlideBottom();
kapBox.refresh();

After executing the example the active slide is moved to the top and the second slide is moved to the bottom.

See also:

Dashboard