Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "DocumentTemplates$DynamicImageViewer"
versionInfo: StructureVersionInfo = ...

Accessors

  • get container(): TContainer
  • Returns TContainer

  • Returns DropZone

  • get defaultImage(): null | IImage
  • set defaultImage(newValue: null | IImage): void
  • Returns null | IImage

  • Parameters

    Returns void

  • get defaultImageQualifiedName(): null | string
  • Returns null | string

  • get entityPath(): string
  • set entityPath(newValue: string): void
  • The value of this property is conceptually of type paths.LegacyEntityPath.

    In version 7.11.0: deleted

    Returns string

  • The value of this property is conceptually of type paths.LegacyEntityPath.

    In version 7.11.0: deleted

    Parameters

    • newValue: string

    Returns void

  • In version 7.11.0: introduced

    Returns null | EntityRef

  • In version 7.11.0: introduced

    Parameters

    Returns void

  • get height(): number
  • set height(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

  • get model(): TModel
  • Returns TModel

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

  • Parameters

    • newValue: string

    Returns void

  • get useThumbnail(): boolean
  • set useThumbnail(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get width(): number
  • set width(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

Methods

  • 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 documenttemplates.DynamicImageViewer

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • toJSON(): IStructureJSON
  • 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(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<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new DynamicImageViewer 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 documenttemplates.DynamicImageViewer

  • Creates and returns a new DynamicImageViewer instance in the SDK and on the server. The new DynamicImageViewer will be automatically stored in the 'toplevels' property of the parent DocumentTemplate element passed as argument.

    Parameters

    Returns documenttemplates.DynamicImageViewer

  • Creates and returns a new DynamicImageViewer instance in the SDK and on the server. The new DynamicImageViewer will be automatically stored in the 'widget' property of the parent DropZone element passed as argument.

    Parameters

    Returns documenttemplates.DynamicImageViewer

Generated using TypeDoc