Home Reference Source

Variable

Static Public Summary
public

Models corresponding to AccessControlledModels on the server should extend from this object.
public

AccessType: {"NONE": *, "READ": *, "WRITE": number, "ADMIN": number}

public

This view allows users to see and control access on a resource.
public

This view shows the admin console, which links to all available admin pages.
public
public
public
public

App: *

public
public
public

AssetstoreType: {"FILESYSTEM": *, "GRIDFS": number, "S3": number}

public

This view shows the admin console, which links to all available admin pages.
public

This widget provides the user with an interface similar to a filesystem browser to pick a single user, collection, folder, or item from a hierarchical view.
public

This widget presents a list of available batch actions on a set of selected resources.
public

All collections should descend from this collection base class, which provides nice utilities for pagination and sorting.
public
public
public

This view shows a dialog containing detailed collection information.
public
public

This view shows a single collection's page.
public

This view lists the collections.
public
public
public

This file contains utility functions for general use in the application
public
public

This widget provides text input fields to specify a range of dates/times.
public

This widget provides a text input field to specify a date/time.
public

This widget is used to create a new API key or edit an existing one.
public

This widget is used to edit an existing assetstore.
public

This widget is used to create a new collection or edit an existing one.
public

This widget is used to edit file information.
public

This widget is used to create a new folder or edit an existing one.
public

This widget is used to create a new group or edit an existing one.
public

This widget is used to create a new item or edit an existing one.
public
public

This widget shows information about a single file in a modal dialog.
public

This widget shows a list of files in a given item.
public
public
public
public

This view shows a dialog container detailed folder information.
public

This widget shows a list of folders under a given parent.
public
public

This view shows a single folder as a hierarchy widget.
public

This is the view for the front page of the app.
public

This view shows a list of administrators of a group.
public
public

This view shows a list of pending invitations to the group.
public

This view shows a list of members of a group.
public
public

This view shows a list of moderators of a group.
public

This view shows a single group's page.
public

This view lists groups.
public

This widget is used to navigate the data hierarchy of folders and items.
public

Renders the a breadcrumb for the item page
public
public

This widget shows a list of items under a given folder.
public
public

This view shows a single item's page.
public

Layout: {"DEFAULT": string, "EMPTY": string}

public

This view shows the footer in the layout.
public

This view shows a list of global navigation links that should be displayed at all times.
public

This view shows the user menu, or register/sign in links if the user is not logged in.
public

This view shows the header in the layout.
public

This widget can be used to display a small loading animation.
public

This view shows a login modal dialog.
public
public

A simple widget for editing markdown text with a preview tab.
public

MetadataMixin: {"_sendMetadata": *, "addMetadata": *, "removeMetadata": *, "editMetadata": *}

public

This widget shows a list of metadata in a given item.
public

Model: *

All models should descend from this base model, which provides a number of utilities for synchronization.
public

This widget is for creating new assetstores.
public

This widget is used to provide a consistent widget for iterating amongst pages of a Collection.
public

This widget provides a consistent breadcrumb to be displayed on the admin configuration pages for plugins.
public

This is the plugin management page for administrators.
public

Container showing list of active tasks that are reporting progress via a EventStream object.
public

This view shows a register modal dialog.
public

This view shows a modal dialog for resetting a forgotten password.
public

This widget creates a dropdown box allowing the user to select "root" paths for a hierarchy widget.
public
public
public
public

This widget provides a text field that will search any set of data types and show matching results as the user types.
public

This widget is used to provide a consistent widget for iterating amongst pages of a list of search results (using a search mode, a query, an unique type, and a limit).
public

This view display all the search results by instantiating a subview per each type found.
public

This widget is used to provide a consistent widget for sorting pages of a Collection by a choosen field.
public

The system config page for administrators.
public

This widget renders the state of a progress notification.
public

This widget displays a timeline of events.
public

This widget is used to upload files to a folder.
public

This is the view for the user account (profile) page.
public
public
public
public

This view shows a single user's page.
public

This view lists users.
public

View: *

public

cookie: {"findAll": *, "find": *}

public
public
public

plugins: {}

public

renderMarkdown(val: *, el: *): *

Transform markdown into HTML and render it into the given element.
public
public

version: *

Static Public

