Difference between revisions of "SciFigs: Legend"

From GeopsyWiki
Jump to navigation Jump to search
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Image:SciFigs_legend_graphic.png|thumb|right|200px|A legend]]
 
[[Image:SciFigs_legend_graphic.png|thumb|right|200px|A legend]]
  
−
A legend is a graphical object that can be inserted in a [[SciFigs: Graphic sheet|graphic sheet]]. A legend is a description of various line, symbol and text attributes used for plotting curves on a [[SciFigs: XY Plot|XY plot]] containing [[SciFigs: Line layer|line layers]].
+
A legend is a graphical object that can be inserted in a [[SciFigs: Graphic sheet|graphic sheet]]. A legend is a description of various line, symbol and text attributes used for plotting curves on a [[SciFigs: Graph|Graph]] containing line [[SciFigs: Layer|layers]].
  
−
== Creating a new legend ==
 
  
−
In a [[SciFigs: Graphic sheet|graphic sheet]] such as [[SciFigs: Figue|figue]], select menu ''Insert/Legend''. Alternatively, use the toolbar icon for legend [[Image:Legend_icon.png|20px]] or right-click on a blank part of the graphic sheet and access all menu items through the context menu (useful for Mac users who have no top menu bar when the graphic sheet is embedded in a larger application, e.g. inside geopsy). Open this [[Media:Legend_page.page|page file]] in figue to plot the same legend as in figure.
+
= '''Create a legend''' =
  
−
== Editing and Exporting/Importing a legend ==
+
In a [[SciFigs: Graphic sheet|graphic sheet]] such as [[SciFigs: Figue|figue]], select the menu '''Insert/Legend'''. Alternatively, use the legend toolbar icon [[Image:Legend_icon.png|30px]] or right-click on a blank part of the graphic sheet and access '''Insert/Legend''' through the context menu (useful for Mac users who have no top menu bar when the graphic sheet is embedded in a larger application, e.g. inside geopsy).  
−
[[Image:SciFigs_legend_menu.png|thumb|right|500px|Editing the properties of a legend]]
 
−
===Legend Box===
 
−
By double clicking on the graph of the legend you get the properties window of the legend box.
 
