Interface EditorHandler

Readonly CustomDataCategory

Readonly Data

Readonly Events

Readonly ExternalApi

Readonly Helper

Readonly ImmediateActions

Readonly Invent

Readonly Loc

Readonly Resources

Readonly Selection

Readonly ServerSide

Readonly UI

Readonly View

CheckSecurity

• CheckSecurity(type): boolean

• Checks if the current user has the specified permission. This should be used before attemting to execute any action that requires a specific permission.

  Parameters

  • type: PermissionScope

    The scope of the permission to check.

  Returns boolean

  True if the current user has the specified permission, and false if it does not.

ClearUndoItems

• ClearUndoItems(): void

• Clears the current undo stack. As script operations can generate a series of undo items, this function can be used to clear the undo stack.

  Returns void

FormatPrice

• FormatPrice(price): number

• Returns the specified price with the formatting configured for that storefront (e.g. currency symbol, decimal separator, etc.)

  Parameters

  • price: number

    The price to format.

  Returns number

  The formatted price.

GenerateMegaScriptLink

• GenerateMegaScriptLink(parameters, additionalValues): string

• Helper function to generate a link to the MegaScript handler for a specific instance. This allows you to add custom functionality to the editor.

  Parameters

  • parameters: MegaScriptIdentifier

    The megascript identifier.

  • additionalValues: {
        [Key: string]: string;
    }

    Additional dictionary which will be added to the query string of the generated URL.

    • [Key: string]: string

  Returns string

  The absolute URL for the mega script handler.

IsAdmin

• IsAdmin(): boolean

• Test if the current user is an administrator (aka user with administration rights for MegaEdit).

  Returns boolean

  True if the current user is an administrator, and false if it is not.

IsEmbedded

• IsEmbedded(): boolean

• Test if the editor is running in an embedded context.

  Returns boolean

  True if the editor is running in an embedded context, and false if it runs standalone.

IsInIFrame

• IsInIFrame(): boolean

• Test if the editor is running in an iframe.

  Returns boolean

  True if the editor is running in an iframe, and false if it runs standalone.

IsRunningServerSide

• IsRunningServerSide(): boolean

• Test if the current execution is client or server side.

  Returns boolean

  True if the script is running server side, and false if it runs on the editor.

ReportLoadStep

• ReportLoadStep(loadStep): void

• Reports a custom load step. Load steps allow to add additional custom steps to the loading process of the editor. The loading overlay will be extended with each step. Steps can be configured within the administration interface and scripts have to report the steps once they are done. Multiple custom steps are supported. The script should report the step only once it would be ok with the user interface to show.

  Parameters

  • loadStep: string

    The load step to report. This should be the name of the step as configured in the administration interface.

  Returns void

SetEditorStatus

• SetEditorStatus(stat, value): void

• Set the editor status for the given status item. This allows to enable/disable certain editor functionality via a script.

  Parameters

  • stat: EditorStatusItems

    The status item to control.

  • value: unknown

    The value to set. The type of the value depends on the status item.

  Returns void