/usr/share/gnudatalanguage/coyote/cglegend.pro is in gdl-coyote 2016.11.13-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | ; docformat = 'rst'
;
; NAME:
; cgLegend
;
; PURPOSE:
; The purpose of this program is to a create simple legend that can be drawn in a
; graphics window.
;
;******************************************************************************************;
; ;
; Copyright (c) 2013, by Fanning Software Consulting, Inc. All rights reserved. ;
; ;
; Redistribution and use in source and binary forms, with or without ;
; modification, are permitted provided that the following conditions are met: ;
; ;
; * Redistributions of source code must retain the above copyright ;
; notice, this list of conditions and the following disclaimer. ;
; * Redistributions in binary form must reproduce the above copyright ;
; notice, this list of conditions and the following disclaimer in the ;
; documentation and/or other materials provided with the distribution. ;
; * Neither the name of Fanning Software Consulting, Inc. nor the names of its ;
; contributors may be used to endorse or promote products derived from this ;
; software without specific prior written permission. ;
; ;
; THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY ;
; EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES ;
; OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT ;
; SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, ;
; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ;
; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; ;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ;
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ;
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ;
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;
;******************************************************************************************;
;+
; The purpose of this program is to a create simple legend that can be drawn in a
; graphics window. Users needing more complex legends may prefer to use AL_Legend from
; the NASA Astronomy IDL Library. This program has a more limited set of functionality,
; especially in regard to placement options. This program is a wrapper for the
; cgLegendItem object.
;
; :Categories:
; Graphics
;
; :Examples:
; A plot with a simple legend::
; cgDisplay, 800, 450
; cgPlot, cgDemoData(17), PSym=-6, SymColor='red7', Position=[0.15, 0.15, 0.7, 0.9]
; cgOPlot, cgDemoData(17), PSym=-15, SymColor='blu7'
; cgLegend, SymColors=['red7', 'blu7'], PSyms=[6,15], Symsize=1.5, Location=[0.725, 0.9], $
; Titles=['May 27', 'June 27'], Length=0.075, /Box, VSpace=2.75, /Background, BG_Color='rose'
;
; Same as the previous example, but in a resizeable graphics window::
; cgWindow, WXSize=800, WYSize=450
; cgPlot, cgDemoData(17), PSym=-6, SymColor='red7', Position=[0.15, 0.15, 0.7, 0.9], /AddCmd
; cgOPlot, cgDemoData(17), PSym=-15, SymColor='blu7', /AddCmd
; cgLegend, SymColors=['red7', 'blu7'], PSyms=[6,15], Symsize=1.5, Location=[0.725, 0.9], $
; Titles=['May 27', 'June 27'], Length=0.075, /Box, VSpace=2.75, /Background, $
; BG_Color='rose', /AddCmd
;
; :Keywords:
; addcmd: in, optional, type=boolean,default=0
; If this keyword is set, the object is added to the resizeable graphics
; window, cgWindow. The DRAW method of the object is called in cgWindow.
; alignment: in, optional, type=integer, default=0
; This keyword affects the alignment of the legend box with respect to the `Location` point.
; There are nine possible values (0 to 8) that assign the location point to be one of the
; four corners of the legend box, or the middle of one of the four sides of the legend box.
; The values are specified as follows::
; 0 - Location specifies the upper left corner of the legend box.
; 1 - Location specifies the upper right corner of the legend box.
; 2 - Location specifies the lower right corner of the legend box.
; 3 - Location specifies the lower left corner of the legend box.
; 4 - Location specifies the top side of the legend box (centered horizontally).
; 5 - Location specifies the bottom side of the legend box (centered horizontally).
; 6 - Location specifies the left side of the legend box (centered vertically).
; 7 - Location specifies the right side of the legend box (centered vertically).
; 8 - Location specified the very center of the legend box.
; background: out, optional, type=boolean, default=0
; Set this keyword to draw a colored background for the legend.
; bg_color: out, optional, type=string, default="white"
; The name of the background color.
; box: in, optional, type=boolean, default=0
; Set this keyword to draw a box around the legend items.
; bx_color: in, optional, type=varies, default="black"
; The color of the box drawn around the legend items.
; bx_thick: in, optional, type=float
; The thickness of the line used to draw the box around the legend items.
; If not set, use !P.Thick at drawing time.
; center_sym: in, optional, type=boolean
; Set this keyword to place a single symbol in the center of the line. The default
; is to draw a symbol at each endpoint of the line.
; charsize: in, optional, type=float
; The character size for the legend text. Uses cgDefCharsize by default.
; Ignored if using hardware fonts on the display.
; charthick: in, optional, type=float
; The thickness of the legend text. If undefined, use `Thick` value.
; colors: in, optional, type=varies, default="black"
; The name of the data color. This is the color of each data line. May be an array.
; data: in, optional, type=boolean, default=0
; If set the values specified by the `Location` keyword are taken to be in data
; coordinate space.
; hardware: in, optional, type=boolean
; Set this keyword if you want to output the legend text in a hardware font.
; length: in, optional, type=float, default=0.075
; The length of the line connecting symbols in the legend, in normalized
; coordinates (0 to 1 in the graphics window). Set this equal to 0.0 if
; you wish to only plot symbols in the legend.
; linestyles: in, optional, type=integer
; The line style for drawing each line. May be an array.
; location: in, optional, type=fltarr
; A two-element vector giving the X and Y location of upper-left corner of the legend
; (or legend box, if the `Box` keyword is set) in normalized coordinates. If the `Data`
; keyword is set, the locations are taken to be in data coordinate space.
; psyms: in, optional, type=integer
; Any normal IDL PSYM values, plus any value supported by the Coyote Library
; routine cgSYMCAT. An integer between 0 and 46. May be an array.
; symcolors: in, optional, type=varies
; The name of the symbol color. By default, the same as the `COLOR` keyword. May be an array.
; symsize: in, optional, type=float, default=1.0
; The symbol size.
; symthick: in, optional, type=float
; The thickness of the symbol. If not set, use !P.Thick at drawing time.
; tcolors: in, optional, type=varies, default="black"
; The `Title` color. May be an array.
; thick: in, optional, type=float
; The thickness of the line. If not set, use !P.Thick at drawing time.
; titles: in, optional, type=string/strarr, default='Plot Item'
; The "title" or text for each legend item.
; tt_font: in, optional, type=string
; The name of a true-type font to use for the legend text.
; visible: in, optional, type=boolean, default=1
; Set this keyword to determine if the legend should be drawn (visible=1), or
; if the legend should not be drawn (visible=0).
; vspace: in, optional, type=float, default=1.5
; A scale factor for vertical spacing between legend items. This number is multiplied by
; `Charsize` to determine vertical spacing.
; window: in, optional, type=boolean, default=0
; If this keyword is set, the object replaces any commands in a current
; cgWindow or it opens a new cgWindow and adds itself to it.
;
; :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) 2013, Fanning Software Consulting, Inc.
;
; :History:
; Change History::
; Written 5 Dec 2013. David W Fanning.
; Added CharThick keyword. 1 Sept 2014. DWF.
;-
PRO cgLegend, $
ADDCMD=addcmd, $
ALIGNMENT=alignment, $
BACKGROUND=background, $
BG_COLOR=bg_color, $
BOX=box, $
BX_COLOR=bx_color, $
BX_THICK=bx_thick, $
CENTER_SYM=center_sym, $
CHARSIZE=charsize, $
CHARTHICK=charthick, $
COLORS=colors, $
DATA=data, $
HARDWARE=hardware, $
LENGTH=length, $
LINESTYLES=linestyles, $
LOCATION=location, $
PSYMS=psyms, $
SYMCOLORS=symcolors, $
SYMSIZE=symsize, $
SYMTHICK=symthick, $
TCOLORS=tcolors, $
THICK=thick, $
TITLES=titles, $
TT_FONT=tt_font, $
VISIBLE=visible, $
VSPACE=vspace, $
WINDOW=window
Compile_Opt idl2
Catch, theError
IF theError NE 0 THEN BEGIN
Catch, /Cancel
void = cgErrorMsg()
RETURN
ENDIF
; Create a cgLegendItem object.
object = Obj_New('cgLegendItem', $
ADDCMD=addcmd, $
ALIGNMENT=alignment, $
BACKGROUND=background, $
BG_COLOR=bg_color, $
BOX=box, $
BX_COLOR=bx_color, $
BX_THICK=bx_thick, $
CENTER_SYM=center_sym, $
CHARSIZE=charsize, $
CHARTHICK=charthick, $
COLORS=colors, $
DATA=data, $
DRAW=1, $
HARDWARE=hardware, $
LENGTH=length, $
LINESTYLES=linestyles, $
LOCATION=location, $
PSYMS=psyms, $
SYMCOLORS=symcolors, $
SYMSIZE=symsize, $
SYMTHICK=symthick, $
TCOLORS=tcolors, $
THICK=thick, $
TITLES=titles, $
TT_FONT=tt_font, $
VISIBLE=visible, $
VSPACE=vspace, $
WINDOW=window)
; If you haven't added this to a cgWindow, destroy the object.
IF ~Keyword_Set(addcmd) && ~Keyword_Set(window) THEN Obj_Destroy, object
END
|