Skip to content

Commit

Permalink
Merge pull request #272 from jpazgeo/SOLENG-29294
Browse files Browse the repository at this point in the history
Updated possible page values where a button item can be added.
  • Loading branch information
muyuncaigeotab authored Dec 12, 2022
2 parents 24bb2df + 8ecffa5 commit 8d83ad5
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions src/software/guides/developing-addins.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,15 +181,12 @@ Each Add-In can define zero or more _items_ as part of its configuration file. A

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| page | Which built-in page to place the button on | String |
| page | Which built-in page to place the button on. *Possible values: 'map', 'tripsHistory', 'devices', 'device', 'zones', 'users', 'user', 'rules', 'rule', 'exceptions', 'customReports', 'customReport', 'engineFaults', 'speedProfile', 'hosLogs', 'hosLog', 'groupsTree', 'routes', 'fuelUsage', and 'engineMeasurements'.* | String |
| click | A URL to a JavaScript file which is executed when the button is clicked | String |
| buttonName | An object containing key value pairs for the text that appears on the button. The key is the language and the value is the text, for example `{"EN", "New menu item"}` | Object |
| icon | (To be deprecated June 04 2021) for placing it in the button label. This property is to be deprecated and replaced by svgIcon for versions 2102 onward. During transition period, if both icon and svgIcon exist, svgIcon will higher priority ([details here](https://www.geotab.com/blog/mygeotab-add-in-icons-specs/)) | String |
| svgIcon | A URL Reference to the svg image for placing it in the button label. Since the image file type is a vector, you only need submit one file in any color. The icon file will be updated to the appropriate colors ([details here](https://www.geotab.com/blog/mygeotab-add-in-icons-specs/)). A validator is available [here](#add-in-icon-validator) | String |




At least one language is required in each item definition. The following language options are currently supported in MyGeotab: English (`"en"`), French (`"fr"`), German (`"de"`), Spanish (`"es"`), Japanese (`"ja"`), Polish (`"pl"`) Brazilian Portuguese (`"pt-BR"`), Dutch (`"nl"`), Italian (`"it"`), Simplified Chinese (`"zh-Hans"`), Thai (`"th"`), Indonesian (`"id"`), Czech (`"cs"`), Swedish (`"sv"`) and Turkish (`"tr"`).

> Reference to the image can be an external URL such as: `https://mysite.com/images/icon.png;` or a link to the image from the images folder of your Add-In_._
Expand Down

0 comments on commit 8d83ad5

Please sign in to comment.