Other Classes
GUI
|
Base class for composable panel objects that make up the GUI. |
Base class for capturing selector logic. |
|
|
|
Panel interface for picking files |
|
Panel interface for inputting a URL to a remote catalog |
|
Panel for adding new cats from local file or remote |
|
Search panel for searching a list of catalogs |
|
Panel for displaying pre-defined plots from catalog. |
- class intake.interface.base.Base(visible=True, visible_callback=None, logo=False)
Base class for composable panel objects that make up the GUI.
- Parameters
- children: list of panel objects
children that will be used to populate the panel when visible
- panel: panel layout object
instance of a panel layout (row or column) that contains children when visible
- watchers: list of param watchers
watchers that are set on children - cleaned up when visible is set to false.
- visible: bool
whether or not the instance should be visible. When not visible
panelis empty.- logobool, opt
whether to show the intake logo in a panel to the left of the main panel. Default is False
- classmethod from_state(state)
Create a new object from a serialized exising object.
Examples
original = cls() copy = cls.from_state(original.__getstate__())
- setup()
Should instantiate widgets, set
children, and set watchers
- unwatch()
Get rid of any lingering watchers and remove from list
- property visible
Whether or not the instance should be visible.
- class intake.interface.base.BaseSelector(visible=True, visible_callback=None, logo=False)
Base class for capturing selector logic.
- Parameters
- preprocess: function
run on every input value when creating options
- widget: panel widget
selector widget which this class keeps uptodate with class properties
- add(items)
Add items to options
- property items
Available items to select from
- property labels
Labels of items in widget
- property options
Options available on the widget
- remove(items)
Remove items from options
- property selected
Value selected on the widget
- class intake.interface.base.BaseView(visible=True, visible_callback=None, logo=False)
- class intake.interface.catalog.add.FileSelector(filters=['yaml', 'yml'], done_callback=None, **kwargs)
Panel interface for picking files
The current path is stored in .path and the current selection is stored in .url.
- Parameters
- filters: list of string
extentions that are included in the list of files - correspond to catalog extensions.
- done_callback: func, opt
called when the object’s main job has completed. In this case, selecting a file.
- Attributes
- url: str
path to local catalog file
- children: list of panel objects
children that will be used to populate the panel when visible
- panel: panel layout object
instance of a panel layout (row or column) that contains children when visible
- watchers: list of param watchers
watchers that are set on children - cleaned up when visible is set to false.
- setup()
Should instantiate widgets, set
children, and set watchers
- property url
Path to local catalog file
- class intake.interface.catalog.add.URLSelector(**kwargs)
Panel interface for inputting a URL to a remote catalog
The inputted URL is stored in .url.
- Attributes
- url: str
url to remote files (including protocol)
- children: list of panel objects
children that will be used to populate the panel when visible
- panel: panel layout object
instance of a panel layout (row or column) that contains children when visible
- watchers: list of param watchers
watchers that are set on children - cleaned up when visible is set to false.
- setup()
Should instantiate widgets, set
children, and set watchers
- property url
URL to remote files (including protocol)
- class intake.interface.catalog.add.CatAdder(done_callback=None, **kwargs)
Panel for adding new cats from local file or remote
- Parameters
- done_callback: function with cat as input
function that is called when the “Add Catalog” button is clicked.
- Attributes
- cat_url: str
url to remote files or path to local files. Depends on active tab
- cat: catalog
catalog object initialized from from cat_url
- children: list of panel objects
children that will be used to populate the panel when visible
- panel: panel layout object
instance of a panel layout (row or column) that contains children when visible
- watchers: list of param watchers
watchers that are set on children - cleaned up when visible is set to false.
- add_cat(arg=None)
Add cat and close panel
- property cat
Catalog object initialized from from cat_url
- property cat_url
URL to remote files or path to local files. Depends on active tab.
- setup()
Should instantiate widgets, set
children, and set watchers
- class intake.interface.catalog.search.Search(done_callback: callable)
Search panel for searching a list of catalogs
- Parameters
- done_callback: function with cats as input
function that is called when new cats have been generated via the search functionality
- class intake.interface.source.defined_plots.Plots(source=None, **kwargs)
Panel for displaying pre-defined plots from catalog.
- Parameters
- source: intake catalog entry, or list of same
source to describe in this object
- edit_callback: callback to alert that plot has been edited
- Attributes
- has_plots: bool
whether the source has plots defined
- options: list
plots options defined on the source
- selected: str
name of selected plot
- children: list of panel objects
children that will be used to populate the panel when visible
- panel: panel layout object
instance of a panel layout (row or column) that contains children when visible
- watchers: list of param watchers
watchers that are set on children - cleaned up when visible is set to false.
- property has_plots
Whether the source has plots defined
- property options
Plots options defined on the source
- property selected
Name of selected plot
- setup()
Should instantiate widgets, set
children, and set watchers