JSDoc: Global

Methods

getCommunityConfiguration() → {Promise}

Get the community configuration for the featured templates.

Source:

ext.templateData.templateDiscovery/FeaturedTemplatesList.js, line 89

Returns:

Type: Promise

getTemplateData(templates) → {Promise}

Get the template data for a given set of templates.

Parameters:

Name	Type	Description
`templates`	Array	Template titles.

Source:

ext.templateData.templateDiscovery/FeaturedTemplatesList.js, line 105

Returns:

Type: Promise

onDialogApply(templateData)

Respond to edit dialog apply event

Parameters:

Name	Type	Description
`templateData`	Object	New templatedata

Source:

ext.templateDataGenerator.editTemplatePage/Target.js, line 238

onEditOpenDialogButton()

Respond to edit dialog button click.

Source:

ext.templateDataGenerator.editTemplatePage/Target.js, line 149

openEditDialog(dataModel)

Open the templatedata edit dialog

Parameters:

Name	Type	Description
`dataModel`	Model	The data model associated with this edit dialog.

Source:

ext.templateDataGenerator.editTemplatePage/Target.js, line 134

parsePageId(pageId) → {number}

Parse a page ID to a number, or throw an error

Parameters:

Name	Type	Description
`pageId`	string

Source:

ext.templateData.templateDiscovery/FavoritesStore.js, line 96

Throws:

If the pageId is not a number
Type Error

Returns:

The parsed page ID

Type: number

replaceTemplateData(newTemplateData)

Replace the old templatedata string with the new one, or insert the new one into the page if an old one doesn't exist

Parameters:

Name	Type	Description
`newTemplateData`	Object	New templatedata

Source:

ext.templateDataGenerator.editTemplatePage/Target.js, line 197

setNoticeMessage(label, type)

Display error message in the edit window

Parameters:

Name	Type	Description
`label`	jQuery \| string \| OO.ui.HtmlSnippet \| function \| null	Message to display
`type`	string	Message type 'notice', 'error', 'warning' or 'success'

Source:

ext.templateDataGenerator.editTemplatePage/Target.js, line 121

Events

add-param

Parameters:

Name	Type	Description
`key`	string	Parameter key
`data`	Object	Parameter data

Source:

ext.templateDataGenerator.data/Model.js, line 37

add-paramOrder

Parameters:

Name	Type	Description
`key`	string	Parameter key

Source:

ext.templateDataGenerator.data/Model.js, line 43

added

When favorite is added

Parameters:

Name	Type	Description
`pageId`	number

Source:

ext.templateData.templateDiscovery/FavoritesStore.js, line 29

change

Source:

ext.templateDataGenerator.data/Model.js, line 82

change-description

Parameters:

Name	Type	Attributes	Description
`description`	string		New template description
`language`	Object	<optional>	Description language, if supplied

Source:

ext.templateDataGenerator.data/Model.js, line 53

change-format

Parameters:

Name	Type	Attributes	Default	Description
`format`	string \| null	<optional>	null	Preferred format

Source:

ext.templateDataGenerator.data/Model.js, line 77

change-map

Parameters:

Name	Type	Description
`map`	Object \| undefined	New template map info

Source:

ext.templateDataGenerator.data/Model.js, line 72

change-paramOrder

Parameters:

Name	Type	Description
`orderArray`	Array.<string>	Parameter key array in order

Source:

ext.templateDataGenerator.data/Model.js, line 59

change-property

Parameters:

Name	Type	Description
`paramKey`	string	Parameter key
`prop`	string	Property name
`value`	Mixed
`language`	string

Source:

ext.templateDataGenerator.data/Model.js, line 64

choose

When a template is chosen from the list of favorites.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/FeaturedTemplatesList.js, line 122

choose

When a template is choosen from the menu.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/SearchWidget.js, line 44

choose

When a template is chosen from the list of favorites.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/TemplateList.js, line 79

choose

When a template is chosen.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/TemplateMenuItem.js, line 75

choose

When a template is choosen by searching or other means.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/TemplateSearchLayout.js, line 93

choose

When a template is chosen from the list of favorites.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/categories/CategoryBrowser.js, line 53

choose

When a template is chosen.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/categories/Column.js, line 50

choose

When a template is chosen.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/categories/ColumnGroup.js, line 28

choose

Parameters:

Name	Type	Description
`languageResultWidget`	LanguageResultWidget

Source:

ext.templateDataGenerator.editTemplatePage/widgets/LanguageResultWidget.js, line 36

choose

Parameters:

Name	Type	Description
`paramWidget`	ParamWidget

Source:

ext.templateDataGenerator.editTemplatePage/widgets/ParamWidget.js, line 44

delete-param

Parameters:

Name	Type	Description
`paramKey`	string	Parameter key

Source:

ext.templateDataGenerator.data/Model.js, line 48

drop

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/TemplateMenuItem.js, line 81

loadmore

When a "load more" item is clicked.

Parameters:

Name	Type	Description
`column`	Column
`cmcontinue`	string

Source:

ext.templateData.templateDiscovery/categories/Column.js, line 42

match

When the current value of the search input matches a search result (regardless of whether that result is highlighted).

Parameters:

Name	Type	Description
`templateData`	Object	Template data of the matched search result.

Source:

ext.templateData.templateDiscovery/SearchWidget.js, line 51

removed

When favorite is removed

Parameters:

Name	Type	Description
`pageId`	number

Source:

ext.templateData.templateDiscovery/FavoritesStore.js, line 23

select

When an item in this column is selected.

Parameters:

Name	Type	Description
`column`	Column
`columnItem`	ColumnItem

Source:

ext.templateData.templateDiscovery/categories/Column.js, line 34

select

When the item is selected.

Parameters:

Name	Type	Description
`The`	Object	template data of the chosen template.

Source:

ext.templateData.templateDiscovery/categories/ColumnItem.js, line 40