Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DynamicImageViewer

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsDocumentTemplate

containerAsDocumentTemplate: DocumentTemplate

containerAsDropZone

containerAsDropZone: DropZone

defaultImage

defaultImage: IImage | null

defaultImageQualifiedName

defaultImageQualifiedName: string | null

entityPath

entityPath: string

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

In version 7.11.0: deleted

entityRef

entityRef: EntityRef | null

In version 7.11.0: introduced

height

height: number

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

name

name: string

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

useThumbnail

useThumbnail: boolean

width

width: number

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • 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: function
        • (elem: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • 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

    Returns DynamicImageViewer

Static createInDocumentTemplateUnderToplevels

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

Static createInDropZoneUnderWidget

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

Generated using TypeDoc