Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Snippet

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Pages$Snippet"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

canvasHeight

  • get canvasHeight(): number
  • set canvasHeight(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

canvasWidth

  • get canvasWidth(): number
  • set canvasWidth(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

container

  • get container(): TContainer

  • The parent unit of this unit.

    Returns TContainer

containerAsFolderBase

containerAsModule

  • get containerAsModule(): Module

documentation

  • get documentation(): string
  • set documentation(newValue: string): void

  • In version 9.10.0: added public

    Returns string

  • In version 9.10.0: added public

    Parameters

    • newValue: string

    Returns void

entity

  • get entity(): null | IEntity
  • set entity(newValue: null | IEntity): void

entityQualifiedName

  • get entityQualifiedName(): null | string

excluded

  • get excluded(): boolean
  • set excluded(newValue: boolean): void

  • In version 9.11.0: added public

    Returns boolean

  • In version 9.11.0: added public

    Parameters

    • newValue: boolean

    Returns void

exportLevel

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    Returns void

isLoadable

  • get isLoadable(): boolean

  • Whether this unit and all of its children (recursively) can be loaded.

    Returns boolean

isLoaded

  • get isLoaded(): boolean

  • Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

  • Whether this unit and all of its children (recursively) are editable.

    Returns boolean

model

  • get model(): TModel

  • Returns TModel

name

  • get name(): string
  • set name(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

parameters

qualifiedName

  • get qualifiedName(): null | string

  • Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

    Returns null | string

type

  • In version 8.4.0: added public In version 8.0.0: introduced

    Returns SnippetType

  • In version 8.4.0: added public In version 8.0.0: introduced

    Parameters

    Returns void

unit

  • get unit(): this

  • Unit that owns/contains this thing.

    Returns this

variables

widget

  • In version 7.15.0: deleted

    Returns null | pages.Widget

  • In version 7.15.0: deleted

    Parameters

    Returns void

widgets

Methods

allProperties

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 Snippet

delete

  • delete(): void

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

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

  • 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: Snippet) => void
    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Snippet>

loadedProperties

publicProperties

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 IAbstractElementJson

traverse

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

  • 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

    Returns void

traverseFind

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

traversePublicParts

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

Static createIn

  • Creates a new Snippet unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns Snippet

Generated using TypeDoc