For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-ui/interfaces/ImageOptions.md.

Interface: ImageOptions experimental

Beta

Options for configuring an image component.

Properties

onClick?

optional onClick?: () => void

Beta

Returns

void

Remarks

Sets a callback to be executed when the image is clicked.


tooltip?

optional tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage

Beta

Remarks

Sets a tooltip to be displayed when the user hovers over the image.


visible?

optional visible?: boolean | ObservableBoolean

Beta

Remarks

When false or bound to a false ObservableBoolean, the image is hidden.


width?

optional width?: number | ObservableNumber

Beta

Remarks

Sets the width of the image as a percentage of the width of the form. 1 is the entire form width, 0.5 is half of the form width. Greater than 1 or less than/equal to 0 will become 1.