Configuring a Mashup
Mashups can be any width and height. They can be embedded or can be used as a sub-mashup within another mashup. If you are embedding a mashup in a third-party application, use application keys for security and login. See Application Keys for more information on their creation and use.
 |
When viewing a mashup, you can add &__trace to the URL and see a detailed log of everything that is going on when loading the mashup. This can be a great tool for troubleshooting.
|
Default Data Services
A mashup will have the following data services available by default:
• Session:
The Session properties are found in the GlobalSessionProperties thing shape:. These properties can be retrieved and set in any mashup and will update wherever they are used.
• UserExtensions: The UserExtensions properties are found in the UserExtensions thing shape. These properties can be retrieved and set in any mashup and will update wherever they are used.
Properties
You can define any number of parameters for the mashup. These parameters become properties that can be used as binding sources or targets. Each mashup parameter has the ParameterNameChanged event associated with it.
|
Property Name
|
Description
|
Base Type
|
Default Value
|
Bindable? (Y/N)
|
Localizable? (Y/N)
|
||
|---|---|---|---|---|---|---|---|
|
Master
|
Optional master mashup.
|
n/a
|
N
|
N
|
|||
|
Style
|
Style of the mashup.
|
DefaultMashupStyle
|
N
|
N
|
|||
|
StyleTheme
|
Displays the style theme applied to the mashup. You can replace the default PTC Convergence Theme with your own custom style themes.
|
STRING
|
PTC Convergence Theme
|
Y
|
N
|
||
|
UseMasterTheme
|
Applies the style theme of the Master mashup to embedded mashups.
|
BOOLEAN
|
False
|
N
|
N
|
||
|
TitleBar
|
Displays or hides the title bar at the top of the gadget.
|
BOOLEAN
|
False
|
N
|
N
|
||
|
BGImageRepeat
|
The option for repeating the mashup’s image within the style definition. The options are: No Repeat, Repeat, Repeat Horizontally, Repeat Vertically.
|
STRING
|
No Repeat
|
N
|
N
|
||
|
BGImageSize
|
The image size of the The options are: Auto, Contain, Cover.
|
STRING
|
Auto
|
N
|
N
|
||
|
ShowDataLoading
|
Displays a spinner icon while data is being loaded.
|
BOOLEAN
|
True
|
N
|
N
|
||
|
Loaded
|
This events fires when the mashup is loaded and can be used to trigger any number of services and/or events.
|
n/a
|
n/a
|
Y
|
N
|
||
|
RefreshRequested
|
This event is triggered when the mashup is being refreshed and can be used to trigger any number of services and/or events.
|
n/a
|
n/a
|
Y
|
N
|
||
|
CloseIfPopup
|
Event. Triggers the mashup to close if it is being displayed within a pop-up.
|
n/a
|
n/a
|
Y
|
N
|
||
|
Refresh
|
Event. This event should be used externally so that you only have one auto-refresh on a page. It does not refresh the browser, instead it triggers RefreshRequested which you then bind to the services you would like to trigger.
|
n/a
|
n/a
|
Y
|
N
|
||
|
ResetInputsToDefaultValue
|
Event. Resets all the contained widgets to their default values.
|
n/a
|
Y
|
N
|