Interface PageAdminApi

This API provides administration functionality related to pages.

Accessed from the window at window.sas.vi.pageAdmin.

Example

window.sas.vi.pageAdmin.registerPageType(...);
interface PageAdminApi {
    registerPageType(name: string, applicationType: ApplicationType, templateType: TemplateType, controlGroups: Control<TypeAttributes>[], canvasCssClass: string, previewCssClass: string, options: any, dataTypeControlMappings: Record<string, any>): void;
}

Methods

registerPageType

Methods

registerPageType

  • registerPageType(name, applicationType, templateType, controlGroups, canvasCssClass, previewCssClass, options, dataTypeControlMappings): void

  • Parameters

    • name: string

      {string} A unique name for the configuration.

    • applicationType: ApplicationType

      {ApplicationType} The name of the application type used for this page. Must be a valid datahub client application (for example, "desktop" or "mobile").

    • templateType: TemplateType

      {TemplateType} The name of the template type used for this page. Must be a valid datahub template type (for example, "home" or "page").

    • controlGroups: Control<TypeAttributes>[]

      {Control[]} The control categories that are displayed in the designer's left hand side toolbox. Must be valid control categories.

    • canvasCssClass: string

      {string} A CSS class that is applied to the canvas in the designer.

    • previewCssClass: string

      {string} A CSS class that is applied to the preview (for example, template list).

    • options: any

      {object} Other designer options: hideSaveAs, customToolbarTemplateUrl, hidePageSettings, hidePreviewGroups.

    • dataTypeControlMappings: Record<string, any>

      {Record<string,any>} A mapping between the data type and the control used to generate data tab.

    Returns void

    Method

    Description

    Registers a page designer configuration.

Settings

Member Visibility

On This Page

Methods