Vectors

Description :
This module enables a representation to be displayed of a vector flow matrix applied to the centroid of each entity. Each vector has the same thickness, but its length is proportional to the values. It represents the flow of information between two entities.

Parameters :

Calculation of proportions

Each vector is calculated as follows:
     length of vector = maximum size  x  (current data / maximum data)
     direction of vector = from the centroid of the departure entity towards the centroid of the arrival entity

Each average vector is calculated as follows:
   average vector = (sum total of vectors / number of vectors)  x  ratio
    the ratio enables the largest vector to be adjusted to the selected maximum size.

Warnings

No non-valid data, negative data or data on the diagonal of the matrix can give rise to a vector.

If certain entities are made up of several surfaces (for example Italy, which is made up of the "boot" and two islands), the symbol is placed on the largest surface.

Parameters tab

The arrow end is a percentage showing the position of the arrow head as compared with its length. Its value thus varies from 0 to 100.

The arrow head thick factor is a multiplying factor giving the thickness of the arrow head as compared with^ the thickness of the body of the arrow. It can vary from 1 to 5.

If the Average vector box is checked, only one vector is drawn per entity. The average vector shows in its length and direction the average of the vectors for the entity.

• Colors
  
  
  

The vectors can be colored using the With filling box, which enables the desired color to be selected by clicking on the colored square to open the color panel.

The vectors can also be displayed with an outline by checking the With stroke box. In this case, the outline of the vectors can be given the color of your choice by clicking on the colored square to open the color panel.
You can also choose the stroke thickness, in map unit.

If you check neither the With stroke nor the With filling boxes, the vectors and the caption will not be visible.

Remarks on colors

To change a color, click on the desired color to open the color panel.

To create, remove or change a hatching, click on the desired color with the right button on PC, or click with the Apple key down on MAC, to open the hatch panel.
The values in the hatch panel are in map unit. If the module is in a user library or if no map is supplied in input, you can nevertheless set the values but you cannot see them.

• Sizes
  
  
  

The vectors sizes are automatically set at startup. When you uncheck the Automatic size box, you can specify the desired size and thickness in map unit.

You have two choices for specifying the size:

• Maximum size : the Size field contains the maximum length which corresponds to the highest value.
• Size for particular value : the Size field contains the length which corresponds to the value specified in the Value field.

Vectors that are smaller than the Visual threshold are not displayed. This threshold depends on the length chosen in the Size field.

Caption :

If the Display caption box has been checked, you have access to the various parametrizing commands for the caption.

A black frame can be added for this caption by checking the With frame box.

• Texts
  
  
  

You can first choose the caption title. It is the module name by default.

The number precision enables you to specify the number of figures to be shown before and after the comma. The number before the comma can be between 1 and 10, and the one after can be between 0 and 10. You can also check the automatic number precision checkbox to set a maximum of 9 significant numbers for the integer part and the decimal part together.

The number alignment allows you to set the alignment of the texts of the proportional caption : on the left, on the right or on the comma. The default choice is "automatic alignment" which choose the best format among the 3 available ones depending on the type of the input data : "comma alignment" for continuous data.

The column number is also modifiable. It enables you to have a classic vertical representation or an horizontal one or a representation in columns. The column number is limited to 12.

You can set the texts on the right or under the symbols in the caption.

• Font
  
  
  

You have the possibility of choosing the desired font. However, the size will not be here selected but in the Sizes option.

The text color can be set by clicking on the colored square to open the color panel.

• Sizes
  
  
  

When you uncheck the Automatic size box, you can specify the desired size in map unit.

Finally, you can select the desired space between symbols and texts in caption by choosing a small, normal or large caption.

• Proportional
  
  
  

You can choose not to color the interior of the symbols in the caption by checking the Empty symbols box.

The Invert order box enables you to invert the order of caption elements.
Attention, the order of the values specified in this tab will not be inverted.
Therefore:
- if the Invert order box is unchecked, the value of the first text zone will be at the top of the caption.
- if the Invert order box is checked, the value of the first text zone will be at the bottom of the caption.

• Elements
  
  
  

The caption steps specifies the number of symbols shown in the caption. It is limited to 12.

If the Automatic caption values box has been checked, the biggest symbol corresponds to the maximum value, the smallest one corresponds to the maximum value divided by four, and the intermediate symbols have surface areas in a linear progression.
By unchecking this box, you can specify in the 12 text fields the values that you want to be shown in the caption.

Script :

2      module untyped_list ""
3        mod_type integer "104"
3        mod_subtype integer "610"
3        mod_name string "Vectors"
3        mod_dads integer_list ""
4          ? integer "4"
3        caption_origin vector ""
4          x_val double "0"
4          y_val double "0"
4          z_val double "0"
3        map_bounds bounds ""
4          bottom_left vector ""
5            x_val double "72.699997"
5            y_val double "1620.900024"
5            z_val double "0"
4          top_right vector ""
5            x_val double "1197.599976"
5            y_val double "2675.399902"
5            z_val double "0"
3        arrow_end double "0.1"
3        arrow_head_thick double "2"
3        is_average boolean "F"
3        is_auto_size boolean "F"
3        is_max_size boolean "T"
3        max_size double "500"
3        value double "108"
3        thickness double "20"
3        min_size double "0"
3        stroke_thickness double "0"
3        fill fill ""
4          fill_color fill_color ""
5            red double "0"
5            green double "0.6"
5            blue double "0.8"
5            red255 integer "0"
5            green255 integer "153"
5            blue255 integer "204"
4          hatch hatch ""
5            angle1 double "0"
5            angle2 double "0"
5            desc_list1 double_list ""
5            desc_list2 double_list ""
5            is_weft boolean "F"
4          has_hatch boolean "F"
3        has_fill boolean "T"
3        stroke stroke ""
4          stroke_color stroke_color ""
5            red double "0"
5            green double "0"
5            blue double "0"
5            red255 integer "0"
5            green255 integer "0"
5            blue255 integer "0"
4          dash dash ""
5            desc_list double_list ""
4          has_dash boolean "F"
3        has_stroke boolean "T"
3        prj_show_caption boolean "T"
3        prj_title_string string ""
3        prj_precision_before integer "10"
3        prj_precision_after integer "0"
3        col_nb integer "1"
3        text_color stroke ""
4          stroke_color stroke_color ""
5            red double "0"
5            green double "0"
5            blue double "0"
5            red255 integer "0"
5            green255 integer "0"
5            blue255 integer "0"
4          dash dash ""
5            desc_list double_list ""
4          has_dash boolean "F"
3        has_back_square boolean "T"
3        right_pos boolean "T"
3        caption_font string "family:Times New Roman-face:medium roman-size:12"
3        caption_auto_height boolean "T"
3        caption_height double "19.1233"
3        caption_space integer "1"
3        empty_symb boolean "F"
3        prop_invert boolean "F"
3        prj_steps integer "3"
3        is_auto_values boolean "T"
3        user_values double_list ""
4          ? double "108"
4          ? double "67.5"
4          ? double "27"