Class FilterFileBrowserModel

File browser model with optional filter on element.

Hierarchy (view full)

Constructors

constructor

Properties

_filter _filterDirectories _filterSettingsChanged _useFuzzyFilter manager translator

Accessors

connectionFailure driveName fileChanged filterDirectories filterSettingsChanged isDisposed path pathChanged refreshed restored rootPath specs uploadChanged useFuzzyFilter

Methods

cd dispose download handleContents items onFileChanged onRunningChanged refresh restore sessions setFilter showHiddenFiles upload uploads

Constructors

constructor

Properties

Private _filter

_filter: ((value) => null | Partial<IScore>)

Type declaration

Private _filterDirectories

_filterDirectories: boolean

Private _filterSettingsChanged

_filterSettingsChanged: Signal<FileBrowserModel, {
    caseSensitive?: boolean;
    disabled?: boolean;
    filterSettingsChanged?: ISignal<unknown, {
        caseSensitive?: boolean;
        disabled?: boolean;
        filterSettingsChanged?: ISignal<unknown, { caseSensitive?: boolean | undefined; disabled?: boolean | undefined; forceRefresh?: boolean | undefined; initialQuery?: string | undefined; inputRef?: RefObject<HTMLInputElement> | undefined; ... 4 more ...; filterSettingsChanged?: ISignal<...> | undefined; }> | undefined;
        forceRefresh?: boolean;
        initialQuery?: string;
        inputRef?: RefObject<HTMLInputElement>;
        placeholder?: string;
        showIcon?: boolean;
        updateFilter?: ((filterFn, query?) => void);
        useFuzzyFilter?: boolean;
    }>;
    forceRefresh?: boolean;
    initialQuery?: string;
    inputRef?: RefObject<HTMLInputElement>;
    placeholder?: string;
    showIcon?: boolean;
    updateFilter?: ((filterFn, query?) => void);
    useFuzzyFilter?: boolean;
}> = ...

Type declaration

  • Optional caseSensitive?: boolean

    Whether to use case-sensitive search

  • Optional disabled?: boolean

    Whether the search box is disabled or not.

  • Optional filterSettingsChanged?: ISignal<unknown, {
        caseSensitive?: boolean;
        disabled?: boolean;
        filterSettingsChanged?: ISignal<unknown, { caseSensitive?: boolean | undefined; disabled?: boolean | undefined; forceRefresh?: boolean | undefined; initialQuery?: string | undefined; inputRef?: RefObject<HTMLInputElement> | undefined; ... 4 more ...; filterSettingsChanged?: ISignal<...> | undefined; }> | undefined;
        forceRefresh?: boolean;
        initialQuery?: string;
        inputRef?: RefObject<HTMLInputElement>;
        placeholder?: string;
        showIcon?: boolean;
        updateFilter?: ((filterFn, query?) => void);
        useFuzzyFilter?: boolean;
    }>

    Signal emitted when filter settings change

  • Optional forceRefresh?: boolean

    Whether to force a refresh.

  • Optional initialQuery?: string

    An optional initial search value.

  • Optional inputRef?: RefObject<HTMLInputElement>

    Pass a ref to the input element

  • Optional placeholder?: string

    Optional placeholder for the search box.

  • Optional showIcon?: boolean

    Whether to show a search icon in the box.

  • Optional updateFilter?: ((filterFn, query?) => void)

    A function to callback when filter is updated.

  • Optional useFuzzyFilter?: boolean

    Whether to use the fuzzy filter.

Private _useFuzzyFilter

_useFuzzyFilter: boolean

Readonly manager

manager: IDocumentManager

The document manager instance used by the file browser model.

Protected translator

translator: ITranslator

Accessors

connectionFailure

driveName

  • get driveName(): string

  • The drive name that gets prepended to the path.

    Returns string

fileChanged

filterDirectories