public AccessControlledModel: * source 

import AccessControlledModel from '@girder/lint/src/models/AccessControlledModel.js'

Models corresponding to AccessControlledModels on the server should extend from this object. It provides utilities for managing and storing the access control list on

public AccessType: {"NONE": *, "READ": *, "WRITE": number, "ADMIN": number} source 

import {AccessType} from '@girder/lint/src/constants.js'

public AccessWidget: * source 

import AccessWidget from '@girder/lint/src/views/widgets/AccessWidget.js'

This view allows users to see and control access on a resource.

public AdminView: * source 

import AdminView from '@girder/lint/src/views/body/AdminView.js'

This view shows the admin console, which links to all available admin pages.

public ApiKeyCollection: * source 

import ApiKeyCollection from '@girder/lint/src/collections/ApiKeyCollection.js'

public ApiKeyListWidget: * source 

import ApiKeyListWidget from '@girder/lint/src/views/widgets/ApiKeyListWidget.js'

public ApiKeyModel: * source 

import ApiKeyModel from '@girder/lint/src/models/ApiKeyModel.js'

public App: * source 

import App from '@girder/lint/src/views/App.js'

public AssetstoreCollection: * source 

import AssetstoreCollection from '@girder/lint/src/collections/AssetstoreCollection.js'

public AssetstoreModel: * source 

import AssetstoreModel from '@girder/lint/src/models/AssetstoreModel.js'

public AssetstoreType: {"FILESYSTEM": *, "GRIDFS": number, "S3": number} source 

import {AssetstoreType} from '@girder/lint/src/constants.js'

public AssetstoresView: * source 

import AssetstoresView from '@girder/lint/src/views/body/AssetstoresView.js'

This view shows the admin console, which links to all available admin pages.

public BrowserWidget: * source 

import BrowserWidget from '@girder/lint/src/views/widgets/BrowserWidget.js'

This widget provides the user with an interface similar to a filesystem browser to pick a single user, collection, folder, or item from a hierarchical view.

public CheckedMenuWidget: * source 

import CheckedMenuWidget from '@girder/lint/src/views/widgets/CheckedMenuWidget.js'

This widget presents a list of available batch actions on a set of selected resources.

public Collection: * source 

import Collection from '@girder/lint/src/collections/Collection.js'

All collections should descend from this collection base class, which provides nice utilities for pagination and sorting.

public CollectionCollection: * source 

import CollectionCollection from '@girder/lint/src/collections/CollectionCollection.js'

public CollectionCreationPolicyModel: * source 

import CollectionCreationPolicyModel from '@girder/lint/src/models/CollectionCreationPolicyModel.js'

public CollectionInfoWidget: * source 

import CollectionInfoWidget from '@girder/lint/src/views/widgets/CollectionInfoWidget.js'

This view shows a dialog containing detailed collection information.

public CollectionModel: * source 

import CollectionModel from '@girder/lint/src/models/CollectionModel.js'

public CollectionView: * source 

import CollectionView from '@girder/lint/src/views/body/CollectionView.js'

This view shows a single collection's page.

public CollectionsView: * source 

import CollectionsView from '@girder/lint/src/views/body/CollectionsView.js'

This view lists the collections.

public DATE_DAY: number source 

import {DATE_DAY} from '@girder/lint/src/misc.js'

public DATE_MINUTE: number source 

import {DATE_MINUTE} from '@girder/lint/src/misc.js'

public DATE_MONTH: number source 

import {DATE_MONTH} from '@girder/lint/src/misc.js'

This file contains utility functions for general use in the application

public DATE_SECOND: number source 

import {DATE_SECOND} from '@girder/lint/src/misc.js'

public DateTimeRangeWidget: * source 

import DateTimeRangeWidget from '@girder/lint/src/views/widgets/DateTimeRangeWidget.js'

This widget provides text input fields to specify a range of dates/times. That is, the first field specifies "from" and the second field specifies "to." The user chooses each date/time using a popup picker.

public DateTimeWidget: * source 

import DateTimeWidget from '@girder/lint/src/views/widgets/DateTimeWidget.js'

This widget provides a text input field to specify a date/time. The user chooses the date/time using a popup picker.

public EditApiKeyWidget: * source 

