Interface SVGImageProps

The StructurePreviewProps type is used to define the structure of the widget preview. The widget preview is used to visualize the widget in the Mendix Studio Pro and Studio. It can be used to render a custom image, a container, a row layout, text, a drop zone, a selectable object, or a data source. The widget preview can be used to visualize the widget in the Mendix Studio Pro and Studio. It can be used to render a custom image, a container, a row layout, text, a drop zone, a selectable object, or a data source.

interface SVGImageProps {
    document: string;
    grow?: number;
    height?: number;
    property?: object;
    type: "Image";
    width?: number;
}

Hierarchy (view full)

Properties

document grow? height? property? type width?

Properties

document

document: string

An SVG image string

Optional grow

grow?: number

grow is optional and only takes effect if the current element is a child of a row layout

Optional height

height?: number

Integer. Sets a fixed maximum height

A fixed width and height can be set. If not set, it will maximize to the available width. If the width and height are set to an aspect ratio that is different from the original image aspect ratio, it will show a section of the image so the image is not distorted.

Optional property

property?: object

Widget image property object from Values API

type

type: "Image"

The type of the preview element

Link

https://docs.mendix.com/apidocs-mxsdk/apidocs/pluggable-widgets-config-api/#7-widget-preview-in-structure-mode

Optional width

width?: number

Integer. Sets a fixed maximum width

A fixed width and height can be set. If not set, it will maximize to the available width. If the width and height are set to an aspect ratio that is different from the original image aspect ratio, it will show a section of the image so the image is not distorted.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc