Interface BuildingBlock

See: relevant section in reference guide

interface BuildingBlock {
    $CreationOptions?: BuildingBlockCreationOptions;
    $ID: string;
    $Type: "Pages$BuildingBlock";
    canvasHeight: number;
    canvasWidth: number;
    displayName: string;
    documentation: string;
    documentationUrl: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    imageData: any;
    name: string;
    platform: SnippetType;
    templateCategory: string;
    templateCategoryWeight: number;
    widgets: Widget[];
    addActionButton(options: ActionButtonCreationOptions): Promise<ActionButton>;
    addCheckBox(options: CheckBoxCreationOptions): Promise<CheckBox>;
    addDataGrid(options: DataGridCreationOptions): Promise<DataGrid>;
    addDataView(options: DataViewCreationOptions): Promise<DataView>;
    addDatePicker(options: DatePickerCreationOptions): Promise<DatePicker>;
    addDivContainer(options: DivContainerCreationOptions): Promise<DivContainer>;
    addDropDown(options: DropDownCreationOptions): Promise<DropDown>;
    addDropDownButton(options: DropDownButtonCreationOptions): Promise<DropDownButton>;
    addDynamicImageViewer(options: DynamicImageViewerCreationOptions): Promise<DynamicImageViewer>;
    addDynamicText(options: DynamicTextCreationOptions): Promise<DynamicText>;
    addFileManager(options: FileManagerCreationOptions): Promise<FileManager>;
    addGroupBox(options: GroupBoxCreationOptions): Promise<GroupBox>;
    addHeader(options: HeaderCreationOptions): Promise<Header>;
    addImageUploader(options: ImageUploaderCreationOptions): Promise<ImageUploader>;
    addInputReferenceSetSelector(options: InputReferenceSetSelectorCreationOptions): Promise<InputReferenceSetSelector>;
    addLabel(options: LabelCreationOptions): Promise<Label>;
    addLayoutGrid(options: LayoutGridCreationOptions): Promise<LayoutGrid>;
    addListView(options: ListViewCreationOptions): Promise<ListView>;
    addLoginButton(options: LoginButtonCreationOptions): Promise<LoginButton>;
    addLoginIdTextBox(options: LoginIdTextBoxCreationOptions): Promise<LoginIdTextBox>;
    addMenuBar(options: MenuBarCreationOptions): Promise<MenuBar>;
    addNavigationList(options: NavigationListCreationOptions): Promise<NavigationList>;
    addNavigationTree(options: NavigationTreeCreationOptions): Promise<NavigationTree>;
    addPasswordTextBox(options: PasswordTextBoxCreationOptions): Promise<PasswordTextBox>;
    addPlaceholder(options: PlaceholderCreationOptions): Promise<Placeholder>;
    addRadioButtonGroup(options: RadioButtonGroupCreationOptions): Promise<RadioButtonGroup>;
    addReferenceSelector(options: ReferenceSelectorCreationOptions): Promise<ReferenceSelector>;
    addReferenceSetSelector(options: ReferenceSetSelectorCreationOptions): Promise<ReferenceSetSelector>;
    addScrollContainer(options: ScrollContainerCreationOptions): Promise<ScrollContainer>;
    addSidebarToggleButton(options: SidebarToggleButtonCreationOptions): Promise<SidebarToggleButton>;
    addSimpleMenuBar(options: SimpleMenuBarCreationOptions): Promise<SimpleMenuBar>;
    addSnippetCallWidget(options: SnippetCallWidgetCreationOptions): Promise<SnippetCallWidget>;
    addStaticImageViewer(options: StaticImageViewerCreationOptions): Promise<StaticImageViewer>;
    addTabContainer(options: TabContainerCreationOptions): Promise<TabContainer>;
    addTable(options: TableCreationOptions): Promise<Table>;
    addTemplateGrid(options: TemplateGridCreationOptions): Promise<TemplateGrid>;
    addTemplatePlaceholder(options: TemplatePlaceholderCreationOptions): Promise<TemplatePlaceholder>;
    addTextArea(options: TextAreaCreationOptions): Promise<TextArea>;
    addTextBox(options: TextBoxCreationOptions): Promise<TextBox>;
    addTitle(options: TitleCreationOptions): Promise<Title>;
    addValidationMessage(options: ValidationMessageCreationOptions): Promise<ValidationMessage>;
    getActionButton(name: string): ActionButton;
    getCheckBox(name: string): CheckBox;
    getDataGrid(name: string): DataGrid;
    getDataView(name: string): DataView;
    getDatePicker(name: string): DatePicker;
    getDivContainer(name: string): DivContainer;
    getDropDown(name: string): DropDown;
    getDropDownButton(name: string): DropDownButton;
    getDynamicImageViewer(name: string): DynamicImageViewer;
    getDynamicText(name: string): DynamicText;
    getFileManager(name: string): FileManager;
    getGroupBox(name: string): GroupBox;
    getHeader(name: string): Header;
    getImageUploader(name: string): ImageUploader;
    getInputReferenceSetSelector(name: string): InputReferenceSetSelector;
    getLabel(name: string): Label;
    getLayoutGrid(name: string): LayoutGrid;
    getListView(name: string): ListView;
    getLoginButton(name: string): LoginButton;
    getLoginIdTextBox(name: string): LoginIdTextBox;
    getMenuBar(name: string): MenuBar;
    getNavigationList(name: string): NavigationList;
    getNavigationTree(name: string): NavigationTree;
    getPasswordTextBox(name: string): PasswordTextBox;
    getPlaceholder(name: string): Placeholder;
    getRadioButtonGroup(name: string): RadioButtonGroup;
    getReferenceSelector(name: string): ReferenceSelector;
    getReferenceSetSelector(name: string): ReferenceSetSelector;
    getScrollContainer(name: string): ScrollContainer;
    getSidebarToggleButton(name: string): SidebarToggleButton;
    getSimpleMenuBar(name: string): SimpleMenuBar;
    getSnippetCallWidget(name: string): SnippetCallWidget;
    getStaticImageViewer(name: string): StaticImageViewer;
    getTabContainer(name: string): TabContainer;
    getTable(name: string): Table;
    getTemplateGrid(name: string): TemplateGrid;
    getTemplatePlaceholder(name: string): TemplatePlaceholder;
    getTextArea(name: string): TextArea;
    getTextBox(name: string): TextBox;
    getTitle(name: string): Title;
    getValidationMessage(name: string): ValidationMessage;
}

