trame.widgets.gwc module

class trame.widgets.gwc.GirderAccessControl(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderAccessControl Vue component

Parameters:

  • model – Object (required)

  • has_permission – Boolean (default: False)Events

:param forgot_password

Events :param update_model_access :param update_has_permission :param close

class trame.widgets.gwc.GirderAuthentication(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderAuthentication Vue component

Parameters:

  • register – Boolean (default: False)

  • oauth – Boolean (default: False)

  • forgot_password_url – String (default: null)

  • forgot_password_route – [Object, String] (default: null)

  • force_otp – Boolean (default: False)

  • hide_forgot_password – Boolean (default: False)

Events :param forgot_password

class trame.widgets.gwc.GirderBreadcrumb(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderBreadcrumb Vue component

Parameters:

  • location – Object (required)

  • readonly – Boolean (default: False)

  • append – Array (default: [])

  • root_location_disabled – Boolean (default: False)

Events :param crumb_click

class trame.widgets.gwc.GirderDataBrowser(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderDataBrowser Vue component

Parameters:

  • selected – Array (default [])

  • location – Object (default null)

  • root_location_disabled – Boolean (default False)

  • selectable – Boolean (default False)

  • draggable – Boolean (default False)

  • options – Number (default { itemsPerPage: 10, page: 1 })

Events :param update_selected :param update_location :param update_options :param row_click :param row_right_click :param drag :param drag_start :param drag_end :param drop

class trame.widgets.gwc.GirderDataDetails(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderDataDetails Vue component

Parameters:

  • value – Array (required)

  • info_keys – Array (default: DefaultInfoKeys)

  • action_keys – Array (default: DefaultActionKeys)

  • new_folder_enabled – Boolean (default False)

Events :param action

class trame.widgets.gwc.GirderDataTable(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderDataTable Vue component

Parameters:

  • draggable – Boolean (default False)

  • loading – Bool (default False)

  • options – Number (default { itemsPerPage: 10, page: 1 })

  • rows – Array (default [])

  • selectable – Boolean (default False)

  • selected – Boolean Array (default [])

  • server_items_length – Number (default 0)

Events :param update_selected :param update_options :param row_click :param row_right_click :param drag :param drag_start :param drag_end

class trame.widgets.gwc.GirderFileManager(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderFileManager Vue component

Parameters:

  • selected – Array (default [])

  • location – Object (default null)

  • root_location_disabled – Boolean (default False)

  • no_access_control – Boolean (default False)

  • selectable – Boolean (default False)

  • drag_enabled – Boolean (default False)

  • upload_enabled – Boolean (default False)

  • new_folder_enabled – Boolean (default False)

  • upload_max_show – Number (default 0)

  • upload_multiple – Boolean (default False)

  • upload_accept – String (default ‘*’)

  • pre_upload – Function (default: async {})

  • post_upload – Function (default: async {})

  • pre_upsert – Function (default: async {})

  • post_upsert – Function (default: async {})

  • items_per_page – Number (default 10)

  • items_per_page_options – Array (default [10, 25, 50])

Events :param update_selected :param update_location :param update_options :param row_click :param row_right_click :param drag :param drag_start :param dragend :param drop

class trame.widgets.gwc.GirderLogin(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderLogin Vue component

Parameters:

  • force_otp – Boolean (default: False)

  • forgot_password_url – String (default: null)

  • forgot_password_route – [Object, String] (default: null)

  • hide_forgot_password – Boolean (default: False)

  • oauth_providers – Boolean (default: False)

Events :param forgot_password

class trame.widgets.gwc.GirderProvider(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderProvider Vue component

Params: :compute_notification_bus: Boolean (default False) :listen_to_rest_client: Boolean (default True) # NotificationBus param :use_event_source: Boolean (default False) # NotificationBus param :with_credentials: Boolean (default False) # NotificationBus param :api_root: String (default None) # RestClient param :authenticate_with_credentials: Boolean (default False) # RestClient param :use_girder_authorization_header: Boolean (default False) # RestClient param :set_local_cookie: Boolean (default True) # RestClient param

Events :param user_logged_in :param user_logged_out :param user_registered :param api_root_updated :param user_fetched

register_layout(layout)

Register self to the root of the layout and clear any previously registered elements (to support hot reloading)

class trame.widgets.gwc.GirderRegister(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderRegister Vue component

Parameters:

oauth_providers – Boolean (default: False)

class trame.widgets.gwc.GirderSearch(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderSearch Vue component

Parameters:

  • hide_search_icon – Boolean (default: False)

  • hide_options_menu – Boolean (default: False)

  • max_quick_results – Number (default: 6)

  • placeholder – String (default: null)

  • search_mode_options – Array (default: SearchModeOptions)

  • search_mode – String (default: null)

  • search_type_options – Array (default: SearchTypeOptions)

  • search_types – validator (default: null)

  • show_more – Boolean (default: False)

Events :param update_search_mode :param update_search_types :param select :param error :param more_results

class trame.widgets.gwc.GirderUpload(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderUpload Vue component

Parameters:

  • dest – Object (required)

  • max_show – Number (default: 0)

  • multiple – Boolean (default: True)

  • pre_upload – Function (default: {})

  • post_upload – Function (default: {})

  • upload_cls – Function (default: Upload)

  • accept – Object (required)

  • start_button_text – String (default: ‘Start Upload’)

  • hide_start_button – Boolean (default: False)

  • hide_headline – Boolean (default: False)

Events :param files_changed :param error :param done

class trame.widgets.gwc.GirderUpsertFolder(children=None, **kwargs)

Bases: AbstractElement

Wraps GirderUpsertFolder Vue component

Parameters:

  • location – Object (required)

  • edit – Boolean (default: False)

  • pre_upsert – Function (default: {})

  • post_upsert – Function (default: {})