filterSettingsChanged

  • get filterSettingsChanged(): ISignal<FileBrowserModel, {
        caseSensitive?: boolean;
        disabled?: boolean;
        filterSettingsChanged?: ISignal<unknown, {
            caseSensitive?: boolean;
            disabled?: boolean;
            filterSettingsChanged?: ISignal<unknown, { caseSensitive?: boolean | undefined; disabled?: boolean | undefined; forceRefresh?: boolean | undefined; initialQuery?: string | undefined; inputRef?: RefObject<HTMLInputElement> | undefined; ... 4 more ...; filterSettingsChanged?: ISignal<...> | undefined; }> | undefined;
            forceRefresh?: boolean;
            initialQuery?: string;
            inputRef?: RefObject<HTMLInputElement>;
            placeholder?: string;
            showIcon?: boolean;
            updateFilter?: ((filterFn, query?) => void);
            useFuzzyFilter?: boolean;
        }>;
        forceRefresh?: boolean;
        initialQuery?: string;
        inputRef?: RefObject<HTMLInputElement>;
        placeholder?: string;
        showIcon?: boolean;
        updateFilter?: ((filterFn, query?) => void);
        useFuzzyFilter?: boolean;
    }>

  • Signal for settings changed

    Returns ISignal<FileBrowserModel, {
        caseSensitive?: boolean;
        disabled?: boolean;
        filterSettingsChanged?: ISignal<unknown, {
            caseSensitive?: boolean;
            disabled?: boolean;
            filterSettingsChanged?: ISignal<unknown, { caseSensitive?: boolean | undefined; disabled?: boolean | undefined; forceRefresh?: boolean | undefined; initialQuery?: string | undefined; inputRef?: RefObject<HTMLInputElement> | undefined; ... 4 more ...; filterSettingsChanged?: ISignal<...> | undefined; }> | undefined;
            forceRefresh?: boolean;
            initialQuery?: string;
            inputRef?: RefObject<HTMLInputElement>;
            placeholder?: string;
            showIcon?: boolean;
            updateFilter?: ((filterFn, query?) => void);
            useFuzzyFilter?: boolean;
        }>;
        forceRefresh?: boolean;
        initialQuery?: string;
        inputRef?: RefObject<HTMLInputElement>;
        placeholder?: string;
        showIcon?: boolean;
        updateFilter?: ((filterFn, query?) => void);
        useFuzzyFilter?: boolean;
    }>

isDisposed

path

pathChanged

refreshed

restored

rootPath

specs

uploadChanged

useFuzzyFilter

Methods

cd

dispose

download

Protected handleContents

items

Protected onFileChanged

Protected onRunningChanged

refresh

restore

  • restore(id, populate?): Promise<void>

  • Restore the state of the file browser.

    Parameters

    • id: string

      The unique ID that is used to construct a state database key.

    • populate: boolean = true

      If false, the restoration ID will be set but the file browser state will not be fetched from the state database.

    Returns Promise<void>

    A promise when restoration is complete.

    Notes

    This function will only restore the model once. If it is called multiple times, all subsequent invocations are no-ops.

sessions

setFilter

showHiddenFiles

upload

  • upload(file, path?): Promise<Contents.IModel>

  • Upload a File object.

    Parameters

    • file: File

      The File object to upload.

    • Optional path: string

      The directory into which the file should be uploaded; defaults to current directory.

    Returns Promise<Contents.IModel>

    A promise containing the new file contents model.

    Notes

    On Notebook version < 5.1.0, this will fail to upload files that are too big to be sent in one request to the server. On newer versions, or on Jupyter Server, it will ask for confirmation then upload the file in 1 MB chunks.

uploads

Settings

Member Visibility

Theme

On This Page

constructor_filter_filterDirectories_filterSettingsChanged_useFuzzyFiltermanagertranslatorconnectionFailuredriveNamefileChangedfilterDirectoriesfilterSettingsChangedisDisposedpathpathChangedrefreshedrestoredrootPathspecsuploadChangeduseFuzzyFiltercddisposedownloadhandleContentsitemsonFileChangedonRunningChangedrefreshrestoresessionssetFiltershowHiddenFilesuploaduploads