napari_track_edit.application_menus.welcome_widget
==================================================

.. py:module:: napari_track_edit.application_menus.welcome_widget


Attributes
----------

.. autoapisummary::

   napari_track_edit.application_menus.welcome_widget.DOCS_URL
   napari_track_edit.application_menus.welcome_widget.KEYBINDINGS_URL
   napari_track_edit.application_menus.welcome_widget.TUTORIAL_URL
   napari_track_edit.application_menus.welcome_widget.EXAMPLE_SCHEME
   napari_track_edit.application_menus.welcome_widget.LOGO_PATH
   napari_track_edit.application_menus.welcome_widget.LOGO_HEIGHT


Classes
-------

.. autoapisummary::

   napari_track_edit.application_menus.welcome_widget.WelcomeWidget


Module Contents
---------------

.. py:data:: DOCS_URL
   :value: 'https://liveimagetrackingtools.org/napari-track-edit'


.. py:data:: KEYBINDINGS_URL
   :value: 'https://liveimagetrackingtools.org/napari-track-edit/key_bindings.html'


.. py:data:: TUTORIAL_URL
   :value: 'https://liveimagetrackingtools.org/napari-track-edit/napari-track-edit_tutorial.html'


.. py:data:: EXAMPLE_SCHEME
   :value: 'load-example'


.. py:data:: LOGO_PATH

.. py:data:: LOGO_HEIGHT
   :value: 58


.. py:class:: WelcomeWidget(viewer: napari.Viewer)

   Bases: :py:obj:`qtpy.QtWidgets.QWidget`


   Getting started widget with links and basic information to get started with the tool.


   .. py:attribute:: viewer


   .. py:method:: _logo_label() -> qtpy.QtWidgets.QLabel

      A label showing the plugin logo, scaled to LOGO_HEIGHT and kept sharp on
      high-dpi screens.



   .. py:method:: _on_link_clicked(url: qtpy.QtCore.QUrl) -> None

      Open documentation links in a browser, load examples in the app.



   .. py:method:: _load_example(sample_name: str) -> None

      Load one of the sample tracks and its raw data, downloading them
      first if needed.

      The TracksViewer is looked up on click rather than on construction, so
      the widget does not depend on the order in which the menus are created.

      :param sample_name: A key of SAMPLE_TRACKS
      :type sample_name: str



   .. py:method:: _confirm_raw_download(sample_name: str) -> bool

      Ask before fetching the raw data for the first time, because it is a
      few hundred megabytes and can take minutes on a slow connection.

      :param sample_name: A key of SAMPLE_TRACKS
      :type sample_name: str

      :returns: True if the example should be loaded
      :rtype: bool



   .. py:method:: _add_raw_layer(sample_name: str) -> bool

      Add the raw data belonging to a sample to the viewer, downloading it
      first if needed. Skipped if a layer with that name is already present.
      Added before the tracks, so that the tracks layers are drawn on top.

      :param sample_name: A key of SAMPLE_TRACKS
      :type sample_name: str

      :returns: False if the user cancelled the download, or it failed
      :rtype: bool