This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for galaxy.tours._schema

from typing import (

from pydantic import BaseModel, Field

[docs]class TourCore(BaseModel): name: str = Field( title='Name', description='Name of tour' ) description: str = Field( title='Description', description='Tour description' ) tags: List[str] = Field( title='Tags', description='Topic topic tags' )
[docs]class Tour(TourCore): id: str = Field( title='Identifier', description='Tour identifier' )
[docs]class TourList(BaseModel): __root__: List[Tour] = Field( title='List of tours', default=[] )
[docs]class TourStep(BaseModel): title: Optional[str] = Field( title='Title', description='Title displayed in the header of the step container' ) content: Optional[str] = Field( title='Content', description='Text shown to the user' ) element: Optional[str] = Field( title='Element', description='JQuery selector for the element to be described/clicked' ) placement: Optional[str] = Field( title='Placement', description='Placement of the text box relative to the selected element' ) preclick: Optional[list] = Field( title='Pre-click', description='Elements that receive a click() event before the step is shown' ) postclick: Optional[list] = Field( title='Post-click', description='Elements that receive a click() event after the step is shown' ) textinsert: Optional[str] = Field( title='Text-insert', description='Text to insert if element is a text box (e.g. tool search or upload)' ) backdrop: Optional[bool] = Field( title='Backdrop', description=('Show a dark backdrop behind the popover and its element,' 'highlighting the current step') )
[docs]class TourDetails(TourCore): title_default: Optional[str] = Field( title='Default title', description='Default title for each step' ) steps: List[TourStep] = Field( title='Steps', description='Tour steps' )