Interface IPluginSettingPage<T>

interface IPluginSettingPage {
    getProject?: (() => string);
    getSettingsDOM?: ((_setting?) => JQuery);
    paramChanged?: (() => void);
    renderSettingPage?: (() => void);
    saveAsync?: (() => JQueryDeferred<unknown>);
    settings?: (() => T);
    settingsChanged?: T;
    settingsOriginal?: T;
    showAdvanced?: (() => void);
    showSimple?: (() => void);
}

Type Parameters

  • T

Properties

getProject? getSettingsDOM? paramChanged? renderSettingPage? saveAsync? settings? settingsChanged? settingsOriginal? showAdvanced? showSimple?

Properties

Optional getProject

getProject?: (() => string)

Type declaration

    • (): string

    • Returns string

Optional getSettingsDOM

getSettingsDOM?: ((_setting?) => JQuery)

Type declaration

    • (_setting?): JQuery

    • Parameters

      • Optional _setting: T

      Returns JQuery

Optional paramChanged

paramChanged?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional renderSettingPage

renderSettingPage?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional saveAsync

saveAsync?: (() => JQueryDeferred<unknown>)

Type declaration

    • (): JQueryDeferred<unknown>

    • Returns JQueryDeferred<unknown>

Optional settings

settings?: (() => T)

Type declaration

    • (): T

    • Returns T

Optional settingsChanged

settingsChanged?: T

Optional settingsOriginal

settingsOriginal?: T

Optional showAdvanced

showAdvanced?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional showSimple

showSimple?: (() => void)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc