This documentation is intended to help you create plugins for Datashare client. All methods currently exposed in the Core class are available to a global variable called datashare.

Example

datashare.replaceWidget('default-text', {
  card: true,
  cols: 6,
  type: 'WidgetText',
  content: "Welcome to my amazing project dashboard!",
  title: "Secret Project",
  order: "-1"
})

Core

Class representing the core application with public methods for plugins.

Kind: global class Mixes: FiltersMixin, HooksMixin, I18nMixin, PipelinesMixin, ProjectsMixin, WidgetsMixin

• Core

  • new Core(api, mode)

  • instance

    • .ready : Promise.<Object>

    • .app : Core

    • .core : Core

    • .bootstrapVue ⇒ Plugin

    • .i18n : I18n

    • .router : VueRouter

    • .store : Vuex.Store

    • .plugin ⇒ *

    • .auth : Auth

    • .config : Object

    • .api : Api

    • .vue : Vue

    • .wait : VueWait

    • .mode : String

    • .use(Plugin, options) ⇒ Core

    • .useAll() ⇒ Core

    • .useI18n() ⇒ Core

    • .useBootstrapVue() ⇒ Core

    • .useRouter() ⇒ Core

    • .useVuex() ⇒ Core

    • .useCommons() ⇒ Core

    • .useWait() ⇒ Core

    • .useCore() ⇒ Core

    • .buildCorePlugin() ⇒ VueCore

    • .configure() ⇒ Promise.<Object>

    • .mount([selector]) ⇒ Vue

    • .defer()

    • .dispatch(name, ...args) ⇒ Core

    • .getUser() ⇒ Promise.<Object>

    • .loadUser() ⇒ Promise

    • .loadSettings() ⇒ Promise

    • .setPageTitle(title, [suffix])

    • .on(event, callback)

    • .off(event, callback)

    • .emit(event, payload)

  • static

    • .init(...options) ⇒ Core

new Core(api, mode)

Create an application

datashare.ready : Promise.<Object>

Get a promise that is resolved when the application is ready

Kind: instance property of Core Fullfil: Object The actual application core instance.

datashare.app : Core

Deprecated

The application core instance. Deprecated in favor or the core property.

Kind: instance property of Core

datashare.core : Core

The application core instance

Kind: instance property of Core

datashare.bootstrapVue ⇒ Plugin

The Bootstrap Vue plugin instance.

Kind: instance property of Core

datashare.i18n : I18n

The I18n instance

Kind: instance property of Core

datashare.router : VueRouter

The VueRouter instance

Kind: instance property of Core

datashare.store : Vuex.Store

The Vuex instance

Kind: instance property of Core

datashare.plugin ⇒ *

The CorePlugin instance

Kind: instance property of Core

datashare.auth : Auth

The Auth module instance

Kind: instance property of Core

datashare.config : Object

The configuration object provided by Murmur

Kind: instance property of Core

datashare.api : Api

The Datashare api interface

Kind: instance property of Core

datashare.vue : Vue

The Vue app

Kind: instance property of Core

datashare.wait : VueWait

The VueWait

Kind: instance property of Core

datashare.mode : String

Get current Datashare mode

Kind: instance property of Core

datashare.use(Plugin, options) ⇒ Core

Add a Vue plugin to the app

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useAll() ⇒ Core

Configure all default Vue plugins for this application

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useI18n() ⇒ Core

Configure vue-i18n plugin

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useBootstrapVue() ⇒ Core

Configure bootstrap-vue plugin

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useRouter() ⇒ Core

Configure vue-router plugin

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useVuex() ⇒ Core

Configure vuex plugin

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useCommons() ⇒ Core

Configure most common Vue plugins (Murmur, VueShortkey, VueScrollTo and VueCalendar)

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useWait() ⇒ Core

Configure vue-wait plugin

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.useCore() ⇒ Core

Add a $core property to the instance's Vue

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.buildCorePlugin() ⇒ VueCore

Build a VueCore instance with the current Core instance as parameter of the global properties.

Kind: instance method of Core

datashare.configure() ⇒ Promise.<Object>

Load settings from the server and instantiate most the application configuration.

Kind: instance method of Core Fullfil: Core - The instance of the core application Reject: Object - The Error object

datashare.mount([selector]) ⇒ Vue

Mount the instance's vue application

Kind: instance method of Core Returns: Vue - The instantiated Vue

datashare.defer()

Build a promise to be resolved when the application is configured.

Kind: instance method of Core

datashare.dispatch(name, ...args) ⇒ Core

Dispatch an event from the document root, passing the core application through event message.

Kind: instance method of Core Returns: Core - the current instance of Core

datashare.getUser() ⇒ Promise.<Object>

Get the current signed user.

Kind: instance method of Core Fullfil: Object Current user

datashare.loadUser() ⇒ Promise

Get and update user definition in place

Kind: instance method of Core

datashare.loadSettings() ⇒ Promise

