Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Image Collections

Image collections are Mendix’s way of bundling images (icons, logos, graphics) within a module. Each collection can contain multiple images in various formats (PNG, SVG, GIF, JPEG, BMP, WebP).

Inspecting Image Collections

-- List all image collections across all modules
SHOW IMAGE COLLECTION;

-- Filter by module
SHOW IMAGE COLLECTION IN MyModule;

-- View full definition including embedded images
DESCRIBE IMAGE COLLECTION MyModule.AppIcons;

The DESCRIBE output includes the full CREATE statement. If the collection contains images, they are shown with IMAGE 'name' FROM FILE 'path' syntax that can be copied and re-executed. In the TUI, images are rendered inline when the terminal supports it (Kitty, iTerm2, Sixel).

CREATE IMAGE COLLECTION

CREATE IMAGE COLLECTION <Module>.<Name>
  [EXPORT LEVEL 'Hidden'|'Public']
  [COMMENT '<description>']
  [(
    IMAGE <Name> FROM FILE '<path>',
    ...
  )];
OptionDescriptionDefault
EXPORT LEVEL'Hidden' (internal to module) or 'Public' (accessible from other modules)'Hidden'
COMMENTDocumentation for the collection(none)
IMAGE Name FROM FILELoad an image from the filesystem into the collection(none)

The image format is detected automatically from the file extension. Relative paths are resolved from the current working directory. Supported formats: PNG, SVG, GIF, JPEG, BMP, WebP.

Examples

-- Minimal: empty collection
CREATE IMAGE COLLECTION MyModule.AppIcons;

-- With export level
CREATE IMAGE COLLECTION MyModule.SharedIcons EXPORT LEVEL 'Public';

-- With comment
CREATE IMAGE COLLECTION MyModule.StatusIcons
  COMMENT 'Icons for order and task status indicators';

-- With images from files
CREATE IMAGE COLLECTION MyModule.NavigationIcons (
  IMAGE home FROM FILE 'assets/home.png',
  IMAGE settings FROM FILE 'assets/settings.svg'
);

-- All options combined
CREATE IMAGE COLLECTION MyModule.BrandAssets
  EXPORT LEVEL 'Public'
  COMMENT 'Company branding assets' (
  IMAGE logo_dark FROM FILE 'assets/logo-dark.png',
  IMAGE logo_light FROM FILE 'assets/logo-light.png'
);

DROP IMAGE COLLECTION

Remove a collection and all its embedded images:

DROP IMAGE COLLECTION MyModule.StatusIcons;

See Also