.. _tour_Tour.Tour:

===============
Class: ``Tour``
===============

Member Of :doc:`tour_Tour`

.. contents:: Local Navigation
   :local:

Children
========

.. toctree::
   :maxdepth: 1
   
   
Description
===========




.. _tour_Tour_Tour._toggle_tour_buttons:


Function: ``_toggle_tour_buttons``
==================================



.. js:function:: _toggle_tour_buttons()

    
    
.. _tour_Tour_Tour._toggle_width_warning:


Function: ``_toggle_width_warning``
===================================



.. js:function:: _toggle_width_warning()

    
    
.. _tour_Tour_Tour._tour_active:


Function: ``_tour_active``
==========================



.. js:function:: _tour_active()

    
    
.. _tour_Tour_Tour.get_next_tour_page:


Function: ``get_next_tour_page``
================================



.. js:function:: get_next_tour_page(id)

    
    :param string id: 
    :return tour.Page: 
    
.. _tour_Tour_Tour.get_tour_page_by_id:


Function: ``get_tour_page_by_id``
=================================



.. js:function:: get_tour_page_by_id()

    
    
.. _tour_Tour_Tour.get_previous_tour_page:


Function: ``get_previous_tour_page``
====================================



.. js:function:: get_previous_tour_page(id)

    
    :param string id: 
    :return tour.Page: 
    
.. _tour_Tour_Tour._index_elements:


Function: ``_index_elements``
=============================



.. js:function:: _index_elements()

    
    
.. _tour_Tour_Tour._activate_by_id:


Function: ``_activate_by_id``
=============================



.. js:function:: _activate_by_id()

    
    
.. _tour_Tour_Tour.init_activation:


Function: ``init_activation``
=============================

Start tour activation.

.. js:function:: init_activation()

    
    
.. _tour_Tour_Tour.deactivate:


Function: ``deactivate``
========================



.. js:function:: deactivate()

    
    
.. _tour_Tour_Tour.reset_tour:


Function: ``reset_tour``
========================

Reset the tour state.  Mainly useful for development and debugging.

.. js:function:: reset_tour()

    
    
.. _tour_Tour_Tour._deactivate:


Function: ``_deactivate``
=========================



.. js:function:: _deactivate()

    
    
.. _tour_Tour_Tour._hide_tour_sidebar:


Function: ``_hide_tour_sidebar``
================================



.. js:function:: _hide_tour_sidebar()

    
    
.. _tour_Tour_Tour._show_tour_sidebar:


Function: ``_show_tour_sidebar``
================================



.. js:function:: _show_tour_sidebar()

    
    
.. _tour_Tour_Tour._activate:


Function: ``_activate``
=======================



.. js:function:: _activate()

    
    
.. _tour_Tour_Tour.activate:


Function: ``activate``
======================

Activate tour: initialize activation of elements.

.. js:function:: activate()

    
    
.. _tour_Tour_Tour.deactivate_other:


Function: ``deactivate_other``
==============================



.. js:function:: deactivate_other()

    
    
.. _tour_Tour_Tour.create_tour_overview_panel:


Function: ``create_tour_overview_panel``
========================================



.. js:function:: create_tour_overview_panel()

    
    
.. _tour_Tour_Tour.update:


Function: ``update``
====================



.. js:function:: update()

    
    

.. _tour_Tour_Tour.old_state_active:

Member: ``old_state_active``: 

.. _tour_Tour_Tour.old_state_active:

Member: ``old_state_active``: 

.. _tour_Tour_Tour.old_state_active:

Member: ``old_state_active``: 

.. _tour_Tour_Tour.active:

Member: ``active``: 

.. _tour_Tour_Tour.old_state_active:

Member: ``old_state_active``: 

.. _tour_Tour_Tour.active:

Member: ``active``: