M
M
Mycroft AI
HomeForumChatMy Account
Search…
Documentation
About Mycroft AI
Why use Mycroft AI?
Glossary of terms
Contributing
FAQ
Using Mycroft AI
Get Mycroft
Pairing Your Device
Basic Commands
Installing New Skills
Customizations
Troubleshooting
Skill Development
Voice User Interface Design Guidelines
Development Setup
Skill Structure
Integration Tests
User interaction
Displaying information
GUI Framework
Show Simple Content
Mycroft-GUI on a PC
Mark 1 Display
Advanced Skill Types
Mycroft Skills Manager
Marketplace Submission
FAQ
Mycroft Technologies
Technology Overview
Roadmap
Mycroft Core
Adapt
Lingua Franca
Mimic
Mycroft GUI
Mycroft Skills Kit
Mycroft Skills Manager
Padatious
Precise
Platforms
Powered By GitBook
Show Simple Content
The Mycroft GUI Framework has a number of common methods for displaying standard simple content types.

Text

Display simple strings of text.
1
self.gui.show_text(self, text, title=None, override_idle=None, override_animations=False)
Copied!
Arguments:
    text (str): Main text content. It will auto-paginate
    title (str): A title to display above the text content.
    override_idle (boolean, int):
      True: Takes over the resting page indefinitely
      (int): Delays resting page for the specified number of seconds.
    override_animations (boolean):
      True: Disables showing all platform skill animations.
      False: 'Default' always show animations.

Static Image

Display a static image such as a jpeg or png.
1
self.gui.show_image(self, url, caption=None, title=None, fill=None, override_idle=None, override_animations=False)
Copied!
Arguments:
    url (str): Pointer to the image
    caption (str): A caption to show under the image
    title (str): A title to display above the image content
    fill (str): Fill type - supports:
      'PreserveAspectFit',
      'PreserveAspectCrop',
      'Stretch'
    override_idle (boolean, int):
      True: Takes over the resting page indefinitely
      (int): Delays resting page for the specified number of seconds.
    override_animations (boolean):
      True: Disables showing all platform skill animations.
      False: 'Default' always show animations.

Animated Image

Display an animated image such as a gif.
1
self.gui.show_animated_image(self, url, caption=None, title=None, fill=None, override_idle=None, override_animations=False)
Copied!
Arguments:
    url (str): Pointer to the .gif image
    caption (str): A caption to show under the image
    title (str): A title to display above the image content
    fill (str): Fill type - supports:
      'PreserveAspectFit',
      'PreserveAspectCrop',
      'Stretch'
    override_idle (boolean, int):
      True: Takes over the resting page indefinitely
      (int): Delays resting page for the specified number of seconds.
    override_animations (boolean):
      True: Disables showing all platform skill animations.
      False: 'Default' always show animations.

HTML Page

Display a local HTML page.
1
self.gui.show_html(self, html, resource_url=None, override_idle=None, override_animations=False)
Copied!
Arguments:
    html (str): HTML text to display
    resource_url (str): Pointer to HTML resources
    override_idle (boolean, int):
      True: Takes over the resting page indefinitely
      (int): Delays resting page for the specified number of seconds.
    override_animations (boolean):
      True: Disables showing all platform skill animations.
      False: 'Default' always show animations.

Remote URL

Display a webpage.
1
self.gui.show_url(self, url, override_idle=None, override_animations=False)
Copied!
Arguments:
    url (str): URL to render
    override_idle (boolean, int):
      True: Takes over the resting page indefinitely
      (int): Delays resting page for the specified number of seconds.
    override_animations (boolean):
      True: Disables showing all platform skill animations.
      False: 'Default' always show animations.
Previous
GUI Framework
Next
Mycroft-GUI on a PC
Last modified 7mo ago
Copy link
Contents
Text
Static Image
Animated Image
HTML Page
Remote URL