Previous Obsolete IDL Features: Obsolete Routines Next


This functionality is obsolete. It should not be used in new IDL code.

LIVE_STYLE

The LIVE_STYLE function allows the user to create a style.

Syntax

Style = LIVE_STYLE ({ 'contour' | 'image' | 'plot' | 'surface'} [, BASE_STYLE=style_name] [, COLORBAR_PROPERTIES=structure] [, ERROR=variable] [, GRAPHIC_PROPERTIES=structure] [, GROUP=widget_id] [, LEGEND_PROPERTIES=structure] [, NAME=string] [, /SAVE] [, TEMPLATE_FILE=filename] [, VISUALIZATION_PROPERTIES=structure] [, {X | Y | Z}AXIS_PROPERTIES=structure] )

Arguments

Type

A string (case-insensitive) specifying the visualization style type. Available types include: plot, contour, image, and surface.

Keywords

BASE_STYLE

Set this keyword equal to a string (case-insensitive) containing the name of a previously saved style. It will be used for defaulting unspecified properties. If not specified, only those properties you provide will be put into the style. The basic styles that will always exist include:

Table 2-26: Base Style Strings

Table 2-26: Base Style Strings
Visualization Type
Style Name
plot
`Basic Plot'
contour
`Basic Contour'
image
`Basic Image'
surface
`Basic Surface'

COLORBAR_PROPERTIES

The table below lists the structure of the COLORBAR_PROPERTIES keyword.

Table 2-27: Colorbar Properties Structure 

Table 2-27: Colorbar Properties Structure 
Tag
Description
title_FontSize
9 to 72 points
title_Fontname
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
title_Color
see color table
tick_FontSize
see fontsize
tick_Fontname
see fontname
tick_FontColor
see color table
color
see color table
thick
1 to 10 pixels
location
[x, y] normalized units
minor
number of minor ticks (minimum 0)
major
number of major ticks (minimum 0)
default_minor
set to compute default number of minor ticks
default_major
set to compute default number of major ticks
tickLen
normalized units * 100 = percent of visualization dimensions
subticklen
normalized units * 100 = percent of ticklen
tickFormat
see format
show_axis
set to display the colorbar axis
show_outline
set to display the colorbar outline
axis_thick
see thick
dimensions
[width, height] normalized units
hide
1=hidden, 0=visible

GRAPHIC_PROPERTIES

Set this keyword equal to a scalar or vector of structures defining the graphic properties to use in creating the style. (Use a vector if you want successive graphics to have different properties, e.g., different colored lines in a line plot. The structures are used in a round-robin fashion.) Not all properties need be specified (see BASE_STYLE). The complete structure definitions are listed in the following tables.

Plots

Table 2-28: Plot Graphic Properties Structure 

Table 2-28: Plot Graphic Properties Structure 
Tag
Data Type/Description
color
string (see color table)
hide
boolean (1=hidden, 0=visible)
linestyle
integer (0=solid, 1=dotted, 2=dashed, 3=dash dot, 4=dash dot dot, 5=long dash)
nSum
integer (1 to number of elements to average over)
symbol_size
[x,y] normalized units relative to the visualization
symbol_type
integer (1-7)
thick
integer (1 to 10 pixels)

 

Images

Table 2-29: Image Graphic Properties Structure

Table 2-29: Image Graphic Properties Structure
Tag
Data Type/Description
hide
boolean (1=hidden, 0=visible)
order
boolean (set to draw from top to bottom)
sizing_constraint
integer (0=natural, 1=aspect, 2=unrestricted)

 

Contours

Table 2-30: Contour Graphic Properties Structure 

Table 2-30: Contour Graphic Properties Structure 
Tag
Data Type/Description
downhill
boolean (set to display downhill tick marks)
fill
boolean (set to display contour levels as filled)
hide
boolean (1=hidden, 0=visible)
n_levels
integer (number of levels)
c_thick
vector of thickness values
c_linestyle
vector of linestyle values
c_color
vector of color names
default_n_levels
integer (set to default number of levels)

 

