Class LayoutGridColumn

Hierarchy

Element<IModel>
- LayoutGridColumn

Constructors

constructor

new LayoutGridColumn(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit<IAbstractModel>, container: AbstractElement<IAbstractModel, Container>): LayoutGridColumn

Overrides Element.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit<IAbstractModel>
- container: AbstractElement<IAbstractModel, Container>
Returns LayoutGridColumn

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Pages$LayoutGridColumn"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

appearance

get appearance(): Appearance
set appearance(newValue: Appearance): void

In version 8.0.0: introduced

Returns Appearance
In version 8.0.0: introduced

Parameters
- newValue: Appearance
Returns void

class

get class(): string
set class(newValue: string): void

In version 8.0.0: deleted

Returns string
In version 8.0.0: deleted

Parameters
- newValue: string
Returns void

container

get container(): TContainer

Inherited from internal.Element.container
Returns TContainer

containerAsLayoutGridRow

get containerAsLayoutGridRow(): LayoutGridRow

Returns LayoutGridRow

isLoaded

get isLoaded(): boolean

Inherited from internal.Element.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

model

get model(): TModel

Inherited from internal.Element.model
Returns TModel

phoneWeight

get phoneWeight(): number
set phoneWeight(newValue: number): void

In version 8.3.0: introduced

Returns number
In version 8.3.0: introduced

Parameters
- newValue: number
Returns void

previewWidth

get previewWidth(): number
set previewWidth(newValue: number): void

In version 9.16.0: introduced

Returns number
In version 9.16.0: introduced

Parameters
- newValue: number
Returns void

style

get style(): string
set style(newValue: string): void

In version 8.0.0: deleted

Returns string
In version 8.0.0: deleted

Parameters
- newValue: string
Returns void

tabletWeight

get tabletWeight(): number
set tabletWeight(newValue: number): void

In version 8.3.0: introduced

Returns number
In version 8.3.0: introduced

Parameters
- newValue: number
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Inherited from internal.Element.unit
Returns ModelUnit<IAbstractModel>

verticalAlignment

get verticalAlignment(): LayoutGridAlignment
set verticalAlignment(newValue: LayoutGridAlignment): void

In version 8.3.0: introduced

Returns LayoutGridAlignment
In version 8.3.0: introduced

Parameters
- newValue: LayoutGridAlignment
Returns void

weight

get weight(): number
set weight(newValue: number): void

Returns number
Parameters
- newValue: number
Returns void

widget

get widget(): null | pages.Widget
set widget(newValue: null | pages.Widget): void

In version 7.15.0: deleted

Returns null | pages.Widget
In version 7.15.0: deleted

Parameters
- newValue: null | pages.Widget
Returns void

widgets

get widgets(): IList<pages.Widget>

In version 7.15.0: introduced

Returns IList<pages.Widget>

Methods

allProperties

allProperties(): AbstractProperty<any, any>[]

Inherited from Element.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): LayoutGridColumn

Inherited from Element.asLoaded
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
- If invoked without callback, it checks whether the properties are available or it will throw;
- If invoked with callback, it will load the data from the server if needed, and then invoke the callback.
Returns LayoutGridColumn

deepCopy

deepCopy(targetModel: IAbstractModel): LayoutGridColumn

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns LayoutGridColumn

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }

Inherited from Element.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }
- copy: Element<IAbstractModel>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>

delete

delete(): void

Inherited from Element.delete

Deletes this element from the model.

Returns void

detach

detach(): LayoutGridColumn

Inherited from Element.detach

Detaches this element from the model, so that it can be attached in a different place.

Returns LayoutGridColumn

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Inherited from Element.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from Element.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: (elem: LayoutGridColumn) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<LayoutGridColumn>

Inherited from Element.load
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
- If invoked without callback, it checks whether the properties are available or it will throw;
- If invoked with callback, it will load the data from the server if needed, and then invoke the callback.
Parameters
- callback: (elem: LayoutGridColumn) => void
  - - (elem: LayoutGridColumn): void
    - Parameters
      - elem: LayoutGridColumn
      Returns void
- Optional forceRefresh: boolean
Returns void
Inherited from Element.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<LayoutGridColumn>

loadedProperties

loadedProperties(): AbstractProperty<any, any>[]

Inherited from Element.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

publicProperties(): AbstractProperty<any, any>[]

Inherited from Element.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Inherited from Element.toJSON

Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

Returns IStructureJSON

traverse

traverse(visit: (structure: IStructure) => void): void

Inherited from Element.traverse

Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: (structure: IStructure) => T): null | T

Inherited from Element.traverseFind

Traverses this structure, returning immediately when visit returns something other than null.

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

traversePublicParts(visit: (structure: IStructure) => void): void

Inherited from Element.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): LayoutGridColumn

Creates and returns a new LayoutGridColumn instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

Parameters
- model: IModel
Returns LayoutGridColumn

Static createIn

createIn(container: LayoutGridRow): LayoutGridColumn

Creates and returns a new LayoutGridColumn instance in the SDK and on the server. The new LayoutGridColumn will be automatically stored in the 'columns' property of the parent LayoutGridRow element passed as argument.

Parameters
- container: LayoutGridRow
Returns LayoutGridColumn

Generated using TypeDoc