Image module

Important

The finance and operations (Dynamics 365) mobile app and platform are no longer supported. The platform components supporting the mobile app will be removed in a future update. The mobile app has also been removed from app stores. Previously installed instances of the app will continue to work. For more information, see Removed or deprecated platform features.

Image control for representing images in the mobile app. Images can be of any of the following types: DataUri, Base64, URL, AOTResource, or Symbol.

Index

Types

Type aliases

Types

Image

Hierarchy

Control
   └─ Image

Properties

Name Signature Description
container container: boolean (optional)
True if the control is a container.
Inherited from Control.container
generic generic: boolean (optional)
Inherited from Control.generic
getDataSource getDataSource: function(): any
Inherited from Control.getDataSource
hidden hidden: boolean
True if the control is hidden.
Inherited from Control.hidden
imageSource imageSource: string
Defines the imageSource.
imageView imageView: string
Dictates the style of the image.
placeholderClass placeholderClass: string
symbol symbol: string
Defines the symbol if the image is of type symbol.

Methods

Name Signature Description
applyDesign applyDesign(design: ImageDesign): void Applies given design to the design on the control.
Overrides Control.applyDesign
dataContext dataContext(): any Inherited from Control.dataContext
getDesign getDesign(): Design Returns the design object of this control.
Inherited from Control.getDesign
isEditable isEditable(): boolean Boolean indicating if the control is editable.
Inherited from Control.isEditable
metadata metadata(): ImageMetadata Returns the metadata object of this control.
Overrides Control.metadata
parent parent(): Control | Page Returns the parent (control or page) of this control.
Inherited from Control.parent
root root(): Page Returns the root form instance (page) of this control.
Inherited from Control.root

ImageDesign

Hierarchy

Design
   └─ ImageDesign

Properties

Name Signature Description
alignItems alignItems: string (optional)
This property is an alias for the CSS property "align-items".
Inherited from Design.alignItems
alignSelf alignSelf: string (optional)
Inherited from Design.alignSelf
bindings bindings: any (optional)
Inherited from Design.bindings
border border: "none" | "solid" | "left" | "right" | "top" | "bottom" (optional)
The border behavior of a control. This property will not be inherited by the children.
Inherited from Design.border
color color: string (optional)
The foreground color of the container.
Inherited from Design.color
flexFlow flexFlow: string (optional)
Specifying this property makes the component a flex container component.
Inherited from Design.flexFlow
flexSize flexSize: string (optional)
One number or two numbers written as a string. For example, "(size to grow) [(size-to-shrink)]" to accommodate available space in the immediate flex container.
Inherited from Design.flexSize
fontSize fontSize: "medium" | "xx-small" | "x-small" | "small" | "large" | "x-large" | "xx-large" (optional)
The proportional text size
Inherited from Design.fontSize
fontWeight fontWeight: "normal" | "bold" (optional)
Normal or bold text.
Inherited from Design.fontWeight
height height: string (optional)
The relative vertical size of the image.
imageStyle imageStyle: ImageStyleType (optional)
The style of the image.
justifyItems justifyItems: "flex-start" | "flex-end" | "center" | "space-between" (optional)
This property is an alias for the CSS property "justify-content".
Inherited from Design.justifyItems
label label: string (optional)
Inherited from Design.label
labelPosition labelPosition: "stacked" | "hidden" | "inline" (optional)
Determines how a label is positioned, if at all. By default, labelPosition is set to stacked.
Inherited from Design.labelPosition
name name: string (optional)
Inherited from Design.name
padding padding: "none" | "small" | "std" (optional)
Allows specifying the component's padding behavior.
Inherited from Design.padding
type type: ControlType (optional)
The type of the control as a string.
Inherited from Design.type
width width: string (optional)
The relative horizontal size of the image.

ImageMetadata

Hierarchy

ControlMetadata
   └─ ImageMetadata

Properties

Name Signature Description
BaseUrl BaseUrl: string (optional)
Base URL for AOTResource type image.
BoundEntity BoundEntity: string (optional)
The entity to which the control is bound.
Inherited from ControlMetadata.BoundEntity
BoundField BoundField: string (optional)
Inherited from ControlMetadata.BoundField
Description Description: string (optional)
Description of the control.
Inherited from ControlMetadata.Description
Editable Editable: boolean (optional)
Boolean indicating if the control is editable.
Inherited from ControlMetadata.Editable
ExtType ExtType: ControlType (optional)
The extended control type. For example, a control of type Input might have an extended type of Barcode.
Inherited from ControlMetadata.ExtType
Height Height: number (optional)
The relative vertical size of the image.
HelpText HelpText: string (optional)
The keyboard shortcut for a command. For example, "(Shift+F5)"
Inherited from ControlMetadata.HelpText
Hidden Hidden: boolean (optional)
Boolean indicating if the control is hidden or not.
Inherited from ControlMetadata.Hidden
Id Id: string (optional)
Identification string for a control.
Inherited from ControlMetadata.Id
ImageStyle ImageStyle: ImageStyleType (optional)
The style of the image.
Label Label: string (optional)
Label for a control. For example, a control representing a person's first name might have a label "First Name".
Inherited from ControlMetadata.Label
Name Name: string (optional)
Name of a control.
Inherited from ControlMetadata.Name
Order Order: number (optional)
Number indicating the order in which a control will appear on a page.
Inherited from ControlMetadata.Order
Type Type: ControlType (optional)
String indicating the control type.
Inherited from ControlMetadata.Type
Width Width: number (optional)
The relative horizontal size of the image.

Type aliases

ImageStyleType

ImageStyleType: "square" | "symbol" | "wide" | "circular" | "zoomable"