Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

single page | use frames     summary     class     fields     routine details     file attributes

.\

cgwindow_getdefs.pro


top cgWindow_GetDefs

Graphics

cgWindow_GetDefs [, /AdjustSize] [, Aspect=float] [, Background=string] [, Delay=float] [, /EraseIt] [, Multi=Intarr(5)] [, XOMargin=intarr(2)] [, YOMargin=intarr(2)] [, XSize=integer] [, YSize=integer] [, /Title] [, XPos=integer] [, YPos=integer] [, Palette=byte] [, IM_Density=integer] [, /IM_PNG8] [, IM_Options=string] [, /IM_Raster] [, IM_Resize=integer] [, IM_TIFF_Depth=integer] [, /IM_Transparent] [, IM_Width=integer] [, PDF_Unix_Convert_Cmd=string] [, PDF_Path=string] [, PS_CHARSIZE=float] [, /PS_Decomposed] [, /PS_Delete] [, /PS_Metric] [, /PS_Encapsulated] [, PS_FONT=integer] [, /PS_QUIET] [, PS_SCALE_FACTOR=float] [, PS_TT_FONT=string]

Allows the user to get the global defaults for resizeable cgWindow programs.

Keywords

AdjustSize out optional type=boolean

If set, adjust the default text size to match the display window size.

Aspect out optional type=float

The aspect ratio of the window.

Background out optional type=string

The background color of the window.

Delay out optional type=float

The amount of delay between command execution.

EraseIt out optional type=boolean

The Erase status of the window.

Multi out optional type=Intarr(5)

The !P.MULTI setting for the window.

XOMargin out optional type=intarr(2)

The !X.OMargin value for multiplots.

YOMargin out optional type=intarr(2)

The !Y.OMargin value for multiplots.

XSize out optional type=integer

The starting X size of the window.

YSize out optional type=integer

The starting Y size of the window.

Title out optional type=boolean

The window title.

XPos out optional type=integer

The X offset of the window from the upper-left corner of the display.

YPos out optional type=integer

The Y offset of the window from the upper-left corner of the display.

Palette out optional type=byte

The window color palette.

IM_Density out optional type=integer

The sampling density.

IM_PNG8 out optional type=boolean

If set, ImageMagick will create 8-bit PNG files, rather than 24-bit.

IM_Options out optional type=string

Current ImageMagick convert options.

IM_Raster out optional type=boolean

The raster via ImageMagick setting.

IM_Resize out optional type=integer

The amount PostScript output is resized.

IM_TIFF_Depth out optional type=integer

The number of bits per channel in TIFF files converted with ImageMagick.

IM_Transparent out optional type=boolean

The transparent background setting.

IM_Width out optional type=integer

The final width of ImageMagick raster file output.

PDF_Unix_Convert_Cmd out optional type=string

The name of an alternative UNIX command to convert PostScript to PDF.

PDF_Path out optional type=string

The name of the path to the Ghostscript command for converting PS to PDF.

PS_CHARSIZE out optional type=float default=0.0

The PostScript character size.

PS_Decomposed out optional type=boolean

The PostScript decomposed status of the window.

PS_Delete out optional type=boolean

The delete PostScript file status of the window.

PS_Metric out optional type=boolean

The metric status of the window.

PS_Encapsulated out optional type=boolean

The PostScript encapsulated status of the window.

PS_FONT out optional type=integer

The font being using for PostScript output.

PS_QUIET out optional type=boolean

Set to one of the QUIET keyword is set on cgPS_Config.

PS_SCALE_FACTOR out optional type=float

The PostScript scale factor.

PS_TT_FONT out optional type=string

The name of the PostScript true-type font in current use.

Examples

Used to get cgWindow global properties:

IDL> cgWindow_GetDefs, PALETTE=palette, PS_ENCAPSULATED=encap, PS_METRIC=metric

Author information

Author:

FANNING SOFTWARE CONSULTING:

David W. Fanning 1645 Sheely Drive Fort Collins, CO 80526 USA Phone: 970-221-0438 E-mail: david@idlcoyote.com Coyote's Guide to IDL Programming: http://www.idlcoyote.com

Copyright:

Copyright (c) 2011-2012, Fanning Software Consulting, Inc.

History:

Change History:

Written, 29 January 2011. DWF. Added PS_QUIET keyword. 17 Feb 2011. DWF. Added Raster_IM. 18 Feb 2011. Jeremy Bailin Added the ability to set and unset adjustable text size in cgWindow with ADJUSTSIZE keyword. 24 April 2011. DWF. Added PS_DECOMPOSED keyword to allow getting/setting of PostScript decomposed value. 30 Aug 2011. DWF. Added ASPECT keyword to allow getting/setting of window aspect ratio. 18 Nov 2011. DWF. Added PDF_UNIX_CONVERT_CMD and PDF_PATH keywords. 7 Dec 2011. DWF. Added IM_WIDTH keyword. 3 April 2012. DWF. Added IM_PNG8 keyword. 3 April 2012. DWF. Added IM_TIFF_DEPTH keyowrd. 14 May 2013. DWF.

File attributes

Modification date: Fri Mar 27 11:07:37 2015
Lines: 229
Docformat: rst rst