diff --git a/functions/utilities/README.md b/functions/utilities/README.md new file mode 100644 index 0000000000000000000000000000000000000000..1f395533aee28a26f31784d38af07ea177d3c436 --- /dev/null +++ b/functions/utilities/README.md @@ -0,0 +1,92 @@ +--- +marp: true +--- + +# Export Standardized Figure GUI + +--- +# General settings +--- + +On the top part of the GUI you can find: +* Text box for figure **name**: give the name of your plot but do not add the extension! Export settings will do it for you. +* Dropdown menu with the **list of all figures**: if no figure is opened, it will show *"No figures open"*. Otherwise by clicking on it you would find the list of all opened figures. +> **NOTE**: figures with tab will be treated as separated figures! By clicking on the figure which has tabs the GUI will separate them and you will be able to export them separately. + +--- + +* Two buttons: + * **Update Figures**: this button updates the list of figures if others are opened after the GUI started. + * **Update Preview**: this button updates the preview of the graphical changes directly on you figure +> **IMPORTANT**: once you click on the **Update Preview** button you can't modify settings on flag box, but you can still modify other settings like legend and export. + + +--- +## Flags +--- + +There are different types of flags you can select: +* **Add Markers**: by default is `true`. it will add by defaul as many markers as many point compose the plotted curve +* **Change Colors**: by default is `true`. it will change the colors from Matlab default to Export-standard ones +* **Change Line Style**: by default is `false`. it will change the style off all curves plotted, the style will be different for each line +* **Show Grid**: by default is `true`. shows grid in figure, whatever type (dafault or minor) +* **Stellite Map Colors**: by default is `false`. This flag will be *automatically* set to true for geoplots, and this should be activated together with Change Colors color flag. The colors of geoplots are changes due to contrast of maps. + +--- +## Export settings +--- + +Default value is `.pdf` format. + +You can export by choosing `.fig` or `.pdf` format, by respectively choosing **Export PDF** or **Export FIG** flags. If you want to export again a figure, by checking **Overwrite** flag, your figure will be automatically substituted by the new one. + +If you don't check **Overwrite** flag, it will be created a new figure or pdf with the same name + date time. + +--- +## Legend +--- + +Here you find two dropdown menus in which you can modify the position of the legends itself and of the legend labels. + +* **Location**: by default is `southwestoutside`. You can choose among the ones below + ```matlab + legendPositions = {'north', 'south', 'east', 'west', ... + 'northeast', 'northwest', 'southeast', 'southwest', ... + 'northoutside', 'southoutside', 'eastoutside', 'westoutside', ... + 'northeastoutside', 'northwestoutside', 'southeastoutside', 'southwestoutside', ... + 'best', 'bestoutside'}; + ``` +* **Orientation**: by default is `horizontal`. It will set the distribution of legend labels inside the legend box according to the number of labels. + +--- +## Bottom part +--- + + +* **Width/Height Ratio**: by dafault is set to 0. By modifing it you obtain different proportions on your figure. +* **Forced Markers**: by default is set to 0. You can set the number of markers you want in your curve *indipendently by the number of elements*. To do so Forced Markers should be true, otherwise you will get a warning and no markers are added. + ``` + Warning: addMarker is false and forcedMarkers is true: markers are not + displayed + ``` +* **Percentage of Text Width**: by default is set to 0.75, which means the figure will be exported in a format which is 75% of text width for *Latex* documents. You can change it, be sure not to put >1 values! + ``` + Error using exportStandardizedFigure + figure width is larger than the page! + ``` + +--- +## Export +--- + +If you click on **Export Figure** button and everything is okay you would get a succesfull message and you figure will be saved in the **current directory**. + +This is the line you need to add in *Latex* document to include your figure: +```latex +Figure saved successfully! + +text to copy: + {'\includegraphics[width=0.75\textwidth]{<add figure path>\prova.pdf}'} +``` + + diff --git a/functions/utilities/README.pdf b/functions/utilities/README.pdf new file mode 100644 index 0000000000000000000000000000000000000000..40496d63ee7ec2899d29dd03a350f6c96e84b50b Binary files /dev/null and b/functions/utilities/README.pdf differ