import EditApiKeyWidget from '@girder/lint/src/views/widgets/EditApiKeyWidget.js'

This widget is used to create a new API key or edit an existing one.

public EditAssetstoreWidget: * source 

import EditAssetstoreWidget from '@girder/lint/src/views/widgets/EditAssetstoreWidget.js'

This widget is used to edit an existing assetstore.

public EditCollectionWidget: * source 

import EditCollectionWidget from '@girder/lint/src/views/widgets/EditCollectionWidget.js'

This widget is used to create a new collection or edit an existing one.

public EditFileWidget: * source 

import EditFileWidget from '@girder/lint/src/views/widgets/EditFileWidget.js'

This widget is used to edit file information.

public EditFolderWidget: * source 

import EditFolderWidget from '@girder/lint/src/views/widgets/EditFolderWidget.js'

This widget is used to create a new folder or edit an existing one.

public EditGroupWidget: * source 

import EditGroupWidget from '@girder/lint/src/views/widgets/EditGroupWidget.js'

This widget is used to create a new group or edit an existing one.

public EditItemWidget: * source 

import EditItemWidget from '@girder/lint/src/views/widgets/EditItemWidget.js'

This widget is used to create a new item or edit an existing one.

public FileCollection: * source 

import FileCollection from '@girder/lint/src/collections/FileCollection.js'

public FileInfoWidget: * source 

import FileInfoWidget from '@girder/lint/src/views/widgets/FileInfoWidget.js'

This widget shows information about a single file in a modal dialog.

public FileListWidget: * source 

import FileListWidget from '@girder/lint/src/views/widgets/FileListWidget.js'

This widget shows a list of files in a given item.

public FileModel: * source 

import FileModel from '@girder/lint/src/models/FileModel.js'

public FilesystemImportView: * source 

import FilesystemImportView from '@girder/lint/src/views/body/FilesystemImportView.js'

public FolderCollection: * source 

import FolderCollection from '@girder/lint/src/collections/FolderCollection.js'

public FolderInfoWidget: * source 

import FolderInfoWidget from '@girder/lint/src/views/widgets/FolderInfoWidget.js'

This view shows a dialog container detailed folder information.

public FolderListWidget: * source 

import FolderListWidget from '@girder/lint/src/views/widgets/FolderListWidget.js'

This widget shows a list of folders under a given parent. Initialize this with a "parentType" and "parentId" value, which will be passed to the folder GET endpoint.

public FolderModel: * source 

import FolderModel from '@girder/lint/src/models/FolderModel.js'

public FolderView: * source 

import FolderView from '@girder/lint/src/views/body/FolderView.js'

This view shows a single folder as a hierarchy widget.

public FrontPageView: * source 

import FrontPageView from '@girder/lint/src/views/body/FrontPageView.js'

This is the view for the front page of the app.

public GroupAdminsWidget: * source 

import GroupAdminsWidget from '@girder/lint/src/views/widgets/GroupAdminsWidget.js'

This view shows a list of administrators of a group.

public GroupCollection: * source 

import GroupCollection from '@girder/lint/src/collections/GroupCollection.js'

public GroupInvitesWidget: * source 

import GroupInvitesWidget from '@girder/lint/src/views/widgets/GroupInvitesWidget.js'

This view shows a list of pending invitations to the group.

public GroupMembersWidget: * source 

import GroupMembersWidget from '@girder/lint/src/views/widgets/GroupMembersWidget.js'

This view shows a list of members of a group.

public GroupModel: * source 

import GroupModel from '@girder/lint/src/models/GroupModel.js'

public GroupModsWidget: * source 

import GroupModsWidget from '@girder/lint/src/views/widgets/GroupModsWidget.js'

This view shows a list of moderators of a group.

public GroupView: * source 

import GroupView from '@girder/lint/src/views/body/GroupView.js'

This view shows a single group's page.

public GroupsView: * source 

import GroupsView from '@girder/lint/src/views/body/GroupsView.js'

This view lists groups.

public HierarchyWidget: * source 

import HierarchyWidget from '@girder/lint/src/views/widgets/HierarchyWidget.js'

This widget is used to navigate the data hierarchy of folders and items.

public ItemBreadcrumbWidget: * source 

