Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "PluginApi/Types"

Index

Type aliases

ApplyActionCallback

ApplyActionCallback: function

Type declaration

    • Parameters

      • fields: T

        Object with controls with reference ids from property dialog.

      • data: ElementDataDef

        Plugin data object that describes your plugin.

      • container: JQuery

        Plugins content root element (in this element your plugins template will be rendered).

      Returns void

FullWidthChangeActionCallback

FullWidthChangeActionCallback: function

Type declaration

    • (isFullWidth: boolean, data: ElementDataDef, container: JQuery): void
    • Parameters

      Returns void

GetStringArrayCallback

GetStringArrayCallback: function

Type declaration

LoadActionCallback

LoadActionCallback: function

Type declaration

LoadedActionCallback

LoadedActionCallback: function

Type declaration

    • Parameters

      • data: ElementDataDef

        Plugin data object that describes your plugin.

      • container: JQuery

        Plugins content root element (in this element your plugins template will be rendered).

      Returns void

NotifyHelpSystemPlayerCallback

NotifyHelpSystemPlayerCallback: function

Type declaration

    • (eventName: string, target: any): void
    • Parameters

      • eventName: string
      • target: any

      Returns void

OpenActionCallback

OpenActionCallback: function

Type declaration

    • Parameters

      • fields: T

        Object with controls with reference ids from property dialog.

      • data: ElementDataDef

        Plugin data object that describes your plugin.

      • container: JQuery

        Plugins content root element (in this element your plugins template will be rendered).

      Returns void

ResizeActionCallback

ResizeActionCallback: function

Type declaration

    • Parameters

      • data: ElementDataDef

        Plugin data object that describes your plugin.

      • container: JQuery

        Plugins content root element (in this element your plugins template will be rendered).

      Returns void

SaveActionCallback

SaveActionCallback: function

Type declaration

    • Parameters

      • data: ElementDataDef

        Plugin data object that describes your plugin.

      • container: JQuery

        Plugins content root element (in this element your plugins template will be rendered).

      Returns void

SetLocationCallback

SetLocationCallback: function

Type declaration

    • (left: number, top: number): void
    • Parameters

      • left: number
      • top: number

      Returns void

SetSizeCallback

SetSizeCallback: function

Type declaration

    • (width: number, height: number): void
    • Parameters

      • width: number
      • height: number

      Returns void

SwitchLanguageActionCallback

SwitchLanguageActionCallback: function

Type declaration

    • Parameters

      Returns void

SwitchModeActionCallback

SwitchModeActionCallback: function

Type declaration

UpdateActionCallback

UpdateActionCallback: function

Type declaration