Surfaces

Table 2-31: Surface Graphic Properties Structure 

Table 2-31: Surface Graphic Properties Structure 
Tag
Data Type/Description
bottom
string (see color table)
color
string (see color table)
hidden_lines
boolean (1=don't show, 0=show)
hide
boolean (1=hidden, 0=visible)
lineStyle
integer (0=solid, 1=dotted, 2=dashed, 3=dash dot, 4=dash dot dot, 5=long dash)
shading
boolean (0=flat, 1=Gouraud)
show_skirt
boolean (1=show, 0=don't show)
skirt
float (z value at which skirt is drawn [data units])
style
integer (0=point, 1=wire, 2=solid, 3=ruledXZ, 4=ruledYZ, 5=lego (wire), 6=lego (solid) )
thick
integer (1 to 10 pixels)

 

GROUP

Set this keyword to the widget ID of the group leader for error message display. This keyword is used only when the ERROR keyword is not set. If only one LIVE tool window is present in the IDL session, it will default to that.

LEGEND_PROPERTIES

Set this keyword equal to a structure defining the legend properties to use in creating the style. Not all properties need be specified (see BASE_STYLE). The complete structure definitions for different types of styles are listed in the following tables.

Table 2-32: Legend Properties Structure 

Table 2-32: Legend Properties Structure 
Tag
Description
title_FontSize
9 to 72 points
title_Fontname
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
title_Color
see color table
item_fontSize
see fontsize
item_fontName
see fontname
text_color
see color
border_gap
normalized units * 100 = percent of item text height
columns
number of columns to display the items in (minimum 0)
gap
normalized units * 100 = percent of item text height
glyph_Width
normalized units * 100 = percent of item text height
fill_color
see color table
outline_color
see color table
outline_thick
see thick
location
[x, y] normalized units
show_fill
set to display the fill color
show_outline
set to display the legend outline
hide
1=hidden, 0=visible

 

NAME

Set this keyword to a string containing a name for the returned style. If the SAVE keyword is set, the name must be unique template file. If not specified, a name will be automatically generated.

SAVE

Set this keyword to save the style in the template file. The supplied Name must not already exist in the template file or an error will be returned.

VISUALIZATION_PROPERTIES

Set this keyword equal to a structure defining the visualization properties to use in creating the style. Not all properties need be specified (see BASE_STYLE). The complete structure definition is in the following table.

Table 2-33: Visualization Properties Structure

Table 2-33: Visualization Properties Structure
Tag
Data Type
color
string (see color table) for background
hide
boolean
transparent
boolean

XAXIS_PROPERTIES, YAXIS_PROPERTIES, ZAXIS_PROPERTIES

Set these keywords equal to a scalar or vector of structures defining the axis properties to use in creating the style. (Use a vector to specify property structures for successive axes of the same direction have different properties. The structures are used in a round-robin fashion.) Not all properties need be specified (see BASE_STYLE). The user need only define the fields of the structure they wish to be different from the BASE style. The complete structure definition is shown in the following table.

Table 2-34: Axis Properties Structure 

Table 2-34: Axis Properties Structure 
Tag
Data Type
color
string (see color table)
default_major
integer
default_minor
integer
exact
boolean
gridstyle
integer (0-5) (linestyle)
hide
boolean
location
3-element floating vector (normalized units)
major
integer (default=-1, computed by IDL)
minor
integer (default=-1, computed by IDL)
thick
integer (1-10)
tickDir
integer
tickLen
float (normalized units)
tick_fontname
string
tick_fontsize
integer

Examples

Style=LIVE_STYLE('plot',BASE_STYLE='basic plot', $  
   GRAPHIC_PROPERTIES={color:'red'})  

Version History

Introduced: 5.1

See Also

LIVE_INFO, LIVE_CONTROL

  IDL Online Help (March 06, 2007)