Get settings (both from the server settings and the current mode)

Kind: instance method of Core

datashare.setPageTitle(title, [suffix])

Append the given title to the page title

Kind: instance method of Core

datashare.on(event, callback)

Register a callback to an event using the EventBus singleton.

Kind: instance method of Core

datashare.off(event, callback)

Unregister a callback to an event using the EventBus singleton.

Kind: instance method of Core

datashare.emit(event, payload)

Emit an event using the EventBus singleton.

Kind: instance method of Core

Core.init(...options) ⇒ Core

instantiate a Core class (useful for chaining usage or mapping)

Kind: static method of Core

ComponentMixin

Mixin class extending the core to add helpers for components.

Kind: global mixin

FiltersMixin

Mixin class extending the core to add helpers for filters.

Kind: global mixin

• FiltersMixin

  • .registerFilter(...args)

  • .unregisterFilter(name)

  • .registerFilterForProject(name, ...args)

  • .unregisterFilterForProject(name, name)

datashare.registerFilter(...args)

Register a filter

Kind: instance method of FiltersMixin

datashare.unregisterFilter(name)

Unregister a filter

Kind: instance method of FiltersMixin

datashare.registerFilterForProject(name, ...args)

Register a filter only for a specific project

Kind: instance method of FiltersMixin

datashare.unregisterFilterForProject(name, name)

Unregister a filter only for a specific project

Kind: instance method of FiltersMixin

HooksMixin

Mixin class extending the core to add helpers for hooks.

Kind: global mixin

• HooksMixin

  • .registerHook(...args)

  • .unregisterHook(name)

  • .resetHook(name)

  • .resetHooks()

  • .registerHookForProject(project, options)

datashare.registerHook(...args)

Register a hook

Kind: instance method of HooksMixin

datashare.unregisterHook(name)

Unregister a specific hook

Kind: instance method of HooksMixin

datashare.resetHook(name)

Unregister all hooks from a target

Kind: instance method of HooksMixin

datashare.resetHooks()

Unregister all hooks, on every targets

Kind: instance method of HooksMixin

datashare.registerHookForProject(project, options)

Register a hook for a specific project

Kind: instance method of HooksMixin

I18nMixin

Mixin class extending the core to add helpers for i18n.

Kind: global mixin

• I18nMixin

  • .initializeI18n() ⇒ Promise

  • .setI18nLocale(locale) ⇒ String

  • .hasI18Locale(locale) ⇒ Boolean

  • .loadI18Locale(locale) ⇒ Promise

datashare.initializeI18n() ⇒ Promise

Initialize i18N using the local storage and load the necessary locale's messages

Kind: instance method of I18nMixin

datashare.setI18nLocale(locale) ⇒ String

Set the active locale both in local stoage and VueI18n.

Kind: instance method of I18nMixin

datashare.hasI18Locale(locale) ⇒ Boolean

Check the given locale storage was loaded.

Kind: instance method of I18nMixin

datashare.loadI18Locale(locale) ⇒ Promise

Load i18n messages for the given locale (if needed) and set it as the current locale.

Kind: instance method of I18nMixin

PipelinesMixin

Mixin class extending the core to add helpers for pipelines.

Kind: global mixin

• PipelinesMixin

  • .registerPipeline(...args, category)

  • .unregisterPipeline(name)

  • .registerPipelineForProject(project, ...args, category)

  • .unregisterPipelineForProject(project, name)

datashare.registerPipeline(...args, category)

Register a pipeline

Kind: instance method of PipelinesMixin

datashare.unregisterPipeline(name)

Unregister a pipeline

Kind: instance method of PipelinesMixin

datashare.registerPipelineForProject(project, ...args, category)

Register a pipeline for a specific project

Kind: instance method of PipelinesMixin

datashare.unregisterPipelineForProject(project, name)

Unregister a pipeline for a specific project

Kind: instance method of PipelinesMixin

ProjectsMixin

Mixin class extending the core to add helpers for projects.

Kind: global mixin

• ProjectsMixin

  • .toggleForProject(name, withFn, withoutFn, mutationType, storePath)

  • .createDefaultProject() ⇒ Promise:Object

datashare.toggleForProject(name, withFn, withoutFn, mutationType, storePath)

Call a function when a project is selected

Kind: instance method of ProjectsMixin

datashare.createDefaultProject() ⇒ Promise:Object

Create a default project on Datashare using the API

Kind: instance method of ProjectsMixin Returns: Promise:Object - The HTTP response object

WidgetsMixin

Mixin class extending the core to add helpers for widgets.

Kind: global mixin

• WidgetsMixin

  • .registerWidget(...args)

  • .unregisterWidget(name)

  • .clearWidgets()

  • .registerWidgetForProject(project, options)

  • .replaceWidget(name, options)

  • .replaceWidgetForProject(project, name, options)

datashare.registerWidget(...args)

Register a widget