import ItemBreadcrumbWidget from '@girder/lint/src/views/widgets/ItemBreadcrumbWidget.js'

Renders the a breadcrumb for the item page

public ItemCollection: * source 

import ItemCollection from '@girder/lint/src/collections/ItemCollection.js'

public ItemListWidget: * source 

import ItemListWidget from '@girder/lint/src/views/widgets/ItemListWidget.js'

This widget shows a list of items under a given folder.

public ItemModel: * source 

import ItemModel from '@girder/lint/src/models/ItemModel.js'

public ItemView: * source 

import ItemView from '@girder/lint/src/views/body/ItemView.js'

This view shows a single item's page.

public Layout: {"DEFAULT": string, "EMPTY": string} source 

import {Layout} from '@girder/lint/src/constants.js'

public LayoutFooterView: * source 

import LayoutFooterView from '@girder/lint/src/views/layout/FooterView.js'

This view shows the footer in the layout.

public LayoutGlobalNavView: * source 

import LayoutGlobalNavView from '@girder/lint/src/views/layout/GlobalNavView.js'

This view shows a list of global navigation links that should be displayed at all times.

public LayoutHeaderUserView: * source 

import LayoutHeaderUserView from '@girder/lint/src/views/layout/HeaderUserView.js'

This view shows the user menu, or register/sign in links if the user is not logged in.

public LayoutHeaderView: * source 

import LayoutHeaderView from '@girder/lint/src/views/layout/HeaderView.js'

This view shows the header in the layout.

public LoadingAnimation: * source 

import LoadingAnimation from '@girder/lint/src/views/widgets/LoadingAnimation.js'

This widget can be used to display a small loading animation.

public LoginView: * source 

import LoginView from '@girder/lint/src/views/layout/LoginView.js'

This view shows a login modal dialog.

public MONTHS: string[] source 

import {MONTHS} from '@girder/lint/src/constants.js'

public MarkdownWidget: * source 

import MarkdownWidget from '@girder/lint/src/views/widgets/MarkdownWidget.js'

A simple widget for editing markdown text with a preview tab.

public MetadataMixin: {"_sendMetadata": *, "addMetadata": *, "removeMetadata": *, "editMetadata": *} source 

import MetadataMixin from '@girder/lint/src/models/MetadataMixin.js'

public MetadataWidget: * source 

import MetadataWidget from '@girder/lint/src/views/widgets/MetadataWidget.js'

This widget shows a list of metadata in a given item.

public Model: * source 

import Model from '@girder/lint/src/models/Model.js'

All models should descend from this base model, which provides a number of utilities for synchronization.

public NewAssetstoreWidget: * source 

import NewAssetstoreWidget from '@girder/lint/src/views/widgets/NewAssetstoreWidget.js'

This widget is for creating new assetstores. The parent view is responsible for checking admin privileges before rendering this widget.

public PaginateWidget: * source 

import PaginateWidget from '@girder/lint/src/views/widgets/PaginateWidget.js'

This widget is used to provide a consistent widget for iterating amongst pages of a Collection.

public PluginConfigBreadcrumbWidget: * source 

import PluginConfigBreadcrumbWidget from '@girder/lint/src/views/widgets/PluginConfigBreadcrumbWidget.js'

This widget provides a consistent breadcrumb to be displayed on the admin configuration pages for plugins.

public PluginsView: * source 

import PluginsView from '@girder/lint/src/views/body/PluginsView.js'

This is the plugin management page for administrators.

public ProgressListView: * source 

import ProgressListView from '@girder/lint/src/views/layout/ProgressListView.js'

Container showing list of active tasks that are reporting progress via a EventStream object.

public RegisterView: * source 

import RegisterView from '@girder/lint/src/views/layout/RegisterView.js'

This view shows a register modal dialog.

public ResetPasswordView: * source 

import ResetPasswordView from '@girder/lint/src/views/layout/ResetPasswordView.js'

This view shows a modal dialog for resetting a forgotten password.

public RootSelectorWidget: object source 

import RootSelectorWidget from '@girder/lint/src/views/widgets/RootSelectorWidget.js'

This widget creates a dropdown box allowing the user to select "root" paths for a hierarchy widget.

Properties:

NameTypeAttributeDescription
root Model | null

The selected root model
group string | null

