imported>RexxS: document getScale function

2019-03-31T21:59:56Z

document getScale function

New page

This module is adapted from the 'getdimensions' function in [[Module:Multiple image]] for use as a stand-alone.

It has four public functions: getWidth, getHeight, getDimensions, getScale. They take a filename, with or without the "File:" prefix, and return the width, the height, both dimensions (WIDTHxHEIGHT), or the ratio of width to height (multiplied by a scale factor) respectively. It works with files on Commons or local ones, and works with animated gifs using the dimensions of the first image.

The getScale function takes an additional parameter, {{para|scale}} (default is 1). This can be used to directly scale images to the same height using the {{para|upright}} parameter in image syntax.

== Examples ==

* <code><nowiki>{{#invoke:Sandbox/Imagesize|getDimensions|Example.jpg}}</nowiki></code> → {{#invoke:Sandbox/Imagesize|getDimensions|Example.jpg}}
* <code><nowiki>{{#invoke:Sandbox/Imagesize|getWidth|Example.jpg}}</nowiki></code> → {{#invoke:Sandbox/Imagesize|getWidth|Example.jpg}}
* <code><nowiki>{{#invoke:Sandbox/Imagesize|getHeight|Example.jpg}}</nowiki></code> → {{#invoke:Sandbox/Imagesize|getHeight|Example.jpg}}
* <code><nowiki>{{#invoke:Sandbox/Imagesize|getScale|Example.jpg|scale=1}}</nowiki></code> → {{#invoke:Sandbox/Imagesize|getScale|Example.jpg|scale=1}}
* <code><nowiki>{{#invoke:Sandbox/Imagesize|getDimensions|File:Bishzilla Lucia Looking Right.gif}}</nowiki></code> → {{#invoke:Sandbox/Imagesize|getDimensions|File:Bishzilla Lucia Looking Right.gif}}
* <code><nowiki>{{#invoke:Sandbox/Imagesize|getDimensions|File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg}}</nowiki></code> → {{#invoke:Sandbox/Imagesize|getDimensions|File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg}}
* <code><nowiki>{{#invoke:Sandbox/Imagesize|getScale|File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg|scale=1}}</nowiki></code> → {{#invoke:Sandbox/Imagesize|getScale|File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg|scale=1}}

{| class="wikitable"
|-
! colspan="2" | Same height, scale=1
|-
| [[File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg|thumb|upright={{#invoke:Sandbox/Imagesize|getScale|File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg|scale=1}}]]
| [[File:Example.jpg|thumb|upright={{#invoke:Sandbox/Imagesize|getScale|Example.jpg|scale=1}}]]
|-
! colspan="2" | Same height, scale=0.5
|-
| [[File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg|thumb|upright={{#invoke:Sandbox/Imagesize|getScale|File:Doorway from Moutiers-Saint-Jean MET DP255158.jpg|scale=0.5}}]]
| [[File:Example.jpg|thumb|upright={{#invoke:Sandbox/Imagesize|getScale|Example.jpg|scale=0.5}}]]
|}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |


}}</includeonly>

Module:Sandbox/Imagesize/doc - Revision history

imported>RexxS: document getScale function