Property Detail

• Object customThemeRelativePath

• Object highlightJsThemeRelativePath

• Object parallaxBackgroundImageRelativePath

• String parallaxBackgroundSize

Constructor Detail

• RevealJSOptions(Project project)

Method Detail

• void enhanceCopySpec(CopySpec cs)

  Adds files to a CopySpec for copying to final artifact.

  Parameters:

  cs - CopySpec to enhance.

• @Input Map<String, String> getAsAttributeMap()

  The Reveal.js settings as a map of Asciidoctor attributes. The map will be empty if nothing was set.

  Returns:

  Map of attributes.

• @Optional@org.gradle.api.tasks.Optional @InputFile File getCustomThemeIfFile()

  Custom.js theme location if specified as a file.

  Returns:

  File or null.

• @Optional@org.gradle.api.tasks.Optional @Input URI getCustomThemeIfUri()

  Custom Reveal.js theme if it is specified as URI which is not of type file://.

  Returns:

  URI or null.

• @Input String getCustomThemeRelativePath()

  Relative path to folder where custom Reveal.js theme will be copied to.

  Returns:

  Relative path to folder where custom Reveal.js theme can be found after generation.

• @Optional@org.gradle.api.tasks.Optional @InputFile File getHighlightJsThemeIfFile()

  Highlight.js theme location if specified as a file.

  Returns:

  File or null.

• @Optional@org.gradle.api.tasks.Optional @Input URI getHighlightJsThemeIfUri()

  Highlight.js theme if it is specified as URI which is not of type file://.

  Returns:

  URI or null.

• @Input String getHighlightJsThemeRelativePath()

  Relative path to folder where Highlight.js theme will be copied to.

  Returns:

  Relative path to folder where Highlight.js theme can be found after generation.

• @Optional@org.gradle.api.tasks.Optional @InputFile File getParallaxBackgroundImageIfFile()

  Parallax background image if it is specified as a file.

  Returns:

  File or null.

• @Optional@org.gradle.api.tasks.Optional @Input URI getParallaxBackgroundImageIfUri()

  Parallax background image if it is specified as URI which is not of type file://.

  Returns:

  URI or null.

• @Input String getParallaxBackgroundImageRelativePath()

  Relative path to folder where Parallax background image will be copied to.

  Returns:

  Relative path to folder where background image can be found after generation.

• @Optional@org.gradle.api.tasks.Optional @Input String getParallaxBackgroundSize()

  Parallax background size (accepts any CSS syntax).

  Returns:

  CSS syntax. Can be null.

• void setAutoSlideInterval(Integer ms)

  Delay in milliseconds between automatically proceeding to the next slide. Disabled when set to 0(the default). This value can still be overwritten on a per-slide basis by setting a data-autoslide attribute on a slide.

• void setAutoSlideStoppable(Boolean b)

  Stop auto-sliding after user input

• void setBackgroundTransition(String s)

  Transition style for full page slide backgrounds.. One of none , fade, slide, convex, concave, zoom. If not set then Reveal.js will use an internal default of FADE.

• void setBackgroundTransition(Transition tr)

  Transition style for full page slide backgrounds.. One of none , fade, slide, convex, concave, zoom. If not set then Reveal.js will use an interna default of FADE.

• void setControls(Boolean b)

  Display controls in the bottom right corner.

• void setCustomThemeLocation(Object fileOrUri)

  Provide a custom them as a file or URL.

  Parameters:

  fileOrUri - Object that can be converted to a file or a URI. If the initial object is not a URI, but it's string presentation starts with http(s) it will be treated as a URI. Anything else is a path to a local file.

• void setCustomThemeRelativePath(Object relPath)

  If a custom Reveal.js theme is provided and is a local file, this is the relative location where it can be found after generation of the slide desk.

  Parameters:

  relPath - Relative path to custom Reveal.js theme.

• void setFlagEmbedded(Boolean b)

  Flags if the presentation is running in an embedded mode ( contained within a limited portion of the screen ).

• void setFragments(Boolean b)

  Use fragments globally.

• void setHideAddressBarOnMobile(Boolean b)

  Hides the address bar on mobile devices.

• void setHighlightJsThemeLocation(Object fileOrUri)

  Overrides Highlight.js CSS style with given file or URL. Default is built-in lib/css/zenburn.css.

  sa:

  https://highlightjs.org

  Parameters:

  fileOrUri - Object that can be converted to a file or a URI. If the initial object is not a URI, but it's string presentation starts with http(s) it will be reated as a URI. Anything else is a path to a local file.

• void setHighlightJsThemeRelativePath(Object relPath)

  If Highlight.js theme is overriden and is a local file, this is the relative location where it can be found after generation of the slide desk.

  Parameters:

  relPath - Relative path to Highlight.js theme.

• void setKeyboardShortcuts(Boolean b)

  Enable keyboard shortcuts for navigation.

• void setLoop(Boolean b)

  Loop the presentation..

• void setMouseWheel(Boolean b)

  Enable slide navigation via mouse wheel.

• void setOverviewMode(Boolean b)

  Enable the slide overview mode.

• void setParallaxBackgroundImageLocation(Object fileOrUri)

  Set Parallax background image as file or URI.

  Parameters:

  fileOrUri - Object that can be converted to a file or a URI. If the initial object is not a URI, but it's string presentation starts with http(s) it will be created as a URI. Anything else is a path to a local file.

• void setParallaxBackgroundImageRelativePath(Object relPath)

  If the parallax image is set as a file, this will be the relative path to which it will be copied when resources are copied.

  Parameters:

  relPath - Relative path can be anything convertible to a string using org.ysb33r.grolifant.api.StringUtils#stringize.

• void setParallaxBackgroundSize(Object css)

  Set the Parallax background size.

  Parameters:

  css - Anything that can be converted to a String via org.ysb33r.grolifant.api.StringUtils#stringize. Must be in CSS syntax.

• void setPreviewLinks(Boolean b)

• void setProgressBar(Boolean b)

  Display a presentation progress bar.

• void setPushToHistory(Boolean b)

  Push each slide change to the browser history.

• void setRightToLeft(Boolean b)

  Change the presentation direction to be RTL.

• void setSlideNumber(Boolean b)

  Display the slide number of the current slide.

• void setTouchMode(Boolean b)

  Enables touch navigation on devices with touch input.

• void setTransition(String s)

  Transition style. If not set, the Reveal.JS will use an internal default of SLIDE.

• void setTransition(Transition tr)

  Transition style. If not set, the Reveal.js will use an internal default of SLIDE.

• void setTransitionSpeed(String s)

  Slide transition speed One of default , fast, slow. If not provided, Reveal.js wil use an internal default value of DEFAULT.

• void setTransitionSpeed(TransitionSpeed tr)

  Slide transition speed One of default , fast, slow. If not provided, Reveal.js wil use an internal default value of DEFAULT.

• void setVerticalCenter(Boolean b)

  Vertical centering of slides.

• void setViewDistance(Integer numSlides)

  Number of slides away from the current that are visible. If not set, Revels.JS will use an internal value of 3.