Skip to content

URL parameters

Azgaar edited this page Jan 25, 2021 · 4 revisions

Here is a list of parameters you can add to URL in order to set generator options and control its behavior on load. It can be used to share exactly the same generated coat of arms (COA) without need to send the image.

  • coa - string representing COA. It will provide exactly the same COA unless incompatible major change for the tool is deployed or you are using custom tinctures or charge. Use it like azgaar.github.io/Armoria/?coa={"t1":"or", "charges":[{"charge":"mascle","t":"vert","p":"jlh","size":0.7}]}. To get a correct link, just click on Share button at the Navigation pane.

  • seed - COA seed. Use like azgaar.github.io/Armoria/?seed=123 replacing 123 with COA seed. Seed will provide the same COA till the next tool update, so if you need to save it permanently, use a different method.

  • view - if set to 1 and coa or seed is provided, Armoria will open in view-only mode, without UI rendered. Use it like https://azgaar.github.io/Armoria/?view=1&size=100&noedit&coa={"t1":"or", "charges":[{"charge":"mascle","t":"vert","p":"jlh","size":0.7}]}. View-only mode is designed for embedding COA into other sites, consider using the code like below:

<embed
  type='image/svg+xml'
  src='https://azgaar.github.io/Armoria/?view=1&size=100&noedit&coa={%22t1%22:%22or%22,%22charges%22:[{%22charge%22:%22mascle%22,%22t%22:%22vert%22,%22p%22:%22jlh%22,%22size%22:0.7}]}'
  width='100'
  height='100'>

Make sure URL is encoded. To set edit mode COA dimensions use size parameter, the default size is 200px. On click, the same COA will be opened in Edit mode. To prevent this behavior add noedit parameter to URL.

Clone this wiki locally