Difference between revisions of "ExportImage Command"
From GeoGebra Manual
Noel Lambert (talk | contribs) (view -1 > 3D) |
(added Examples template - added reference to view number parameters) |
||
Line 4: | Line 4: | ||
:Exports an image of the currently active view (or the view specified by the "view" parameter) | :Exports an image of the currently active view (or the view specified by the "view" parameter) | ||
− | + | ||
− | ;<code>ExportImage("scale", 5)</code> | + | {{note|1= :* The ''Properties'' used in the command syntax, listed in the following examples, need to be entered in English. |
+ | :*The values related to the View that will be saved as image are: | ||
+ | ::* 1 for [[File:Menu view graphics.svg|link=|16px]] ''Graphics View'' | ||
+ | ::* 2 for [[File:Menu view graphics2.svg|link=|16px]] ''Graphics View'' 2 | ||
+ | ::* -1 for [[File:Perspectives algebra 3Dgraphics.svg|link=|16px]] 3''D View''}} | ||
+ | |||
+ | |||
+ | {{examples|1=<br> | ||
+ | *;<code>ExportImage("scale", 5)</code> | ||
: Shows a popup of the current view so that the user can right-click -> Save Image As... | : Shows a popup of the current view so that the user can right-click -> Save Image As... | ||
− | ;<code>ExportImage("filename", "image.png")</code> | + | *;<code>ExportImage("filename", "image.png")</code> |
: Saves a file called "image.png" of the current view | : Saves a file called "image.png" of the current view | ||
− | ;<code>ExportImage("filename", "image.png", "view", 2)</code> | + | *;<code>ExportImage("filename", "image.png", "view", 2)</code> |
: Saves a file called "image.png" of Graphics View 2 | : Saves a file called "image.png" of Graphics View 2 | ||
− | ;<code>ExportImage("filename", "image.png", "view", -1)</code> | + | *;<code>ExportImage("filename", "image.png", "view", -1)</code> |
: Saves a file called "image.png" of View 3D Graphics | : Saves a file called "image.png" of View 3D Graphics | ||
− | ;<code>ExportImage("filename", "image.png", "dpi", 300)</code> | + | *;<code>ExportImage("filename", "image.png", "dpi", 300)</code> |
: Saves a file called "image.png" of the current view at 300 dpi (dots-per-inch) | : Saves a file called "image.png" of the current view at 300 dpi (dots-per-inch) | ||
− | ;<code>ExportImage("filename", "image.png", "scale", 2)</code> | + | *;<code>ExportImage("filename", "image.png", "scale", 2)</code> |
: Saves a file called "image.png" of the current view at scale 2 (ie twice nominal screen resolution) | : Saves a file called "image.png" of the current view at scale 2 (ie twice nominal screen resolution) | ||
− | ;<code>ExportImage("filename", "image.png", scalecm", 2, "dpi", 600)</code> | + | *;<code>ExportImage("filename", "image.png", scalecm", 2, "dpi", 600)</code> |
: Saves a file called "image.png" of the current view at 600 dpi at a scale 1 unit = 2 cm | : Saves a file called "image.png" of the current view at 600 dpi at a scale 1 unit = 2 cm | ||
− | ;<code>ExportImage("filename", "image.png", "width", 1000)</code> | + | *;<code>ExportImage("filename", "image.png", "width", 1000)</code> |
: Saves a file called "image.png" of the current view with width = 1000 pixels | : Saves a file called "image.png" of the current view with width = 1000 pixels | ||
− | ;<code>ExportImage("filename", "image.png", "height", 1000)</code> | + | *;<code>ExportImage("filename", "image.png", "height", 1000)</code> |
: Saves a file called "image.png" of the current view with height = 1000 pixels | : Saves a file called "image.png" of the current view with height = 1000 pixels | ||
− | ;<code>ExportImage("filename", "image.png", "transparent", true)</code> | + | *;<code>ExportImage("filename", "image.png", "transparent", true)</code> |
: Saves a transparent PNG file called "image.png" | : Saves a transparent PNG file called "image.png" | ||
− | ;<code>ExportImage("filename", "image.svg", "type", "svg")</code> | + | *;<code>ExportImage("filename", "image.svg", "type", "svg")</code> |
− | : Saves a file called "image.svg" of the current view in SVG format | + | : Saves a file called "image.svg" of the current view in SVG format}} |
{{Notes|1= | {{Notes|1= | ||
− | * In GeoGebra Classic 5 if there is no <code>filename</code> parameter the image will be copied to the | + | * In GeoGebra Classic 5 if there is no <code>filename</code> parameter the image will be copied to the Clipboard. This may also be possible in the future (with browser support) in other versions.}} |
Revision as of 17:29, 2 February 2018
- ExportImage( <Property>, <Value>, <Property>, <Value>, ... )
- Exports an image of the currently active view (or the view specified by the "view" parameter)
Note:
- The Properties used in the command syntax, listed in the following examples, need to be entered in English.
- The values related to the View that will be saved as image are:
- 1 for Graphics View
- 2 for Graphics View 2
- -1 for 3D View
Examples:
ExportImage("scale", 5)
- Shows a popup of the current view so that the user can right-click -> Save Image As...
ExportImage("filename", "image.png")
- Saves a file called "image.png" of the current view
ExportImage("filename", "image.png", "view", 2)
- Saves a file called "image.png" of Graphics View 2
ExportImage("filename", "image.png", "view", -1)
- Saves a file called "image.png" of View 3D Graphics
ExportImage("filename", "image.png", "dpi", 300)
- Saves a file called "image.png" of the current view at 300 dpi (dots-per-inch)
ExportImage("filename", "image.png", "scale", 2)
- Saves a file called "image.png" of the current view at scale 2 (ie twice nominal screen resolution)
ExportImage("filename", "image.png", scalecm", 2, "dpi", 600)
- Saves a file called "image.png" of the current view at 600 dpi at a scale 1 unit = 2 cm
ExportImage("filename", "image.png", "width", 1000)
- Saves a file called "image.png" of the current view with width = 1000 pixels
ExportImage("filename", "image.png", "height", 1000)
- Saves a file called "image.png" of the current view with height = 1000 pixels
ExportImage("filename", "image.png", "transparent", true)
- Saves a transparent PNG file called "image.png"
ExportImage("filename", "image.svg", "type", "svg")
- Saves a file called "image.svg" of the current view in SVG format
Notes:
- In GeoGebra Classic 5 if there is no
filename
parameter the image will be copied to the Clipboard. This may also be possible in the future (with browser support) in other versions.