Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BuilderApi

Hierarchy

  • BuilderApi

Index

Methods

Methods

addElementAt

  • addElementAt(elementId: string | Element[], cx: number, cy: number, container?: Content | null): void

  • Parameters

    • elementId: string | Element[]
    • cx: number
    • cy: number
    • Optional container: Content | null

    Returns void

getBaseUrl

  • getBaseUrl(includeLanguage?: undefined | false | true): string

  • Parameters

    • Optional includeLanguage: undefined | false | true

    Returns string

getCompositionCollections

getElementPluginGroups

getElementPlugins

getLanguage

getLanguages

getLogoUrl

  • getLogoUrl(): string

  • Returns string

getModeEnabled

  • getModeEnabled(mode: string): boolean

  • Parameters

    • mode: string

    Returns boolean

getPanelUrl

  • getPanelUrl(): string

  • Returns string

getPlanUpgradeUrl

  • getPlanUpgradeUrl(): string | null

  • Returns string | null

getSignUpInfo

getSiteDomain

  • getSiteDomain(): string

  • Returns string

getSiteLanding

  • getSiteLanding(): boolean

  • Returns boolean

getSiteMenus

  • getSiteMenus(): MenuStruct[]

  • Returns MenuStruct[]

getSiteUrl

  • getSiteUrl(): string

  • Returns string

goToPage

  • goToPage(pageId: number | null, customUrl?: undefined | string): void

  • Parameters

    • pageId: number | null
    • Optional customUrl: undefined | string

    Returns void

hideContextMenus

  • hideContextMenus(): void

  • Returns void

hidePreview

  • hidePreview(): void

  • Returns void

historyRedo

  • historyRedo(): void

  • Returns void

historyUndo

  • historyUndo(): void

  • Returns void

init

  • init(elem: JQuery | HTMLElement): void

  • Parameters

    • elem: JQuery | HTMLElement

    Returns void

isAdminMode

  • isAdminMode(): boolean

  • Returns boolean

isAutoLayoutAvailable

  • isAutoLayoutAvailable(): boolean

  • Returns boolean

isAutoLayoutEnabled

  • isAutoLayoutEnabled(): boolean

  • Returns boolean

isBlockSavingAvailable

  • isBlockSavingAvailable(): boolean

  • Returns boolean

isBlockSavingEnabled

  • isBlockSavingEnabled(): boolean

  • Returns boolean

isComposerMode

  • isComposerMode(): boolean

  • Returns boolean

isElementCompositionSavingEnabled

  • isElementCompositionSavingEnabled(): boolean

  • Returns boolean

isElementStyleSavingAvailable

  • isElementStyleSavingAvailable(): boolean
  • deprecated

    Will be removed after 2019-06-01. Use isComposerMode instead.

    Returns boolean

isElementStyleSavingEnabled

  • isElementStyleSavingEnabled(): boolean

isFullScreenSupported

  • isFullScreenSupported(): boolean

  • Returns boolean

isHelpAvailable

  • isHelpAvailable(): boolean

  • Returns boolean

isHistoryRedoAvailable

  • isHistoryRedoAvailable(): boolean

  • Returns boolean

isHistoryUndoAvailable

  • isHistoryUndoAvailable(): boolean

  • Returns boolean

isImportAvailable

  • isImportAvailable(): boolean

  • Returns boolean

isImportVisible

  • isImportVisible(): boolean

  • Returns boolean

isPublishAvailable

  • isPublishAvailable(): boolean

  • Returns boolean

isResetTemplateButtonVisible

  • isResetTemplateButtonVisible(): boolean

  • Returns boolean

isRtl

  • isRtl(): boolean

  • Returns boolean

isTemplateSavingAvailable

  • isTemplateSavingAvailable(): boolean

  • Returns boolean

isTemplateSavingEnabled

  • isTemplateSavingEnabled(): boolean

  • Returns boolean

isTemplateSelectorVisible

  • isTemplateSelectorVisible(): boolean

  • Returns boolean

isTestMode

  • isTestMode(): boolean

  • Returns boolean

isTouchDevice

  • isTouchDevice(): boolean

  • Returns boolean

logout

  • logout(): void

  • Returns void

preview

  • preview(): void

  • Returns void

publish

  • publish(): void

  • Returns void

reloadPreview

  • reloadPreview(): void

  • Returns void

resetSite

  • resetSite(needComfirmDialog?: undefined | false | true): void

  • Parameters

    • Optional needComfirmDialog: undefined | false | true

    Returns void

save

  • save(useDialog: boolean, callback?: undefined | function): void

  • Parameters

    • useDialog: boolean
    • Optional callback: undefined | function

    Returns void

saveElementComposition

  • saveElementComposition(): void

  • Returns void

setAutoLayoutEnabled

  • setAutoLayoutEnabled(enabled: boolean): void

  • Parameters

    • enabled: boolean

    Returns void

setLanguage

  • Parameters

    Returns void

setMode

  • setMode(mode: string): void

  • Parameters

    • mode: string

    Returns void

setModeEnabled

  • setModeEnabled(mode: string, enabled: boolean): void

  • Parameters

    • mode: string
    • enabled: boolean

    Returns void

setPreviewWidth

  • setPreviewWidth(width: number): void

  • Parameters

    • width: number

    Returns void

setSiteLanding

  • setSiteLanding(enabled: boolean): void

  • Parameters

    • enabled: boolean

    Returns void

showBackupRestoreDialog

  • showBackupRestoreDialog(): void

  • Returns void

showGridAndGuidesDialog

  • showGridAndGuidesDialog(): void

  • Returns void

showHelp

  • showHelp(): void

  • Returns void

showImportDialog

  • showImportDialog(): void

  • Returns void

showSaveAsTemplateDialog

  • showSaveAsTemplateDialog(): void

  • Returns void

showSaveBlockDialog

  • showSaveBlockDialog(): void

  • Returns void

showSaveElementStyleDialog

  • showSaveElementStyleDialog(): void

showSiteBackgroundDialog

  • showSiteBackgroundDialog(): void

  • Returns void

showSiteFaviconDialog

  • showSiteFaviconDialog(): void

  • Returns void

showSitePropertiesDialog

  • showSitePropertiesDialog(): void

  • Returns void

showSiteSEODialog

  • showSiteSEODialog(): void

  • Returns void

showSiteStylesDialog

  • showSiteStylesDialog(): void

  • Returns void

showTemplateChooser

  • showTemplateChooser(): void

  • Returns void

sortAndAutoAlignElements

  • sortAndAutoAlignElements(): void

  • Returns void

toggleFullScreen

  • toggleFullScreen(): boolean

  • Returns boolean