−
By selecting the Legend Tab and through the Legend Graph-Box the user can than specify the properties of [[#Pen| Pen]], [[#Symbol | Symbol]], [[#Symbol pen |Symbol pen]], [[#Symbol brush| Symbol brush]], and the [[#Text| Text]] to describe different lines.
 
−
The user has the ability to Import, '''Load'',' or Export, '''Save''', the Legend information from or into a file. This is very useful when one is using command line tools and he wants directly to use a Legend file (.legend).  
 
  
−
Additionally one can decide to use colors as these is a result of an '''Interpole''' [[Image:SciFigs_legend_Interpole.png|100px]] between two colors from the list of colors already used. Also an automatic way to directly use color [[Image:SciFigs_legend_Interpole_color.png|100px]] or  [[Image:SciFigs_legend_Interpole_gray.png|100px]]  gray scale by pressing the [[Image:SciFigs_legend_Interpole_color_button.png|50px]] or the [[Image:SciFigs_legend_Interpole_gray_button.png|50px]] Button in '''Colors''' frame. Finally the user has the possibility to use different colors for the Pen, Symbol Pen, Symbol Brush and Text for the same curve. In order to do that one should un-check the box ''One color''  below the '''Colors''' frame. The user can increase or decrease the number of entries in the Legend Graph when he is using the Legend from the [[SciFigs: Graphic sheet|graphic sheet]] in  [[SciFigs: Figue|figue]] if he adds a legend box. In any other case it is not possible to change the number of entries.
 
  
 +
A small box with '''Title''' inside appears in the Graphic Sheet.
 +
[[Image:SciFigs_LegendBox.png|thumb|right|200px|Empty legend]]
 +
 +
<br style="clear:both"/>
 +
 +
Double click on this box to open the properties window and select the '''Legend''' Tab.
 +
[[Image:SciFigs_legend_menu.png|thumb|right|450px|Legend property window]]
 +
<br style="clear: both"/>
 +
 +
[[Image:SciFigs_Legend_NumberOfEntries.png|thumb|right|300px|Number of entries in the legend]]
 +
Enter the number of entries of the legend.
 +
<br style="clear: both"/>
 +
 +
A legend is created with the default entries.
 +
[[Image:SciFigs_Legend_DefaultLegend.png|thumb|right|300px|Default legend]]
 +
<br style="clear: both"/>
 +
 +
The Property window now presents the default entries, ready to be edited.
 +
[[Image:SciFigs_legend_NewLegend.png|thumb|right|450px|Legend property window with the default entries to be edited and customized]]
 +
 +
<br style="clear: both"/>
 +
 +
= '''Edit a legend''' =
 +
 +
The Legend property window used to edit a legend includes two sections:
 +
* a Legend box
 +
* a Format box
 +
 +
<br style="clear:both"/>
 +
 +
==Legend box==
 +
[[Image:SciFigs_Legend_Box.png|thumb|right|450px|Legend box]]
 +
The Legend box is used to customize five items for each entry:
 +
*Pen (Absent in map legend)
 +
*Symbol
 +
*Symbol pen
 +
*Symbol brush
 +
*Text
 +
 +
 +
 +
 +
These five items are described by the following characteristics:
 +
 +
*'''Color''': five ways are available to select colors
 +
[[Image:SciFigs_Legend_SelectColor1.png|100px|Default Select Color]]
 +
[[Image:SciFigs_Legend_SelectColor2.png|100px|Select Color]]
 +
[[Image:SciFigs_Legend_SelectColor3.png|100px|Select Color]]
 +
[[Image:SciFigs_Legend_SelectColor4.png|100px|Select Color]]
 +
[[Image:SciFigs_Legend_SelectColor5.png|100px|Select Color]]
 +
 +
<br style="clear: both"/>
 +
 +
There are several combinations to [[SciFigs: _Legend_Customize_Colors|'''customize colors''']]
 +
 +
 +
*'''Width'''
 +
[[Image:Legend_menu-width.png|thumb|left|100px]]
 
<br style="clear: both"/>
 
<br style="clear: both"/>
−
==== Pen ====
 
−
[[Image:SciFigs_Legend_SelectColor.png|thumb|left|300px|Select Color]]
 
−
You can select the Pen '''Color''' (shown on the left side figure), the '''Width''' [[Image:Legend_menu-width_line.png|40px]] and the '''Style''' [[Image:Legend_menu-select_line.png|20px]], as Continous, Dashed or Dotted line. Especially for the Color Selection the user can  select one of the Basic colors already defined or create his own color and add it to the Custom Colors by either pressing the appropriate button [[Image:Legend_AddCustomColors.png|150px]] or drag & drop it to the list of Custom Colors.
 
  
 +
 +
*'''Style''': two types of style are available
 +
For '''Pen''' and '''Symbol pen''': style defines a style of line
 +
[[Image:Legend_menu-style1a.png|thumb|left|100px]]
 +
[[Image:Legend_menu-style1b.png|60px]]
 
<br style="clear: both"/>
 
<br style="clear: both"/>
  
−
==== Symbol ====
+
For '''Symbol brush''': style defines a style of filling
 +
[[Image:Legend_menu-style2a.png|thumb|left|100px]]
 +
[[Image:Legend_menu-style2b.png|40px]]
 +
<br style="clear: both"/>
  
−
The user can define here the Type of Symbol [[Image: SymbolType.png | 30px]] that could be an x, a rectangular, a circle, a triangle, a diamond or a star. Additionally one can specify and the Size of the Symbol.
 
  
−
==== Symbol pen ====
+
*'''Type''': to choose between six symbol types, or no symbol (blank square)
 +
[[Image:Legend_menu-type1.png|thumb|left|100px]]
 +
[[Image:Legend_menu-type2.png|60px]]
 +
<br style="clear: both"/>
  
−
The user can define here the parameters for the pen that creates the [[#Symbol| Symbol]] to be used, as the ''Color'', the ''Width'' and the ''Style''.
+
<br style="clear: both"/>
  
−
==== Symbol brush ====
 
  
−
The user can define the ''Color'' and the ''Style''  [[Image: SymbolBrushStyle.png| 30px]] to be used.
+
*'''Size'''
 +
[[Image:Legend_menu-size.png|thumb|left|100px]]
 +
<br style="clear: both"/>
  
−
==== Text ====
 
  
−
The user can define the Text to be used at the legend box describing each curve. It is also possible to define the color of the text.
+
*'''Text'''
 +
Define the Text to be used in the legend box to describe each entry. It is also possible to define the color of the text.
  
−
=== Format Box ===
 
−
[[Image:SciFigs_legend_FormatBox.png|thumb|left|400px|Formating the Text of a legend]]
 
−
The user can set the Text of the Legend Title, setup auto-resizing of the Box based on the size of the text and define the font as you wish by pressing '''Change''' [[Image:SciFigs_Select_Font.png|right|150px]]. FInally one can define the '''Line size''' of each curve, but in that case enable Auto-resize to text as well so that the information you have in the Box might not be presented correctly.
 
 
<br style="clear: both"/>
 
<br style="clear: both"/>
  
−
== Legend file format ==
+
== Format Box ==
 +
 
 +
[[Image:SciFigs_legend_FormatBox.png|thumb|right|300px|Legend format box]]
 +
This box is used to set:
 +
*the legend title
 +
*automatically resize the legend object to the text length
 +
*the font of the legend
 +
*the line size in the legend
 +
<br style="clear: both"/>
 +
 
 +
 
 +
= '''Example''' =
 +
Example of a Legend tab attributes and the resulting Legend object.
 +
[[Image:Legend_tab_example.png|thumb|right|500px|Legend tab example]]
 +
<br style="clear: both"/>
 +
[[Image:Legend_example.png|thumb|right|300px|Legend example]]
 +
<br style="clear: both"/>
 +
 
 +
[[Image:Legend_example1.png|thumb|right|300px|Legend example]]
 +
A black text instead of a colored one is obtained by first unchecking the [[Image:SciFigs_legend_OneColorBox1.png|150px]] box, and changing '''Color''' accordingly in the '''Text''' column.
 +
<br style="clear: both"/>
 +
 
 +
 
 +
 
 +
= '''Export or import a legend''' =
 +
 
 +
It is possible to export a legend attributes, for later use, through the [[Image:SciFigs_legend_SaveButton.png|100px]] button.
 +
A '''.legend''' will be created, which is in [[Xml files|XML]] format.
 +
 
 +
Attributes of a saved '''.legend''' file can be imported through the  [[Image:SciFigs_legend_LoadButton.png|100px]] button.
  
−
As described above it is possible to '''Load''' or '''Save''' the legend information in a file for later use.  The file is in [[Xml files|XML]] format.
+
To get the same legend as in the example, first download the [[Media: Legend_page_new|'''Legend example.legend''']] file and then load it into the active Graph Sheet.

Latest revision as of 11:37, 25 February 2013

A legend

A legend is a graphical object that can be inserted in a graphic sheet. A legend is a description of various line, symbol and text attributes used for plotting curves on a Graph containing line layers.


Create a legend

In a graphic sheet such as figue, select the menu Insert/Legend. Alternatively, use the legend toolbar icon Legend icon.png or right-click on a blank part of the graphic sheet and access Insert/Legend through the context menu (useful for Mac users who have no top menu bar when the graphic sheet is embedded in a larger application, e.g. inside geopsy).


A small box with Title inside appears in the Graphic Sheet.

Empty legend


Double click on this box to open the properties window and select the Legend Tab.

Legend property window


Number of entries in the legend

Enter the number of entries of the legend.

A legend is created with the default entries.

Default legend


The Property window now presents the default entries, ready to be edited.

Legend property window with the default entries to be edited and customized


Edit a legend

The Legend property window used to edit a legend includes two sections:

  • a Legend box
  • a Format box


Legend box

Legend box

The Legend box is used to customize five items for each entry:

  • Pen (Absent in map legend)
  • Symbol
  • Symbol pen
  • Symbol brush
  • Text



These five items are described by the following characteristics:

  • Color: five ways are available to select colors

Default Select Color Select Color Select Color Select Color Select Color


There are several combinations to customize colors


  • Width
Legend menu-width.png



  • Style: two types of style are available

For Pen and Symbol pen: style defines a style of line

Legend menu-style1a.png

Legend menu-style1b.png

For Symbol brush: style defines a style of filling

Legend menu-style2a.png

Legend menu-style2b.png


  • Type: to choose between six symbol types, or no symbol (blank square)
Legend menu-type1.png

Legend menu-type2.png



  • Size
Legend menu-size.png



  • Text

Define the Text to be used in the legend box to describe each entry. It is also possible to define the color of the text.


Format Box

Legend format box

This box is used to set:

  • the legend title
  • automatically resize the legend object to the text length
  • the font of the legend
  • the line size in the legend



Example

Example of a Legend tab attributes and the resulting Legend object.

Legend tab example


Legend example


Legend example

A black text instead of a colored one is obtained by first unchecking the SciFigs legend OneColorBox1.png box, and changing Color accordingly in the Text column.


Export or import a legend

It is possible to export a legend attributes, for later use, through the SciFigs legend SaveButton.png button. A .legend will be created, which is in XML format.

Attributes of a saved .legend file can be imported through the SciFigs legend LoadButton.png button.

To get the same legend as in the example, first download the Legend example.legend file and then load it into the active Graph Sheet.

Retrieved from "https://www.geopsy.org/wiki/index.php?title=SciFigs:_Legend&oldid=3558"