Media item interface

Hierarchy

Properties

AlbumId: string

The album identifier of the media item. Will be initialized upon creation with the media item's album identifier.

Classes: string[]

Additional CSS classes to add to the control.

Enabled: boolean

Enabled state of the UI element. When the type supports this, the UI element will be disabled when set to false.

Id: string

The id of the UI element.

IsDraggable: boolean

Flag indicating whether the media item can be dragged onto the canvas or not. The item will behave as the elements from the gallery. So can be droppoed onto existing image fields or as a new field on the canvas.

MediaItemId: string

The media item identifier of the media item. Will be initialized upon creation with the media item's identifier.

Name: string

Name of the UI element. For form fields that would be the name otherwise used for reference only.

OnClick: ((button) => void)

Type declaration

    • (button): void
    • The click event of the draggable button.

      Parameters

      Returns void

OnDragStart: ((button, event) => void)

Type declaration

    • (button, event): void
    • Register a callback for the drag start event.

      Parameters

      • button: MEUIMediaItem

        The draggable button which was dragged

      • event: "DragStart"

        The event type - always "DragStart"

      Returns void

OnDragStop: ((button, event) => void)

Type declaration

    • (button, event): void
    • Register a callback for the drag stop event.

      Parameters

      • button: MEUIMediaItem

        The draggable button which has been dragged

      • event: "DragStop"

        The event type - always "DragStop"

      Returns void

ParentClasses: string[]

Additional CSS classes to add to the parent control when supported.

Size?: MEUISize

The size of the UI element.

StandardClasses: string[]

The standard classes of the control. Modify this property only if you know what you are doing.

Tags: string[]

Tags for the UI element. Used for reference only.

TextDirection: TextFieldTextDirection

The text direction of the UI element. Defaults to Inherit, meaning it will use the editor default.

ToolTip?: string

Tooltip text of the UI element.

Type: "DraggableImage"

The type of the UI element. Always "DraggableImage".

Url: string

The URL to display the image as. Will be initialized with the thumbnail image of the media item upon creation.

Visible: boolean

Visibility flag of the UI element. When not visible it will be hidden from the UI.

Generated using TypeDoc