Kind: instance method of WidgetsMixin

datashare.unregisterWidget(name)

Unregister a widget

Kind: instance method of WidgetsMixin

datashare.clearWidgets()

Unregister all widgets

Kind: instance method of WidgetsMixin

datashare.registerWidgetForProject(project, options)

Register a widget for a specific project

Kind: instance method of WidgetsMixin

datashare.replaceWidget(name, options)

Replace an existing widget

Kind: instance method of WidgetsMixin

Example

datashare.replaceWidget('default-text', {
 card: true,
 cols: 6,
 type: 'WidgetText',
 content: "Welcome to my amazing project dashboard!",
 title: "Secret Project",
 order: "-1"
})

datashare.replaceWidgetForProject(project, name, options)

Replace an existing widget for a specific project

Kind: instance method of WidgetsMixin

projects ⇒ Array:String

List all projects this user has access to.

Kind: global variable

projectIds ⇒ Array:String

List all projects name ids this user has access to.

Kind: global variable

defaultProject ⇒ String

Get the name of the default project

Kind: global variable

findComponent(name) ⇒ Promise.<(object|null)>

Asynchronously find a component in the lazyComponents object by its name.

Kind: global function Returns: Promise.<(object|null)> - - A promise that resolves with the found component object, or null if not found.

getComponent(name) ⇒ Promise.<(object|Error)>

Asynchronously get a component from the lazyComponents object based on its name.

Kind: global function Returns: Promise.<(object|Error)> - - A promise that resolves with the found component object, or rejects with an Error if not found.

sameComponentNames(...names) ⇒ boolean

Check if multiple component names are the same when slugified.

Kind: global function Returns: boolean - - True if all names are the same when slugified, false otherwise.

componentNameSlug(name) ⇒ string

Generate a slug from the component name using kebab case and lowercase.

Kind: global function Returns: string - - The slugified component name.

lazyComponents() ⇒ Object

Get the lazyComponents object using require.context for lazy loading of components.

Kind: global function Returns: Object - - The lazyComponents object generated using require.context.

defaultProjectExists() ⇒ Promise:Boolean

Return true if the default project exists

Kind: global function

findProject(name) ⇒ Object

Retrieve a project by its name

Kind: global function Returns: Object - The project matching with this name

deleteProject(name) ⇒ Promise:Integer

Delete a project by it name identifier.

Kind: global function Returns: Promise:Integer - Index of the project deleted or -1 if project does not exist

deleteProjectFromSearch(name)

Delete a project from the search store

Kind: global function

setProject(project) ⇒ Object

Update a project in the list or add it if it doesn't exist yet.

Kind: global function Returns: Object - The project

WidgetDiskUsage

Widget to display the disk space occupied by indexed files on the insights page.

Kind: global class

WidgetDocumentsByCreationDate

Widget to display the number of file by creation date on the insights page.

Kind: global class

WidgetDocumentsByCreationDateByPath

Widget to display number of files by creation date by path

Kind: global class

WidgetDuplicates

Widget for the insights page indicating the proportion of duplicates in the data.

Kind: global class

WidgetEmpty

Class representing the Empty widget. This widget is not intended to be used directly.

Kind: global class

new WidgetEmpty(name, card, cols, order)

Create a new WidgetEmpty

WidgetEntities

Widget to display text on the insights page

Kind: global class

WidgetFieldFacets

Widget to display a list of items or links on the insights page

Kind: global class

new WidgetFieldFacets(title, field, icon, routeQueryField, bucketTranslation, options)

Create a new WidgetFacets

WidgetFileBarometer

Widget to display the number of indexed files on the insights page

Kind: global class

WidgetListGroup

Widget to display a list of items or links on the insights page

Kind: global class

new WidgetListGroup(title, items, pipeline, options)

Create a new WidgetListGroup

WidgetNames

Widget to display names

Kind: global class

WidgetNested

Widget to display nested widgets

Kind: global class

new WidgetNested(widgets, options)

Create a new WidgetProject

WidgetProject

Widget to to display a search bar

Kind: global class

new WidgetProject(options)

Create a new WidgetProject

WidgetRecommendedBy

Widget to display latest recommend documents.

Kind: global class

new WidgetRecommendedBy(hideThumbnails, options)

Create a new WidgetRecommendedBy

WidgetSearchBar

Widget to to display a search bar

Kind: global class

new WidgetSearchBar(index, options)

Create a new WidgetSearchBar

WidgetText

Widget to display text on the insights page

Kind: global class

new WidgetText(title, content, pipeline, options)

Create a new WidgetText based on a WidgetEmpty

WidgetTreeMap

Class representing the TreeMap widget

Kind: global class

new WidgetTreeMap(title, index, options)

Create a new WidgetTreeMap based on a WidgetEmpty

To allow external developers to add their own components, we added markers called "hooks" in strategic locations on the user interface where a user can define new Vue Component through plugins.

Hooks locations