Flows

Description :
This module enables the flow matrix (or matrices) to be represented by arrows linking the entities of origin and destination.

Results as a function of the inputs

If the continuous matrix input is the only one available, the thickness of the arrows is proportional to the values of the matrix. Positive and negative values are represented by an arrow oriented and curved in the opposite way, and they can also have a different color.

If the discrete matrix input is the only one available, the arrows are all the same thickness, but in different colors depending on the class.

If the continuous matrix input and the discrete matrix input are available, the thickness of the arrows is proportional to the values of the continuous matrix, and colored according to the discrete matrix.

Calculation of proportions

Each arrow is calculated in the following way:
     thickness = maximum size x  absolute value (current data / maximum data)

Warnings

If an arrow goes from a point to itself, it is always represented by a curved arrow.

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



If you want to show a curved arrow, you have two possibilities for determining the circle that will be used. You can indicate, in map unit, at will:
  - the ray of the circle.
  - the distance between the circle and a straight line.
The value you enter for this parameter is dealt with as absolute value. If it is negative, the arrow is curved the opposite way.
If you wish to show an arrow from a point back onto itself, we advise you to use the distance method rather than the ray method.

The arrow margin is its distance from the points of origin and destination, in map unit.

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.

You can invert the direction of the arrows by checking the Reverse arrows box.

Internal limitations

The arrow margin cannot be greater than half the arrow length, as otherwise the arrow would disappear. In this case, its value is internally limited to 95% of the length.

The curve ray must be at least equal to half the distance between the departure and arrival points, as otherwise the circle would not exist. In this case, its value is increased internally to half the distance.

In certain cases, an arrow with a curve that is too pronounced may be replaced by a straight line.

• Colors

If the discrete matrix input is available, the palette is made of as many colors as classes. A number in each color gives the correspondence between the color and the class.

If the discrete matrix input is available, you can check the Automatic palette box.

If the Automatic palette box is checked, a gradation is automatically done between the first and the last colors of the used palette. Then you can change only the first and the last colors of the palette. If you want to change the intermediate colors, you just have to uncheck the Automatic palette box.

Four lists of predefined palettes are supplied:

• automatic color gradiation palettes
• bicolor palettes and a multicolor palette
• automatic lines hatch palettes
• automatic points hatch palettes

You can choose not to color the interior of the arrows by unchecking the With filling box.

The arrows can be shown with an outline by checking the With stroke box. In this case, the outline of the arrows 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, in the Parameters tab.

If you check neither the With stroke nor the With filling boxes, the arrows 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 arrows sizes are automatically set at startup. When you uncheck the Automatic size box, you can specify the desired size in map unit.

If the continuous matrix input is available, you have two choices:

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

If the discrete matrix input is available, the arrows are all the same thickness, indicated by the Size field.

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

If the With stroke box of the Colors tab has been checked, you can choose the stroke thickness in map unit.

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

If the continuous matrix input and the discrete matrix input are available, then the module will have two captions : a proportional one and a discrete one.
The specifical parameters for these two captions are available in the Proportional and Class tabs.
The parameters available in this Caption tab are common to the two captions.

You can first choose the proportional caption title.
If the continuous matrix input and the discrete matrix input are available, then you can set the Qualitative caption title. The default caption titles are the module name..

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 can choose in a font list the desired font. The text color can be set by clicking on the colored square just below this list.

• Sizes

You just have to uncheck the Automatic size box to specify a different size in the 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.

• Elements

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.

The Invert order box enables you to invert the order of caption elements.
Attention, the order of the texts specified in this tab will not be inverted.
Therefore:
- if the Invert order box is unchecked, the text associated to the Class Nb 1 will be at the bottom of the caption.
- if the Invert order box is checked, the text associated to the Class Nb 1 will be at the top of the caption.

• Texts

You can change the caption texts by unchecking the Automatic strings computation box. You can then specify your texts in the Custom captions column. The first column gives the correspondence between the classes and the texts.
The caption texts are filled by default with hooks to indicate the class thresholds. From now on you can choose the automatic filling of these texts by using the formulation [x1 ; x2], from x1 to x2, x1 - x2 or the inset texts representation.

The Invert order box enables you to invert the order of caption elements.
Attention, the order of the texts specified in this tab will not be inverted.
Therefore:
- if the Invert order box is unchecked, the text associated to the Class Nb 1 will be at the bottom of the caption.
- if the Invert order box is checked, the text associated to the Class Nb 1 will be at the top of the caption.

Script :

2      module untyped_list ""
3        mod_type integer "104"
3        mod_subtype integer "607"
3        mod_name string "Flux"
3        mod_dads integer_list ""
4          ? integer "3"
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 "11178.219727"
5            y_val double "-686.891785"
5            z_val double "0"
4          top_right vector ""
5            x_val double "15543.969727"
5            y_val double "4379.312012"
5            z_val double "0"
3        is_curve_dist boolean "T"
3        arrow_curve double "300"
3        arrow_margin double "200"
3        arrow_end double "0.1"
3        arrow_head_thick double "2"
3        arrow_reverse boolean "F"
3        is_auto_size boolean "F"
3        is_max_size boolean "T"
3        max_size double "250"
3        value double "4.1"
3        min_size double "0"
3        stroke_thickness double "0"
3        auto_palette boolean "F"
3        fill_list fill_list ""
4          ? fill ""
5            fill_color fill_color ""
6              red255 integer "109"
6              green255 integer "178"
6              blue255 integer "255"
6              hue360 integer "211"
6              light255 integer "182"
6              saturation255 integer "255"
5            hatch hatch ""
6              angle1 double "0"
6              angle2 double "0"
6              desc_list1 double_list ""
6              desc_list2 double_list ""
6              is_weft boolean "T"
5            has_hatch boolean "F"
4          ? fill ""
5            fill_color fill_color ""
6              red255 integer "0"
6              green255 integer "178"
6              blue255 integer "0"
6              hue360 integer "120"
6              light255 integer "89"
6              saturation255 integer "255"
5            hatch hatch ""
6              angle1 double "0"
6              angle2 double "0"
6              desc_list1 double_list ""
6              desc_list2 double_list ""
6              is_weft boolean "T"
5            has_hatch boolean "F"
3        has_fill boolean "T"
3        stroke stroke ""
4          stroke_color stroke_color ""
5            red255 integer "0"
5            green255 integer "0"
5            blue255 integer "0"
5            hue360 integer "0"
5            light255 integer "0"
5            saturation255 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 "Nombre moyen de voyageurs quotidiens (millions)"
3        prj_precision_before integer "10"
3        prj_precision_after integer "1"
3        col_nb integer "1"
3        text_color stroke ""
4          stroke_color stroke_color ""
5            red255 integer "0"
5            green255 integer "0"
5            blue255 integer "0"
5            hue360 integer "0"
5            light255 integer "0"
5            saturation255 integer "0"
4          dash dash ""
5            desc_list double_list ""
4          has_dash boolean "F"
3        has_back_square boolean "F"
3        right_pos boolean "T"
3        caption_font string "family:Times New Roman-face:Regular-size:12"
3        caption_auto_height boolean "T"
3        caption_height double "86.125465"
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 "4.1"
4          ? double "2.5625"
4          ? double "1.025"
3        class_invert boolean "F"
3        caption_text integer "20"
3        prj_is_auto_strings boolean "T"
3        prj_user_string string_list ""
3        input_types integer_list ""
4          ? integer "11"
3        class_nb integer "0"