IDLitTool::GetThumbnail

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitTool::GetThumbnail method retrieves a thumbnail image of the current iTool.

Syntax

Result = Obj->[IDLitTool::]GetThumbnail( [, THUMBBACKGROUND=variable] [, /THUMBORDER] [, THUMBSIZE=variable] )

Return Value

Returns a True Color (3xmxm) image.

Arguments

None

Keywords

THUMBBACKGROUND

Set this keyword to specify the color of the background to use in the thumbnail. This keyword has an effect only if the aspect ratio of the tool window is not equal to 1. If set to a scalar value, the color of the lower left pixel of the tool window is used as the background color. If set to an RGB triplet, the supplied color will be used. If a value is not specified, a default value of [255,255,255] (white) is used.

THUMBORDER

Set this keyword to return the thumbnail in top-to-bottom order rather than the IDL default of bottom-to-top order.

THUMBSIZE

Set this keyword to the size of the thumbnail to return. A thumbnail is always returned as a square image. If a value is not supplied, a default value of 32 is used. THUMBSIZE must be greater than 3 and must shrink the tool window.

Version History