Hierarchy (view full)

Properties

$CreationOptions? $ID $Type canvasHeight canvasWidth displayName documentation documentationUrl excluded exportLevel imageData name platform templateCategory templateCategoryWeight widgets

Methods

addActionButton addCheckBox addDataGrid addDataView addDatePicker addDivContainer addDropDown addDropDownButton addDynamicImageViewer addDynamicText addFileManager addGroupBox addHeader addImageUploader addInputReferenceSetSelector addLabel addLayoutGrid addListView addLoginButton addLoginIdTextBox addMenuBar addNavigationList addNavigationTree addPasswordTextBox addPlaceholder addRadioButtonGroup addReferenceSelector addReferenceSetSelector addScrollContainer addSidebarToggleButton addSimpleMenuBar addSnippetCallWidget addStaticImageViewer addTabContainer addTable addTemplateGrid addTemplatePlaceholder addTextArea addTextBox addTitle addValidationMessage getActionButton getCheckBox getDataGrid getDataView getDatePicker getDivContainer getDropDown getDropDownButton getDynamicImageViewer getDynamicText getFileManager getGroupBox getHeader getImageUploader getInputReferenceSetSelector getLabel getLayoutGrid getListView getLoginButton getLoginIdTextBox getMenuBar getNavigationList getNavigationTree getPasswordTextBox getPlaceholder getRadioButtonGroup getReferenceSelector getReferenceSetSelector getScrollContainer getSidebarToggleButton getSimpleMenuBar getSnippetCallWidget getStaticImageViewer getTabContainer getTable getTemplateGrid getTemplatePlaceholder getTextArea getTextBox getTitle getValidationMessage