The selection group
collection Collection

Emit:

*

RootSelectorWidget#g:selected The selected element changed

*

RootSelectorWidget#g:group A collection group was updated

public S3ImportView: * source 

import S3ImportView from '@girder/lint/src/views/body/S3ImportView.js'

public SORT_ASC: number source 

import {SORT_ASC} from '@girder/lint/src/constants.js'

public SORT_DESC: * source 

import {SORT_DESC} from '@girder/lint/src/constants.js'

public SearchFieldWidget: * source 

import SearchFieldWidget from '@girder/lint/src/views/widgets/SearchFieldWidget.js'

This widget provides a text field that will search any set of data types and show matching results as the user types. Results can be clicked, triggering a callback.

public SearchPaginateWidget: * source 

import SearchPaginateWidget from '@girder/lint/src/views/widgets/SearchPaginateWidget.js'

This widget is used to provide a consistent widget for iterating amongst pages of a list of search results (using a search mode, a query, an unique type, and a limit).

public SearchResultsView: * source 

import SearchResultsView from '@girder/lint/src/views/body/SearchResultsView.js'

This view display all the search results by instantiating a subview per each type found.

public SortCollectionWidget: * source 

import SortCollectionWidget from '@girder/lint/src/views/widgets/SortCollectionWidget.js'

This widget is used to provide a consistent widget for sorting pages of a Collection by a choosen field.

public SystemConfigurationView: * source 

import SystemConfigurationView from '@girder/lint/src/views/body/SystemConfigurationView.js'

The system config page for administrators.

public TaskProgressWidget: * source 

import TaskProgressWidget from '@girder/lint/src/views/widgets/TaskProgressWidget.js'

This widget renders the state of a progress notification.

public TimelineWidget: * source 

import TimelineWidget from '@girder/lint/src/views/widgets/TimelineWidget.js'

This widget displays a timeline of events. This is visualized as a line (a bar) with two sorts of primitives overlaid:

  1. Segments: spans of time, with a start and end.
  2. Points: a single point in time. Points always display on top of segments.

Any number of these primitives can be displayed on the timeline, so long as they are bounded between the specified startTime and endTime. The time values for startTime, endTime, and for the primitives can be specified either as numeric values (i.e. a relative offset in time), or as date strings that can be parsed by JavaScript, or as Date objects. For obvious reasons, in a single instance of this widget, it is not possible to mix the numeric/relative values with datestamp values.

public UploadWidget: * source 

import UploadWidget from '@girder/lint/src/views/widgets/UploadWidget.js'

This widget is used to upload files to a folder. Pass a folder model to its constructor as the parent folder that will be uploaded into. The events: itemComplete: Triggered each time an individual item is finished uploading. finished: Triggered when the entire set of items is uploaded.

public UserAccountView: * source 

import UserAccountView from '@girder/lint/src/views/body/UserAccountView.js'

This is the view for the user account (profile) page.

public UserCollection: * source 

import UserCollection from '@girder/lint/src/collections/UserCollection.js'

public UserModel: * source 

import UserModel from '@girder/lint/src/models/UserModel.js'

public UserOtpManagementWidget: * source 

import UserOtpManagementWidget from '@girder/lint/src/views/widgets/UserOtpManagementWidget.js'

public UserView: * source 

import UserView from '@girder/lint/src/views/body/UserView.js'

This view shows a single user's page.

public UsersView: * source 

import UsersView from '@girder/lint/src/views/body/UsersView.js'

This view lists users.

public View: * source 

import View from '@girder/lint/src/views/View.js'
import {cookie} from '@girder/lint/src/auth.js'

public corsAuth: boolean source 

import {corsAuth} from '@girder/lint/src/auth.js'

public girderEvents: * source 

import girderEvents from '@girder/lint/src/events.js'

public plugins: {} source 

import {plugins} from '@girder/lint/src/index.js'

public renderMarkdown(val: *, el: *): * source 

import {renderMarkdown} from '@girder/lint/src/misc.js'

Transform markdown into HTML and render it into the given element. If no element is provided, simply returns the HTML.

public uploadHandlers: {} source 

import {uploadHandlers} from '@girder/lint/src/rest.js'

public version: * source 

import version from '@girder/lint/src/version.js'