Image
Displays an image and makes it clickable if needed.
Appearance
Border radius: | Radius of curvature for the image corners. | String |
Width: | The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. | String |
Height: | Height in px, em\r\nFor example\: 50px, 0.4em. If no unit is specified, px is assumed. | String |
Behavior
Prevent multiple clicks: | Prevent the user from clicking the image more than once. | Boolean |
Image URL type: | URL type. Note: For images that are not hosted on the local server, use External. {Web | External} |
URLType |
Image app acronym: | The acronym of the process app or toolkit that contains the image. | String |
Default image URL: | If the view is not bound, this is the URL for the image. | String |
Default image URL type: | If the view is not bound this is the URL type. Note: For images that are not hosted on the local server, use External. {Web | External} |
URLType |
Default image app acronym: | The default acronym of the process app or toolkit that contains the image. | String |
>
Events | ||||||
On Load: |
| |||||
On Click: |
|
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
Name | Type | Default | Description |
name | {string} | CSS class name(s) to add to the control. Separate class names by a space if more than one class. | |
replaced | {string} | CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class. |
Example
Button.addClass("green"); |
click()
Programmatically click this image
getHeight()
Returns:
{string}
Get configured size for image (including unit)
getType()
Returns:
{string}
Get descriptive string representing the type of control
getWidth()
Returns:
{string}
Get configured size for image (including unit)
Inherited
hide(collapseFlag)
Hide this view/control
Name | Type | Default | Description |
collapseFlag | {boolean} | Set to true to collapse the view (equivalent to a view setting of "NONE") |
Example
MyView.hide(); |
Inherited
isBound()
Returns:
{boolean}
Indicates bound status of control.
Inherited
isEnabled()
Returns:
{boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled(); |
Inherited
isVisible()
Returns:
{boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible(); |
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagates value change of control up through parent views
Name | Type | Default | Description |
event | {Event} | Value change event (usually an onchange event) |
Example
MyView.propagateUp(event); |
Inherited
setEnabled(enabled, required)
Enable/disable this view/control
Name | Type | Default | Description |
enabled | {boolean} | Enabled/read-only flag (true to enable view, false to disable/make read-only) | |
required | {boolean} | Enable/disable required field flag for control |
Example
MyView.setEnabled(false); //Make MyView read-only |
setHeight(height)
Set size of image (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
height | {string} | the height of the image |
setImage(img, type)
Set the image to be displayed
Name | Type | Default | Description |
img | {string} | Image url | |
type | {string} | "External" | "Web" | "Server" | "Design" |
Example
${Image1}.setImage("Image1.png", "Web"); |
setRadius(radius)
Sets radius (roundness) of image
Name | Type | Default | Description |
radius | {string} | Border radius |
Inherited
setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
binding.set
pattern detailed in the Knowlege Center section Binding Data and Configuration OptionsName | Type | Default | Description |
data | {Object} | Value of bound data. The type of this parameter must match the type of the bound data. | |
createPseudoBinding | {boolean} | If set to true, creates a pseudo binding if there is no current binding. |
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
Inherited
setVisible(visible, collapse)
Show/hide this view/control
Name | Type | Default | Description |
visible | {boolean} | Visibility flag (true to show view, false to hide) | |
collapse | {boolean} | Set to true to collapse the control space when visible is set to false . |
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide() |
MyView.setVisible(false, true); // Sets visibility to "None" |
setWidth(width)
Set size of image (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
width | {string} | the width of the image |
Inherited
show()
Show this view/control
Example
MyView.show(); |
Inherited
triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
Name | Type | Default | Description |
phase | {int} | bpmext.ui.PHASE_NORMAL | The phase we are currently in |
Example
MyView.triggerFormulaUpdates(); |