Properties

Optional$CreationOptions

$CreationOptions?: BuildingBlockCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type

The type of the element.

canvasHeight

canvasHeight: number

canvasWidth

canvasWidth: number

displayName

displayName: string

documentation

documentation: string

documentationUrl

documentationUrl: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

imageData

imageData: any

name

name: string

platform

platform: SnippetType

templateCategory

templateCategory: string

templateCategoryWeight

templateCategoryWeight: number

widgets

widgets: Widget[]

Methods

addActionButton

addCheckBox

addDataGrid

addDataView

addDatePicker

addDivContainer

addDropDown

addDropDownButton

addDynamicImageViewer

addDynamicText

addFileManager

addGroupBox

addHeader

addImageUploader

addInputReferenceSetSelector

addLabel

addLayoutGrid

addListView

addLoginButton

addLoginIdTextBox

addMenuBar

addNavigationList

addNavigationTree

addPasswordTextBox

addPlaceholder

addRadioButtonGroup

addReferenceSelector

addReferenceSetSelector

addScrollContainer

addSidebarToggleButton

addSimpleMenuBar

addSnippetCallWidget

addStaticImageViewer

addTabContainer

addTable

addTemplateGrid

addTemplatePlaceholder

addTextArea

addTextBox

addTitle

addValidationMessage

getActionButton

getCheckBox

getDataGrid

getDataView

getDatePicker

getDivContainer

getDropDown

getDropDownButton

getDynamicImageViewer

getDynamicText

getFileManager

getGroupBox

getHeader

getImageUploader

getInputReferenceSetSelector

getLabel

  • getLabel(name): Label

  • Parameters

    • name: string

    Returns Label

getLayoutGrid

getListView

getLoginButton

getLoginIdTextBox

getMenuBar

getNavigationList

getNavigationTree

getPasswordTextBox

getPlaceholder

getRadioButtonGroup

getReferenceSelector

getReferenceSetSelector

getScrollContainer

getSidebarToggleButton

getSimpleMenuBar

getSnippetCallWidget

getStaticImageViewer

getTabContainer

getTable

  • getTable(name): Table

  • Parameters

    • name: string

    Returns Table

getTemplateGrid

getTemplatePlaceholder

getTextArea

getTextBox

getTitle

  • getTitle(name): Title

  • Parameters

    • name: string

    Returns Title

getValidationMessage

Settings

On This Page

Properties
Methods
addActionButtonaddCheckBoxaddDataGridaddDataViewaddDatePickeraddDivContaineraddDropDownaddDropDownButtonaddDynamicImageVieweraddDynamicTextaddFileManageraddGroupBoxaddHeaderaddImageUploaderaddInputReferenceSetSelectoraddLabeladdLayoutGridaddListViewaddLoginButtonaddLoginIdTextBoxaddMenuBaraddNavigationListaddNavigationTreeaddPasswordTextBoxaddPlaceholderaddRadioButtonGroupaddReferenceSelectoraddReferenceSetSelectoraddScrollContaineraddSidebarToggleButtonaddSimpleMenuBaraddSnippetCallWidgetaddStaticImageVieweraddTabContaineraddTableaddTemplateGridaddTemplatePlaceholderaddTextAreaaddTextBoxaddTitleaddValidationMessagegetActionButtongetCheckBoxgetDataGridgetDataViewgetDatePickergetDivContainergetDropDowngetDropDownButtongetDynamicImageViewergetDynamicTextgetFileManagergetGroupBoxgetHeadergetImageUploadergetInputReferenceSetSelectorgetLabelgetLayoutGridgetListViewgetLoginButtongetLoginIdTextBoxgetMenuBargetNavigationListgetNavigationTreegetPasswordTextBoxgetPlaceholdergetRadioButtonGroupgetReferenceSelectorgetReferenceSetSelectorgetScrollContainergetSidebarToggleButtongetSimpleMenuBargetSnippetCallWidgetgetStaticImageViewergetTabContainergetTablegetTemplateGridgetTemplatePlaceholdergetTextAreagetTextBoxgetTitlegetValidationMessage