Maestro API Reference

Global

Type Definitions

RuntimeBrandUpdate

Image update details.
Type:
  • Object
Properties:
Name Type Description
css Object | Array.<Object> Update CSS resources included from the form
Properties
Name Type Description
id string CSS ID to update
cssUrl string URL to CSS use. To use CSS files bundled in FAR file, use "./css/" as the prefix.
cssContent string CSS Content to use for the CSS ID, this is ignored when a cssUrl is provided.
images RuntimeImageUpdate | Array.<RuntimeImageUpdate> New height for the image
translation string | object Set the Form translation, for string use the same code as Translation#fetch
Properties
Name Type Description
code string Optional code to pass to Translation#fetch - if not provided, the current locale will be updated
url string Optional URL to pass to Translation#fetch when the translation CSV is not in the FAR file.
layoutDir string | boolean Optional string ('rtl' | 'ltr') or boolean (true = 'r2l') to indicate whether to set Right-to-Left language functionality. Note that this will only be applied if R2L is enabled in the form (either a locale with R2L has been configured, or the "Allow R2L" form property is set)
values object Key/value pairs to update the translation dictionary. If a url or code have been provided, that language will be loaded before these values are applied. eg: translation: { values: { "firstName.label": "Your First Name" } } will update the label of the field with ID: firstName
dataValues object Key/value pairs to update into the data model, eg: dataValues: { footerUrl: "https://myUrl.com" } will get populated into data.footerUrl

RuntimeImageUpdate

Image update details.
Type:
  • Object
Properties:
Name Type Description
imgUrl string New URL for the image to use, using a relative URL like "./images/myImage.png" will get the image from the FAR file
imgHeight number New height for the image
imgWidth number New width for the image
alternativeText string Alt text for the image, this is populated into the alt attribute on the image.
toolTip string Tooltip text for the image, this is populated into the title attribute on the image.
imageLink string URL for the image to go to, leaving this blank or null will not take the user anywhere on click.
imageName string Image name to update, only used when passed to @see {@Form.updateBranding}