Global

Methods

onDialogApply(templateData)

Respond to edit dialog apply event

Parameters:
Name Type Description
templateData Object

New templatedata

Source:

onEditOpenDialogButton()

Respond to edit dialog button click.

Source:

openEditDialog(dataModel)

Open the templatedata edit dialog

Parameters:
Name Type Description
dataModel Model

The data model associated with this edit dialog.

Source:

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:

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:

Events

add-param

Parameters:
Name Type Description
key string

Parameter key

data Object

Parameter data

Source:

change

Source:

change-description

Parameters:
Name Type Attributes Description
description string

New template description

language Object <optional>

Description language, if supplied

Source:

change-paramOrder

Parameters:
Name Type Description
orderArray Array.<string>

Parameter key array in order

Source:

change-property

Parameters:
Name Type Attributes Description
paramKey string

Parameter key

prop string

Property name

value Mixed <repeatable>

Property value

Source: