Template:Spatial image viewer

Template documentation[view] [edit] [history] [purge]

This is a template for to display multiple angles of the same object. The user is presented with arrows to allow them to shift the view to a different angle. This gives a pseudo-3D view of the object.

The user must have javascript and the calculator gadget enabled to see the viewer. If they do not, they will only see the first image (or the fallback image if one is specified).

Usage

You provide an images parameter which is a matrix of images. Each image is separated by a space (if the file name has a space in it, use an underscore). Separate each row with a newline.

For example:

{{Spatial image viewer
|images=
Anubis_Mask_from_Harrogate_-_left_three_quarter_profile_-_HARGM10686_02.jpg
Anubis_Mask_from_Harrogate_-_front_view_-_HARGM10686.jpg
Anubis_Mask_from_Harrogate_-_right_three_quarter_profile_-_HARGM10686.jpg
Anubis_Mask_from_Harrogate_-_right_profile_-_HARGM10686.jpg
Anubis_Mask_from_Harrogate_-_rear_right_view_-_HARGM10686.JPG
Anubis_Mask_from_Harrogate_-_rear_view_-_HARGM10686_03.jpg
Anubis_Mask_from_Harrogate_-_rear_left_view_-_HARGM10686_06.jpg
Anubis_Mask_from_Harrogate_-_left_profile_-_HARGM10686_10.jpg
|fallbackImage=Anubis Mask from Harrogate - rotating animation - HARGM10686.gif
|caption=[[Anubis]] mask made from [[cartonnage]]
}}

makes

Anubis mask made from cartonnage

If JS & calculator gadget is enabled, the user sees a mask image that they can rotate by clicking on left and right arrows. If javascript is not enabled they see the fallback image which is an animated GIF of the mask from different angles. Users viewing from the Wikipedia App will see the no-js version but users viewing from the mobile site see the normal version.

If you have multiple rows of images, then you will have both up/down arrows as well as side to side.

It can also be used as a tile viewer:

View of the Château de Fontainebleau

Template data

Create a spatial image viewer to view images taken from multiple angles of the same object.

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
uptext	`uptext`	Text for up arrow	Unknown	optional
downtext	`downtext`	Text to use instead of down arrow	Unknown	optional
lefttext	`lefttext`	Text to use instead of left arrow	Unknown	optional
righttext	`righttext`	Text to use instead of right arrow	Unknown	optional
width	`width`	Size of image. Do not include px unit Default 250	Number	suggested
wrapVertical	`wrapVertical`	Set to "false" to prevent wrapping around the last image to the first in the vertical direction Suggested values `false` `true` Default true	Unknown	optional
wrapHorizontal	`wrapHorizontal`	Set to "false" to prevent wrapping around the last image to the first in the vertical direction Suggested values `false` `true` Default true	Unknown	optional
height	`height`	height of image. If unspecified will default to width times aspect ratio of first image specified.	Number	optional
background	`background`	Background colour Default white	String	optional
images	`images`	Matrix of image names (No File: prefix). Put each image on its own line. Separate multiple rows with a line containing just '----'. Each row must have the same number of images	String	required
float	`float`	Float the image to left or right of page Suggested values `left` `right` `none`	String	optional
startX	`startX`	Which image to start on in the horizontal direction (zero-indexed) Default 0	Number	optional
startY	`startY`	Which image to start on in the vertical direction (zero-indexed) Default 0	Number	optional

The above documentation is transcluded from Template:Spatial image viewer/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.