.. only:: html |updatedisclaimer| .. Purpose: This chapter aims to describe generic tools that can be used even .. if the user is in another chapter. .. _general_tools: ************* General Tools ************* .. only:: html .. contents:: :local: .. _`context_help`: Context help ============ .. index:: single: Context help When you need help on a specific topic, you can access context help via the **[Help]** button available in most dialogs --- please note that third-party plugins can point to dedicated web pages. .. index:: Panels Panels ======= QGIS provides by default many panels to work with. Some of these panels are described below while others may be found in different parts of the document. A complete list of default panels provided by QGIS is available at :ref:`panels_tools`. .. index:: Panels; Layers .. _`label_legend`: Layers Panel ------------ .. index:: single: Legend The :guilabel:`layers Panel` lists all the layers in the project and helps you manage their visibility. A layer can be selected and dragged up or down in the legend to change the Z-ordering. Z-ordering means that layers listed nearer the top of the legend are drawn over layers listed lower down in the legend. .. note:: The Z-ordering behavior can be overridden by the :ref:`Layer Order ` panel. At the top of the Layers panel, a toolbar allows you to: * |symbology| :sup:`Open the layer styling dock`: toggle the layer styling panel on and off. * |addGroup| :sup:`Add new group` * |showPresets| :sup:`Manage Visibility`: control visibility of layers and preset layers combination. * |filterMap| :sup:`Filter Legend by Map Content`: only the layers that are set visible and whose features intersect the current map canvas have their style rendered in the layers panel. Otherwise, a generic NULL symbol is applied to the layer. Based on the layer symbology, this is a convenient way to identify which kind of features from which layers cover your area of interest. * |expressionFilter| :sup:`Filter Legend by Expression`: helps you apply an expression to remove from the selected layer tree styles that have no feature satisfying the condition. This can be used for example to highlight features that are within a given area/feature of another layer. From the drop-down list, you can edit and clear the expression set. * |expandTree| :sup:`Expand All` or |collapseTree| :sup:`Collapse All` layers and groups in the layers panel. * and |removeLayer| :sup:`Remove Layer/Group` currently selected. .. _figure_layer_toolbar: .. figure:: /static/user_manual/introduction/layer_toolbar.png :align: center Layer Toolbar in Layers Panel .. note:: Tools to manage the layers panel are also available to layout the map and legend items of the print composer .. index:: Preset visibility .. _preset_visibility: Preset the layers visibility ............................ The button |showPresets| allows you to add **Presets** views in the legend. Presets are a way to save and easily restore a combination of layers with their current style. To add a preset view, just set visible the layers you want, with their desired symbology, and click on |showPresets| button. Choose :menuselection:`Add Preset...` from the drop-down menu and give a name to the preset. The added preset is listed at the bottom of the drop-down menu and is recalled by clicking on it. The :menuselection:`Replace Preset -->` option helps you overwrite a preset content with the current map view while the :menuselection:`Remove Current Preset` button deletes the active preset. All the added presets are also present in the map composer in order to allow you to create a map layout based on your specific views (see :ref:`composer_main_properties`). Overview of the context menu of the Layers panel ................................................ At the bottom of the toolbar, the main component of the Layers panel is the frame listing vector or raster layers added to the project and, those layers can be organized in groups. Depending on the item selected in the panel, a right-click shows a dedicated set of options presented below. ================================================================ ===================== ===================== =============== Option Vector Layer Raster Layer Group ================================================================ ===================== ===================== =============== |zoomToLayer| :menuselection:`Zoom to Layer/Group` |checkbox| |checkbox| |checkbox| |unchecked| :menuselection:`Show in Overview` |checkbox| |checkbox| \ |zoomActual| :menuselection:`Zoom to Native Resolution (100%)` \ |checkbox| \ :menuselection:`Stretch Using Current Extent` \ |checkbox| \ |removeLayer| :menuselection:`Remove` |checkbox| |checkbox| |checkbox| |duplicateLayer| :menuselection:`Duplicate` |checkbox| |checkbox| \ :menuselection:`Set Layer Scale Visibility` |checkbox| |checkbox| \ :menuselection:`Zoom to Visible Scale` |checkbox| |checkbox| \ :menuselection:`Set Layer/Group CRS` |checkbox| |checkbox| |checkbox| :menuselection:`Set Project CRS from Layer` |checkbox| |checkbox| \ :menuselection:`Styles -->` |checkbox| |checkbox| \ :menuselection:`Copy Style` |checkbox| |checkbox| \ :menuselection:`Paste Style` |checkbox| |checkbox| |checkbox| |openTable| :menuselection:`Open Attribute Table` |checkbox| \ \ |toggleEditing| :menuselection:`Toggle Editing` |checkbox| \ \ |allEdits| :menuselection:`Current Edits -->` |checkbox| \ \ (in Edit mode) :menuselection:`Save As...` |checkbox| |checkbox| \ :menuselection:`Save As Layer Definition File...` |checkbox| |checkbox| |checkbox| :menuselection:`Filter...` |checkbox| \ \ |unchecked| :menuselection:`Show Feature Count` |checkbox| \ \ :menuselection:`Properties` |checkbox| |checkbox| \ :menuselection:`Move to Top-level` |checkbox| |checkbox| \ :menuselection:`Rename` |checkbox| |checkbox| |checkbox| :menuselection:`Group Selected` |checkbox| |checkbox| \ :menuselection:`Set Group WMS Data` \ \ |checkbox| |unchecked| :menuselection:`Mutually Exclusive Group` \ \ |checkbox| |addGroup| :menuselection:`Add Group` \ \ |checkbox| ================================================================ ===================== ===================== =============== Table: Context menu from Layers Panel items For GRASS vector layers, |toggleEditing| :sup:`Toggle editing` is not available. See section :ref:`grass_digitizing` for information on editing GRASS vector layers. .. index:: Group, Layer .. _group_layers_interact: Interact with Groups and layers ............................... Layers in the legend window can be organized into groups. There are two ways to do this: #. Press the |folder| icon to add a new group. Type in a name for the group and press :kbd:`Enter`. Now click on an existing layer and drag it onto the group. #. Select some layers, right click in the legend window and choose :guilabel:`Group Selected`. The selected layers will automatically be placed in a new group. To bring a layer out of a group, you can drag it out, or right click on it and choose :guilabel:`Move to top-level`; the layer is placed at the same level than the group it was inside. Groups can also be nested inside other groups. The checkbox for a group will show or hide all the layers in the group with one click. Enabling the **Mutually Exclusive Group** option you can make a group have only one layer visible at the same time. Whenever a layer within the group is set visible the others will be toggled not visible. It is possible to select more than one layer or group at the same time by holding down the :kbd:`Ctrl` key while selecting the layers with the left mouse button. You can then move all selected layers to a new group at the same time. You may also delete more than one layer or group at once by selecting several items with the :kbd:`Ctrl` key and pressing :kbd:`Ctrl+D` afterwards. This way, all selected layers or groups will be removed from the layers list. .. index:: Style .. _editing_style_layer: Editing vector layer style ........................... From the Layers panel, you have shortcuts to easily and quickly edit the layer rendering. Right-click on a vector layer and select :menuselection:`Styles -->` in the list in order to: * see the currently applied :ref:`styles ` to the layer. In case you defined many styles for the layer, you can switch from one to another and have your layer rendering automatically updated in the map canvas. * copy the current style, and when applicable, paste a copied style from another layer * rename the current style, add a new one (which is actually a copy of the current one) or delete the current style (when multiple styles available). .. note:: The previous options are also available for raster layer. Whether the features in the vector layer have all the same unique symbol or they are classified (in that case, the layer is displayed in a tree structure with each class as sub-item), the following options are available at layer level or class level: * a :guilabel:`Edit Symbol...` button to open the :ref:`symbol-selector` dialog and update any property (symbol, size, color...) of the layer or feature symbol. Double-clicking on a feature does also open the :guilabel:`Symbol Selector` dialog. * a :ref:`color-selector` widget with a **Color Wheel** from which you can click a color and have it automatically update the symbol fill color. For convenience, **Recent colors** are available at the bottom of the color wheel. * a |showAllLayers| :guilabel:`Show All Items` and |hideAllLayers| :guilabel:`Hide All Items` to toggle on or off the visibility of all the classes of features. This avoids (un)checking items one by one. .. tip:: **Quickly share a layer style** From the context menu, copy the style of a layer and paste it to a group or a selection of layers: the style is applied to all the layers that are of the same type (vector vs raster) as the original layer and, in case of vector, have the same geometry type (point, line or polygon). .. index:: Layers; Order .. _layer_order: Working with the Legend independent layer order ------------------------------------------------ There is a panel that allows you to define an independent drawing order for the layers panel. You can activate it in the menu :menuselection:`Settings --> Panels --> Layer Order Panel`. This feature allows you to, for instance, order your layers in order of importance, but still display them in the correct order (see figure_layer_order_; you can notice that the ``airports`` features are displayed over the ``alaska`` polygon despite their layers placement in the Layers panel). Unchecking the |checkbox| :guilabel:`Control rendering order` box underneath the list of layers will cause a revert to default behavior. .. _figure_layer_order: .. figure:: /static/user_manual/introduction/layer_order.png :align: center Define a legend independent layer order .. index:: single: Layer properties single: Panels; Style .. _layer_styling_panel: Layer Styling Panel -------------------- This panel is somehow a shortcut to some of the features of the layer properties dialog. It indeed offers you a quick and handy way to define the rendering and the behavior of a layer, and to visualize its effects without opening the layer properties dialog. Besides avoiding you dealing with the modal and blocking dialog of the layer properties, it also avoids you cluttering the screen with features dialogs given that it embeds most of them (color selector, effects properties, rule edit, label substitution...): e.g., clicking color buttons inside the layer style panel causes the color selector dialog to be opened inside the layer style panel itself rather than as a separate dialog. From a drop-down list of current layers in the layer panel, select an item and: * set its symbology, transparency, and histogram in case of raster layer. These options are the same available in :ref:`raster_properties_dialog` * set its symbology, and labels. These options are the same available in :ref:`vector_properties_dialog` * manage the associated style(s) as described in :ref:`manage_custom_style` * follow the whole history of changes you applied to the layer style in the current project; you can therefore cancel or restore to any state by selecting it in the list and hit **[Apply]** button. Another powerful feature of this panel is the :guilabel:`Live update` checkbox. Tick it and your changes are automatically rendered in the map canvas as you go on. You no longer need to hit the **[Apply]** button. .. _figure_layer_styling: .. figure:: /static/user_manual/introduction/layer_styling.png :align: center Defining a layer symbology from the layer styling panel .. tip:: **Add custom tabs to the Layer Styling panel** Using :ref:`PyQGIS `, you can set new tabs to manage layer properties in the Layer Styling Panel. See https://nathanw.net/2016/06/29/qgis-style-dock-part-2-plugin-panels/ for an example. .. Actually, what could be nice is to provide example in the Cookbook to have an internal and always guaranteed link (see #2071) .. index:: single: Panels; Statistic single: Statistic .. _`statistical_summary`: Statistical Summary Panel -------------------------- This panel can show some statistics on a specific vector layers. The panel allows users to choose: * the vector layer; * the column or the expression; * filter statistics to selected features; * refresh the informations; * the statistics information to display with the bottom right button. Statistic information available are (depending on the field's type): ================================== ============ ============ ============ ============ Statistics String Integer Float Date ================================== ============ ============ ============ ============ Count |checkbox| |checkbox| |checkbox| |checkbox| Count Distinct Value |checkbox| |checkbox| Count Missing value |checkbox| |checkbox| Sum |checkbox| |checkbox| Mean |checkbox| |checkbox| |checkbox| Standard Deviation |checkbox| |checkbox| Standard Deviation on Sample |checkbox| |checkbox| Minimal value |checkbox| |checkbox| |checkbox| |checkbox| Maximal value |checkbox| |checkbox| |checkbox| |checkbox| Range |checkbox| |checkbox| |checkbox| Minority |checkbox| |checkbox| Majority |checkbox| |checkbox| Variety |checkbox| |checkbox| First Quartile |checkbox| |checkbox| Third Quartile |checkbox| |checkbox| Inter Quartile Range |checkbox| |checkbox| Minimum Length |checkbox| Maximum Length |checkbox| ================================== ============ ============ ============ ============ Table: Statistics available for each field type .. _figure_statistical_summary: .. figure:: /static/user_manual/introduction/statistical_summary.png :align: center Show statistics on a field .. index:: single: Map; Overview single: Panels; Overview .. _`overview_panels`: QGIS Overview Panel -------------------- In QGIS, you can use an overview panel that provides a full extent view of layers added to it. Within the view is a rectangle showing the current map extent. This allows you to quickly determine which area of the map you are currently viewing. Note that labels are not rendered to the map overview even if the layers in the map overview have been set up for labelling. If you click and drag the red rectangle in the overview that shows your current extent, the main map view will update accordingly. .. index:: single: Log messages single: Panels; Log messages .. _`log_message_panel`: Log Messages Panel ------------------ When loading or processing some operations, you can track and follow messages that appear in different tabs using the |messageLog| Log Messages Panel. It can be activated using the most right icon in the bottom status bar. .. index:: Undo, Redo single: Panels; Undo single: Panels; Redo .. _`undo_redo_panel`: Undo/Redo Panel --------------- For each layer being edited, this panel shows the list of actions done, allowing to quickly undo a set of actions by simply selecting the action listed above. More details at :ref:`Undo and Redo edits `. .. index:: Rendering .. _`redraw_events`: Rendering ========= By default, QGIS renders all visible layers whenever the map canvas is refreshed. The events that trigger a refresh of the map canvas include: * Adding a layer * Panning or zooming * Resizing the QGIS window * Changing the visibility of a layer or layers QGIS allows you to control the rendering process in a number of ways. .. index:: Rendering scale dependent, Scale .. _`label_scaledepend`: Scale Dependent Rendering ------------------------- Scale-dependent rendering allows you to specify the minimum and maximum scales at which a layer (raster or vector) will be visible. To set scale-dependent rendering, open the :guilabel:`Properties` dialog by double-clicking on the layer in the legend. On the :guilabel:`General` tab, tick the |checkbox| :guilabel:`Scale dependent visibility` checkbox and enter the :guilabel:`Minimum (exclusive)` and :guilabel:`Maximum (inclusive)` scale values. You can also activate the scale dependent visibility on a layer from the Layers panel. Right-click on the layer and in the context menu, select :guilabel:`Set Layer Scale Visibility`. The |mapIdentification| :sup:`Set to current canvas scale` button helps you use the current map canvas scale as boundary of the range visibility. .. note:: When a layer is not rendered in the map canvas due to the map scale out of its visibility scale range, the layer is greyed in the Layers panel and a new option :guilabel:`Zoom to Visible Scale` appears in the layer context menu. Select it and the map is zoomed to the layer's nearest visibility scale. .. _`label_controlmap`: Controlling Map Rendering ------------------------- Map rendering can be controlled in various ways, as described below. .. index:: single: Rendering; Suspending .. _`label_suspendrender`: Suspending Rendering .................... To suspend rendering, click the |checkbox| :guilabel:`Render` checkbox in the lower right corner of the status bar. When the |checkbox| :guilabel:`Render` checkbox is not checked, QGIS does not redraw the canvas in response to any of the events described in section :ref:`redraw_events`. Examples of when you might want to suspend rendering include: * Adding many layers and symbolizing them prior to drawing * Adding one or more large layers and setting scale dependency before drawing * Adding one or more large layers and zooming to a specific view before drawing * Any combination of the above Checking the |checkbox| :guilabel:`Render` checkbox enables rendering and causes an immediate refresh of the map canvas. .. index:: single: Rendering; Options single: Layers; Initial visibility .. _`label_settinglayer`: Setting Layer Add Option ........................ You can set an option to always load new layers without drawing them. This means the layer will be added to the map, but its visibility checkbox in the legend will be unchecked by default. To set this option, choose menu option :menuselection:`Settings --> Options` and click on the :guilabel:`Rendering` tab. Uncheck the |checkbox| :guilabel:`By default new layers added to the map should be displayed` checkbox. Any layer subsequently added to the map will be off (invisible) by default. .. index:: single: Rendering; Halting .. _label_stoprender: Stopping Rendering .................. To stop the map drawing, press the :kbd:`ESC` key. This will halt the refresh of the map canvas and leave the map partially drawn. It may take a bit of time between pressing :kbd:`ESC` and the time the map drawing is halted. .. note:: It is currently not possible to stop rendering --- this was disabled in the Qt4 port because of User Interface (UI) problems and crashes. .. index:: single: Rendering; Quality .. _`label_renderquality`: Influence Rendering Quality ........................... QGIS has an option to influence the rendering quality of the map. Choose menu option :menuselection:`Settings --> Options`, click on the :guilabel:`Rendering` tab and select or deselect |checkbox| :guilabel:`Make lines appear less jagged at the expense of some drawing performance`. .. index:: single: Rendering; Speed-up Speed-up rendering .................. There are some settings that allow you to improve rendering speed. Open the QGIS options dialog using :menuselection:`Settings --> Options`, go to the :guilabel:`Rendering` tab and select or deselect the following checkboxes: * |checkbox| :guilabel:`Use render caching where possible to speed up redraws` * |checkbox| :guilabel:`Render layers in parallel using many CPU cores` and then set the |checkbox| :guilabel:`Max cores to use`. * The map renders in the background onto a separate image and each |checkbox| :guilabel:`Map Update interval`, the content from this (off-screen) image will be taken to update the visible screen representation. However, if rendering finishes faster than this duration, it will be shown instantaneously. * With |checkbox| :guilabel:`Enable Feature simplification by default for newly added layers`, you simplify features' geometry (less nodes) and as a result, they quickly display. Be aware that you can also face rendering inconsistencies. .. index:: Save properties, Save style, QML, SLD .. _save_layer_property: Save and Share Layer Properties ================================ .. _manage_custom_style: Managing Custom Styles ----------------------- When a vector layer is added to map canvas, QGIS uses by default a random symbol/color to render its features. You can however set a default symbol in :menuselection:`Project --> Project Properties --> Default styles` that will be applied to each newly added layer according to its geometry type. .. any idea on how it works for raster? But, most of the time, you'd prefer to have a custom and more complex style that can be applied automatically or manually (with less efforts) to the layers. You can achieve this goal using the :menuselection:`Style` combobox at the bottom of the Layer Properties dialog. This combobox provides you with functions to create, load and manage styles. A style stores any information set in the layer properties dialog to render or interact with the features (including symbology, labeling, action, diagram... settings) for vector layer, or the pixels (band or color rendering, transparency, pyramids, histogram ...) for raster. .. _figure_manage_style: .. figure:: /static/user_manual/introduction/style_combobox.png :align: center Vector layer style combobox options By default, the style applied to a loaded layer is named ``default``. Once you have got the ideal and appropriate rendering for your layer, you can save it by clicking the |selectString| :menuselection:`Style` combobox and choose: * **Rename Current**: The active style gets renamed and updated with the current options * **Add**: A new style is created using the current options. By default, it will be saved in the QGIS project file. See below to save the style in another file or a database * **Remove**: delete unwanted style, in case you have more than one style defined for the layer. At the bottom of the Style drop-down list, you see the styles set for the layer and the active one is checked. Note that each time you validate the layer properties dialog, the active style is updated with the changes you've done. You can create as many styles as you wish for a layer but only one can be active at a time. Combined to layer visibility preset, this offers a quick and powerful way to manage complex projects with few layers (no need to duplicate any layer in the map legend). .. tip:: **Manage styles from layer context menu** Right-click on the layer in :guilabel:`Layers Panel` to add, rename or remove layer style. .. _store_style: Storing Style in a File or a Database -------------------------------------- While created styles from the :guilabel:`Style` combobox are by default saved inside the project and can be copied and pasted from layer to layer in the project, it's also possible to save them outside the project so that they can be loaded in another project. Save in plain text file ........................ Clicking the |selectString| :menuselection:`Style --> Save Style`, you can save the style as a: * QGIS layer style file (:file:`.qml`) * or SLD file (:file:`.sld`), only available for vector layers. Used on file based format layers (:file:`.shp`, :file:`.tab`...), :guilabel:`Save as Default` generates a :file:`.qml` file along the layer (with the same name). SLDs can be exported from any type of renderer -- single symbol, categorized, graduated or rule-based -- but when importing an SLD, either a single symbol or rule-based renderer is created. That means that categorized or graduated styles are converted to rule-based. If you want to preserve those renderers, you have to stick to the QML format. On the other hand, it can be very handy sometimes to have this easy way of converting styles to rule-based. Save in database ................. Vector layer style can also be stored in a database if the layer datasource is a database provider. Supported formats are PostGIS, GeoPackage, SpatiaLite, MSSQL and Oracle. The layer style is saved inside a table (named :file:`layer_styles`) of the database. Click on :menuselection:`Save Style --> Save in database` item then fill in the dialog to define a style name, add a description, a :file:`.ui` file if applicable and check if the style should be the default style. You can save several styles for a single table in the database. However each table can have only one default style. Default style can be saved in the layer database or in the QGIS local database, a SQLite database in the :file:`~/.qgis2/` directory (where QGIS stores its local settings). .. _figure_save_style_database: .. figure:: /static/user_manual/introduction/save_style_database.png :align: center Save Style in database Dialog .. tip:: **Sharing style files between databases** You can only save your style in a database if the layer comes from such a database. You can't mix databases (layer in Oracle and style in MSSQL for instance). Use instead a plain text file if you want the style to be shared among databases. .. note:: You may encounter issues to restore the :file:`layer_styles` table from a PostgreSQL database backup. Follow :ref:`layer_style_backup` to fix that. Load style ........... When loading a layer in QGIS, if a default style already exists for this layer, QGIS loads the layer with this style. Also :menuselection:`Style --> Restore Default` looks for and loads that file when pressed, replacing current style of the layer. The :menuselection:`Style --> Load Style` helps you apply any saved style to a layer. While plain text file style (:file:`.sld` or :file:`.qml`) can be applied to any layer whatever its format is, loading styles stored in database is only possible if the layer is from the same database or the style is stored in the QGIS local database. The :guilabel:`Load Style from Database` dialog displays a list of related styles to the layer found in the database and all the other styles saved in it, with name and description. .. tip:: **Quickly share a layer style within the project** You can also share layer style within a project without importing a file or database style: right-click on the layer in the :guilabel:`Layers Panel` and, from the :guilabel:`Styles` combobox , copy the style of a layer and paste it to a group or a selection of layers: the style is applied to all the layers that are of the same type (vector vs raster) as the original layer and, in case of vector, have the same geometry type (point, line or polygon). .. index:: Colors .. _color-selector: Color Selector ============== The :guilabel:`select color` dialog will appear whenever you push the |selectColor| icon to choose a color. The features of this dialog depends on the state of the :guilabel:`Use native color chooser dialogs` parameter checkbox in :menuselection:`Settings --> Options --> General` menu. When checked, the color dialog used is the one of the OS being used. Otherwise, QGIS custom color chooser is used. .. tip:: **Dynamically change the color with the live-updating option** Check the :guilabel:`Use live-updating color chooser dialogs` option in the :menuselection:`Settings --> Options --> General` menu to have the color applied to your items as soon as you pick it in the color chooser dialog. The custom color chooser dialog has four different tabs which allow you to select colors by |colorBox| :sup:`color ramp`, |colorWheel| :sup:`color wheel`, |colorSwatches| :sup:`color swatches` or |colorPicker| :sup:`color picker` (not available under |osx|). Whatever method you use, the selected color is always described through color sliders for ``HSV`` (Hue, Saturation, Value) and ``RGB`` (Red, Green, Blue) values. The color is also identifiable as a :guilabel:`HTML notation`. Finally, there is an :guilabel:`opacity` slider to set transparency level. Modifying a color is as simple as clicking in the color wheel or ramp or in any of the color parameters sliders. You can adjust such parameters with the spinbox beside or, handy, scrolling the mouse wheel over the corresponding slider. You can also typeset the color html notation. The dialog also provides a visual comparison between the :guilabel:`current` (applied to widget) and the :guilabel:`new` (being selected) colors. Thanks to drag-and-drop, any of these colors can be saved in a slot for an easy access. .. _figure_color_selector_ramp: .. figure:: /static/user_manual/introduction/color_selector_ramp.png :align: center Color selector ramp tab With |colorBox| :sup:`color ramp` or |colorWheel| :sup:`color wheel` tab, you can browse to all possible color combinations and apply it to the item. In the |colorSwatches| :sup:`color swatches` tab, you can choose from a preselected list of color palettes: * :guilabel:`Recent colors`, * :guilabel:`Standard colors`, a user-defined list of colors set under :menuselection:`Settings --> Options --> Colors` menu * or :guilabel:`Project colors`, a user-defined list of colors set under :menuselection:`Project --> Project Properties --> Default Styles`. The latest palettes can be modified thanks to the |signPlus| and |signMinus| buttons at the bottom of the frame. The :guilabel:`...` button nearby the palette combobox also offers several options to: * copy, paste, import or export colors * create, import or remove color palettes. Check the :guilabel:`Show in Color Buttons` option to add the custom palette to the color selector widget (see figure_color_selector_). .. _figure_color_selector_switcher: .. figure:: /static/user_manual/introduction/color_selector_recent_colors.png :align: center Color selector switcher tab Another option is to use the |colorPicker| :sup:`color picker` which allows you to sample a color from under your mouse pointer at any part of QGIS or even from another application by pressing the space bar. Please note that the color picker is OS dependent and is currently not supported by macOS. .. _quick_color_modification: .. tip:: **Quick color modification** Click the drop-down arrow at the right of the |selectColor| color box button to display a widget for a quick color selection, either in the color wheel or from existing color palettes. You can also use it to :guilabel:`copy` or :guilabel:`paste` a color. .. _figure_color_selector: .. figure:: /static/user_manual/introduction/quick_color_selector.png :align: center Quick color selector menu .. index:: single: Rendering effects; Blending modes .. _blend-modes: Blending Modes =============== QGIS offers different options for special rendering effects with these tools that you may previously only know from graphics programs. Blending modes can be applied on layers, on features but also on print composer items: * **Normal**: This is the standard blend mode, which uses the alpha channel of the top pixel to blend with the pixel beneath it. The colors aren't mixed. * **Lighten**: This selects the maximum of each component from the foreground and background pixels. Be aware that the results tend to be jagged and harsh. * **Screen**: Light pixels from the source are painted over the destination, while dark pixels are not. This mode is most useful for mixing the texture of one item with another item (e.g., you can use a hillshade to texture another layer). * **Dodge**: Dodge will brighten and saturate underlying pixels based on the lightness of the top pixel. So, brighter top pixels cause the saturation and brightness of the underlying pixels to increase. This works best if the top pixels aren't too bright; otherwise the effect is too extreme. * **Addition**: This blend mode simply adds pixel values of one item with the other. In case of values above one (in the case of RGB), white is displayed. This mode is suitable for highlighting features. * **Darken**: This creates a resultant pixel that retains the smallest components of the foreground and background pixels. Like lighten, the results tend to be jagged and harsh. * **Multiply**: Here, the numbers for each pixel of the top item are multiplied with the corresponding pixels for the bottom item. The results are darker pictures. * **Burn**: Darker colors in the top item cause the underlying items to darken. Burn can be used to tweak and colorise underlying layers. * **Overlay**: This mode combines the multiply and screen blending modes. In the resulting picture, light parts become lighter and dark parts become darker. * **Soft light**: This is very similar to overlay, but instead of using multiply/screen it uses color burn/dodge. This is supposed to emulate shining a soft light onto an image. * **Hard light**: Hard light is also very similar to the overlay mode. It's supposed to emulate projecting a very intense light onto an image. * **Difference**: Difference subtracts the top pixel from the bottom pixel, or the other way around, to always get a positive value. Blending with black produces no change, as the difference with all colors is zero. * **Subtract**: This blend mode simply subtracts pixel values of one item from the other. In case of negative values, black is displayed. .. index:: Zoom, Pan, Map navigation .. _zoom_pan: Zooming and Panning ==================== QGIS provides tools to zoom and pan to your area of interest. Apart from using the |pan| :sup:`pan` and |zoomIn| :sup:`zoom-in` / |zoomOut| :sup:`zoom-out` icons on the toolbar with the mouse, navigating can also be done with the mouse wheel, spacebar and the arrow keys. A :guilabel:`Zoom factor` can be set under the :menuselection:`Settings -->` |options| :menuselection:`Options --> Map tools` menu to define the scale behavior while zooming. With the mouse wheel -------------------- You can press the mouse wheel to pan inside of the main window (on macOS, you may need to hold :kbd:`cmd` key). You can roll the mouse wheel to zoom in and out on the map; the mouse cursor position will be the center of the zoomed area of interest. Holding down :kbd:`Ctrl` while rolling the mouse wheel results in a finer zoom. With the arrow keys ------------------- Panning the map is possible with the arrow keys. Place the mouse cursor inside the map area, and click on the right arrow key to pan east, left arrow key to pan west, up arrow key to pan north, and down arrow key to pan south. You can also use the space bar to temporarily cause mouse movements to pan the map. The :kbd:`PgUp` and :kbd:`PgDown` keys on your keyboard will cause the map display to zoom in or out following the zoom factor set. Pressing :kbd:`Ctrl +` or :kbd:`Ctrl -` also performs an immediate zoom in/out on the map canvas. When certain map tools are active (Identify, Measure...), you can perform a zoom by holding down :kbd:`Shift` and dragging a rectangle on the map to zoom to that area. This is enabled for the map tools which are not selection tools (since they use :kbd:`Shift` for adding to selection) nor edit tools. .. index:: pair: Tools; Measure .. _`sec_measure`: Measuring ========= General information -------------------- QGIS provides four means of measuring geometries: * the interactive measurement tools |measure|, * measuring in the |calculateField| :sup:`Field Calculator`, * derived measures in the :ref:`identify` tool, * and a vector analysis tool: :menuselection:`Vector --> Geometry Tools --> Export/Add Geometry Columns` Measuring works within projected coordinate systems (e.g., UTM) and unprojected data. The first three measuring tools behave equally to global project settings: * If :guilabel:`"on the fly" CRS transformation` (see :ref:`otf_transformation`) is enabled, the default measurement metric is - different from most other GIS - ellipsoidal, using the ellipsoid defined in :menuselection:`File --> Project properties --> General`. This is true both when geographic and projected coordinate systems are defined for the project. * If you want to calculate the projected / planimetric area or distance using cartesian maths, the measurement ellipsoid has to be set to "None / Planimetric" (:menuselection:`File --> Project properties --> CRS`). However, with a geographic (= unprojected) CRS defined for the data and project, area and distance measurement will be ellipsoidal. * If :guilabel:`"on the fly" CRS transformation` is disabled, the measurement metric is planimetric when the project coordinate system is projected and ellipsoidal when the project coordinate system is unprojected / geographic. However, neither the identify tool nor the field calculator will transform your data to the project CRS before measuring. If you want to achieve this, you have to use the vector analysis tool: :menuselection:`Vector --> Geometry Tools --> Export/Add Geometry Columns`. Here, measurement is by default planimetric except if you choose the ellipsoidal measure. Measure length, areas and angles interactive ---------------------------------------------- Click the |measure| icon in the Attribute toolbar to begin measurements. The downward arrow near the icon helps you switch to the convenient tool to measure |measure| length, |measureArea| area or |measureAngle| angle. The default unit used in the dialog is the one set in :menuselection:`Project --> Project Properties --> General` menu. .. note:: **Configuring the measure tool** While measuring length or area, clicking the :guilabel:`Configuration` button at the bottom of the widget helps you define in menu :menuselection:`Settings --> Options --> Map Tools` the rubberband color, the precision of the measurements and the unit behavior. You can also choose your preferred measurement or angle units but keep in mind that those values are superseded in the current project by options made in :menuselection:`Project --> Project Properties --> General` menu. All measuring modules use the snapping settings from the digitizing module (see section :ref:`snapping_tolerance`). So, if you want to measure exactly along a line feature, or around a polygon feature, first set its layer snapping tolerance. Now, when using the measuring tools, each mouse click (within the tolerance setting) will snap to that layer. .. index:: single: Measure; Distances single: Measure; Areas single: Measure; Angles By default, |measure| :sup:`Measure Line`: QGIS measures real distances between given points according to a defined ellipsoid. The tool then allows you to click points on the map. Each segment length, as well as the total, shows up in the measure window. To stop measuring, click your right mouse button. Note that you can use the drop-down list near the total to interactively change the measurement units while measuring. This unit is kept for the widget until a new or another project is opened. The :guilabel:`Info` section in the dialog explains how calculations are made according to CRS settings available. .. %FixMe: currently, validating the Settings --> Options dialog revert any change made on units in the measurement dialog (see http://hub.qgis.org/issues/15436 bug or not? should it be documented?) .. _figure_measure_length: .. figure:: /static/user_manual/introduction/measure_line.png :align: center Measure Distance |measureArea| :sup:`Measure Area`: Areas can also be measured. In the measure window, the accumulated area size appears. Right-click to stop drawing. The Info section is also available as well as the ability to switch between different area units. .. _figure_measure_area: .. figure:: /static/user_manual/introduction/measure_area.png :align: center Measure Area |measureAngle| :sup:`Measure Angle`: You can also measure angles. The cursor becomes cross-shaped. Click to draw the first segment of the angle you wish to measure, then move the cursor to draw the desired angle. The measure is displayed in a pop-up dialog. .. _figure_measure_angle: .. figure:: /static/user_manual/introduction/measure_angle.png :align: center Measure Angle .. index:: see: Select; Selection tools single: Selection tools; Select all single: Selection tools; Invert selection single: Selection tools; Select by expression single: Selection tools; Select by form single: Selection tools; Select by polygon single: Selection tools; Select by freehand single: Selection tools; Select by rectangle single: Selection tools; Select by radius pair: Select; Deselect .. _`sec_selection`: Selecting features ================== QGIS provides several tools to select features in the map canvas. Selection tools are available in :menuselection:`View --> Select` menu or in the :guilabel:`Attributes toolbar`. .. note:: Selection tools work with the currently active layer. Selecting manually in the map canvas ------------------------------------- To select one or several features with the mouse, you can use one of the following tools: * |selectRectangle| :sup:`Select Features by area or single click` * |selectPolygon| :sup:`Select Features by Polygon` * |selectFreehand| :sup:`Select Features by Freehand` * |selectRadius| :sup:`Select Features by Radius` .. note:: Except the |selectPolygon| :sup:`Select Features by Polygon` tool, these manual selection tools allow you to select feature(s) in the map canvas with a single click. While using the |selectRectangle| :guilabel:`Select Feature(s)` tool, holding :kbd:`Shift` or :kbd:`Ctrl` toggles whether feature is selected (ie either adds to the current selection or remove from it). For the other tools, different behaviors can be performed holding: * :kbd:`Shift`: add features to the current selection * :kbd:`Ctrl`: substract features from the current selection * :kbd:`Ctrl + Shift`: intersect with current selection, ie only keep overlapping features from the current selection * :kbd:`Alt`: select features that are totally within the selection shape. Combined to :kbd:`Shift` or :kbd:`Ctrl` keys, you can add or substract features to/from the current selection. .. _automatic_selection: Automatic selection -------------------- The other selection tools, also available from the :ref:`Attribute table `, perform a selection based on feature's attribute or its selection state (note that attribute table and map canvas show the same information, so if you select one feature in attribute table, it will be selected in map canvas also): * |expressionSelect| :sup:`Select By Expression...` allows user to select features using expression dialog. * |formSelect| :sup:`Select Features By Value...` or press :kbd:`F3` * |deselectAll| :sup:`Deselect Features from All Layers` or press :kbd:`Ctrl+Shift+A` to deselect all selected features in all layers. * |selectAll| :sup:`Select All Features` or press :kbd:`Ctrl+A` to select all features in the current layer. * |invertSelection| :sup:`Invert Feature Selection` to invert the selection in the current layer. For example, if you want to find regions that are boroughs from :file:`regions.shp` of the QGIS sample data, you can use the |expressionSelect| :sup:`Select features using an Expression` icon. Then, you open the :guilabel:`Fields and Values` menu and choose the field that you want to query. Double-click the field 'TYPE_2' and also click **[Load all unique values]** in the right panel. From the list, choose and double-click 'Borough'. In the :guilabel:`Expression` field, then you'd write the following query: :: "TYPE_2" = 'Borough' From the expression builder dialog, you can also use the :menuselection:`Function list --> Recent (Selection)` to make a selection that you used before. The dialog remembers the last 20 used expressions. See :ref:`vector_expressions` chapter for more information and some example. .. tip:: **Save your selection into a new file** Users can save selected features into a **New Temporary Scratch Layer** or a **New Vector Layer** using :menuselection:`Edit --> Copy Features` and :menuselection:`Edit --> Paste Features as` in the wanted format. .. index:: single: Selection tools; Select by value .. _select_by_value: Select Features By Value ------------------------ This selection tool opens the layer's feature form allowing the user to choose, for each field, which value to look for, if the search should be case sensitive, and the operation that should be used. .. _figure_filter_form: .. figure:: /static/user_manual/introduction/select_by_value.png :align: center Filter/Select features using form dialog Alongside each field, there is a drop-down list with the operation options to control the search behaviour. The common options are: * :guilabel:`Exclude Field` - The field will not be used for searching * :guilabel:`Equal to (=)` * :guilabel:`Not equal to` * :guilabel:`Is missing (null)` * :guilabel:`Is not missing (not null)` For numeric and datetime fields, the additional options are: * :guilabel:`Greater than (>)` * :guilabel:`Less than (<)` * :guilabel:`Greater than or equal to (>=)` * :guilabel:`Less than or equal to (<=)` * :guilabel:`Between (inclusive)` * :guilabel:`Is not between (inclusive)` For text fields, the additional options are: * :guilabel:`Contains` * :guilabel:`Does not contain` For the text options above, it is also possible to use the |checkbox| :guilabel:`Case sensitive` option. After setting all search options, you can use the :guilabel:`Select features` button to select the matching features. The drop-down options are: * :guilabel:`Select features` * :guilabel:`Add to current selection` * :guilabel:`Filter current selection` * :guilabel:`Remove from current current selection` You can also clean all search options using the :guilabel:`Reset form` button. .. index:: Data-defined override .. _data_defined: Data defined override setup =========================== Beside many options in the vector layer properties dialog or settings in the print composer, you can find a |dataDefined| :sup:`Data defined override` icon. Thanks to :ref:`expressions ` based on layer attributes or item settings, prebuild or custom functions and :ref:`variables `, this tool allows you to set dynamic value for the concerned parameter. When enabled, the value returned by this widget is applied to the parameter regardless its normal value (checkbox, textbox, slider...). Clicking the |dataDefined| :sup:`Data defined override` icon shows following entries: * :guilabel:`Description...` that indicates if the option is enabled, which input is expected, the valid input type and the current definition. Hovering over the widget also pops up these information; * :guilabel:`Field type`: an entry to select from the layer's fields that match the valid input type; * an entry to list the :guilabel:`Variable` available; * :guilabel:`Edit...` button to create or edit the expression to use; * :guilabel:`Paste` and :guilabel:`Copy` buttons; * :guilabel:`Clear` button to remove the setup. Parameters that can be used with data-defined tools are: * Style and symbols parameters * Labels parameters * Composer parameters .. tip:: **Use right-click to (de)activate the data overriding** You can enable or disable a configured |dataDefined| :sup:`data-defined override` button by simply clicking the widget with the mouse right button. .. note:: When the data-defined override option is setup correctly the icon is yellow |dataDefineOn| or |dataDefineExpressionOn|; if it is broken, the icon is red |dataDefineError| or |dataDefineExpressionError|. .. index:: single: Identify features .. _`identify`: Identify Features ================= The Identify tool allows you to interact with the map canvas and get information on features in a pop-up window. To identify features, use: * :menuselection:`View --> Identify Features` menu, * or press :kbd:`Ctrl + Shift + I` (or |osx| :kbd:`Cmd + Shift + I`), * or click the |identify| :sup:`Identify Features` icon on the Attributes toolbar. Using the Identify Features tool --------------------------------- QGIS offers two ways to identify features with the |identify| :sup:`Identify Features` tool: * **left click** will identify features according to the mode set in the :guilabel:`Identify Results` panel * **right click** will fetch all the snapped features from all the visible layers. This will open a context menu, allowing the user to choose more precisely the features to identify. .. tip:: **Filter the layers to query with the Identify Features tool** Uncheck the :guilabel:`Identifiable` column in :menuselection:`Project -->` (or |kde| :menuselection:`Settings -->`), :menuselection:`Project Properties --> Identify layers` menu in front of a layer to avoid it being queried when using the |identify| :sup:`Identify Features` in a mode other than **Current Layer**. This is a handy way to return features from only layers that are of interest for you. If you click on feature(s), the :guilabel:`Identify Results` dialog will list information about the clicked feature(s). The default view is a tree view where the first item is the name of the layer and its children are its identified feature(s). Each feature is described by the name of a field along with its value. This field is the one set in :menuselection:`Layer Properties --> Display`. Then follows all the other information about the feature. Feature informations --------------------- The Identify Results dialog can be customized to display custom fields, but by default it will display three kinds of information: .. index:: Actions * **Actions**: Actions can be added to the identify feature windows. The action is run by clicking on the action label. By default, only one action is added, namely ``View feature form`` for editing. You can define more actions in the layer's properties dialog (see :ref:`actions_menu`). * **Derived**: This information is calculated or derived from other information. This includes: * general information about the feature and its geometry: feature id, length or perimeter and area in map units depending on its geometry, the count of spatial parts and the number of the clicked part in case of multi-geometry, the count of vertices in the feature and the number of the closest one to the point clicked * coordinates information: the X and Y (and Z/M if available) coordinate values of the clicked point, the feature closest vertex and its first and last vertices. In case you click on a curved line using the info tool, QGIS will also display the radius of that section in the panel result. * **Data attributes**: This is the list of attribute fields and values for the feature that has been clicked. .. note:: Links in feature's attributes are clickable from the :guilabel:`Identify Results` panel and will open in your default web browser. .. _figure_identify: .. figure:: /static/user_manual/introduction/identify_features.png :align: center Identify Results dialog The Identify Results dialog ---------------------------- At the top of the window, you have seven icons: * |expandTree| :sup:`Expand tree` * |collapseTree| :sup:`Collapse tree` * |expandNewTree| :sup:`Default behavior` to define whether next identified features information should be collapsed or expanded * |propertyItem| :sup:`View the feature form` * |deselectAll| :sup:`Clear Results` * |editCopy| :sup:`Copy selected feature to clipboard` * |filePrint| :sup:`Print selected HTML response` At the bottom of the window, you have the :guilabel:`Mode` and :guilabel:`View` comboboxes. With the :guilabel:`Mode` combobox you can define from which layers features should be identified: * **Current layer** : only features from the selected layer are identified. The layer may not be visible in the canvas. * **Top down, stop at first**: for only features from the upper visible layer. * **Top down**: for all features from the visible layers. The results are shown in the panel. * and **Layer selection**: opens a context menu where the user selects the layer to identify features from. Operates like a right-click. Only the chosen features will be shown in the result panel. .. note:: **Identify tool configuration** You can configure the identify feature in :menuselection:`Project --> Project Properties` in the :guilabel:`Identify layers` tab. The table allows user to select layer(s) that can be used by this tool to identify features (column :guilabel:`Identifiable`). You can also put this layer in read-only mode with the checkbox in the last column. The :guilabel:`View` can be set as **Tree**, **Table** or **Graph**. 'Table' and 'Graph' views can only be set for raster layers. The identify tool allows you to |checkbox|:guilabel:`Auto open a form`. If checked, each time a single feature is identified QGIS will open a form showing its attributes. This is a handy way to quickly edit a feature's attributes. Other functions can be found in the context menu of the identified item. For example, from the context menu you can: * View the feature form * Zoom to feature * Copy feature: Copy all feature geometry and attributes * Toggle feature selection: Adds identified feature to selection * Copy attribute value: Copy only the value of the attribute that you click on * Copy feature attributes: Copy the attributes of the feature * Clear result: Remove results in the window * Clear highlights: Remove features highlighted on the map * Highlight all * Highlight layer * Activate layer: Choose a layer to be activated * Layer properties: Open layer properties window * Expand all * Collapse all .. index:: single: Annotation .. _sec_annotations: Annotation Tools ================ The |textAnnotation| :sup:`Text Annotation` tool in the attribute toolbar provides the possibility to place formatted text in a balloon on the QGIS map canvas. Use the :guilabel:`Text Annotation` tool and click into the map canvas. .. _figure_annotation: .. figure:: /static/user_manual/introduction/annotation.png :align: center Annotation text dialog Double clicking on the item opens a dialog with various options. There is the text editor to enter the formatted text and other item settings. For instance, there is the choice of having the item placed on a map position (displayed by a marker symbol) or to have the item on a screen position (not related to the map). The item can be moved by map position (by dragging the map marker) or by moving only the balloon. The icons are part of the GIS theme, and they are used by default in the other themes, too. The |annotation| :sup:`Move Annotation` tool allows you to move the annotation on the map canvas. Html annotations ---------------- The |formAnnotation| :sup:`Html Annotation` tools in the attribute toolbar provides the possibility to place the content of an html file in a balloon on the QGIS map canvas. Using the :guilabel:`Html Annotation` tool, click into the map canvas and add the path to the html file into the dialog. SVG annotations --------------- The |saveAsSVG| :sup:`SVG Annotation` tool in the attribute toolbar provides the possibility to place an SVG symbol in a balloon on the QGIS map canvas. Using the :guilabel:`SVG Annotation` tool, click into the map canvas and add the path to the SVG file into the dialog. Form annotations ---------------- .. index::`annotations` .. index::`form annotation|\see{annotations}` Additionally, you can also create your own annotation forms. The |formAnnotation| :sup:`Form Annotation` tool is useful to display attributes of a vector layer in a customized Qt Designer form (see figure_custom_annotation_). This is similar to the designer forms for the :guilabel:`Identify features` tool, but displayed in an annotation item. Also see this video https://youtu.be/0pDBuSbQ02o?t=2m25s from Tim Sutton for more information. .. _figure_custom_annotation: .. figure:: /static/user_manual/introduction/custom_annotation.png :align: center Customized qt designer annotation form .. note:: If you press :kbd:`Ctrl+T` while an :guilabel:`Annotation` tool is active (move annotation, text annotation, form annotation), the visibility states of the items are inverted. .. index:: single: Bookmarks see: Spatial bookmarks; Bookmarks .. _`sec_bookmarks`: Spatial Bookmarks ================= Spatial Bookmarks allow you to "bookmark" a geographic location and return to it later. By default, bookmarks are saved on the computer, meaning that they are available from any project in the same computer. If you wish to store the bookmark in the project file (:file:`.qgs`) then you can do this by selecting the :guilabel:`In Project` checkbox. Creating a Bookmark ------------------- To create a bookmark: #. Zoom or pan to the area of interest. #. Select the menu option :menuselection:`View --> New Bookmark` or press :kbd:`Ctrl-B`. The Spatial Bookmark panel opens with the newly created bookmark. #. Enter a descriptive name for the bookmark (up to 255 characters). #. Check the :guilabel:`In Project` box if you wish to save the bookmark in the project file. #. Press :kbd:`Enter` to add the bookmark or click elsewhere. Note that you can have multiple bookmarks with the same name. Working with Bookmarks ---------------------- To use or manage bookmarks, select the menu option :menuselection:`View --> Show Bookmarks`. The :guilabel:`Spatial Bookmarks` panel allows you to: * Zoom to a Bookmark: select the desired bookmark and then click :guilabel:`Zoom To Bookmark`. You can also zoom to a bookmark by double-clicking on it. * Delete a Bookmark: select the bookmark and click :guilabel:`Delete Bookmark`. Confirm your choice. * Import or Export a bookmark: To share or transfer your bookmarks between computers you can use the :guilabel:`Import/Export Bookmarks` pull down menu in the :guilabel:`Spatial Bookmarks` dialog. All the bookmarks are transferred. .. index:: Nesting projects, Embed layers and groups .. _nesting_projects: Nesting Projects ================ Sometimes, you'd like to keep in different projects a bunch of layers with the same style. You can either create a :ref:`default style ` for these layers or embed them from another project to save you tons of work. Embed layers and groups from an existing project has some advantages over styling: * all types of layers (vector or raster, local or online...) can be added * fetching groups and layers, you can keep the same tree structure of the "background" layers in your different projects * While the embedded layers are editable, you can't change their properties such as symbology, labels, forms, default values, actions... This ensures homogeneity throughout the projects * modify the items in the original project and changes are propagated to all the other projects. If you want to embed content from other project files into your project, select :menuselection:`Layer --> Embed Layers and Groups` and: #. Press |browseButton| to look for a project; you can see the content of the project (see figure_embed_dialog_). #. Press :kbd:`Ctrl` ( or |osx| :kbd:`Cmd`) and click on the layers and groups you wish to retrieve. #. Press **[OK]**. The selected layers and groups are embedded in the Layer panel and can be visualized in the map canvas now. Names of embedded items appear in italic to distinguish them from regular layers and groups. .. _figure_embed_dialog: .. figure:: /static/user_manual/introduction/embed_dialog.png :align: center Select layers and groups to embed Like any other layer, an embedded layer can be removed from the project by right-click on the layer and choose |removeLayer| :sup:`Remove`. .. tip:: **Change rendering of an embedded layer** It's not possible to change rendering of an embedded layer, unless you make the changes in the original project file. However, right-click on a layer and select :guilabel:`Duplicate` creates a layer which is fully-featured and not dependent to the original project. You can then safely remove the linked layer. .. index:: Decorations .. _decorations: Decorations =========== The Decorations of QGIS include the Grid, the Copyright Label, the North Arrow and the Scale Bar. They are used to 'decorate' the map by adding cartographic elements. .. index:: Grid .. _grid_decoration: Grid ---- |transformed| :sup:`Grid` allows you to add a coordinate grid and coordinate annotations to the map canvas. .. _figure_decorations_grid: .. figure:: /static/user_manual/introduction/grid_dialog.png :align: center The Grid Dialog #. Select from menu :menuselection:`View --> Decorations --> Grid`. The dialog starts (see figure_decorations_grid_). #. Activate the |checkbox| :guilabel:`Enable grid` checkbox and set grid definitions according to the layers loaded in the map canvas. #. Activate the |checkbox| :guilabel:`Draw annotations` checkbox and set annotation definitions according to the layers loaded in the map canvas. #. Click **[Apply]** to verify that it looks as expected or **[OK]** if you're satisfied. .. index:: Copyright .. _copyright_decoration: Copyright Label --------------- |copyrightLabel| :sup:`Copyright label` adds a copyright label using the text you prefer to the map. .. _figure_decorations_copyright: .. figure:: /static/user_manual/introduction/copyright.png :align: center The Copyright Dialog #. Select from menu :menuselection:`View --> Decorations --> Copyright Label`. The dialog starts (see figure_decorations_copyright_). #. Make sure the |checkbox| :guilabel:`Enable Copyright Label` checkbox is checked. #. Enter the text you want to place on the map. You can use HTML as shown in the example. #. Choose the placement of the label from the :guilabel:`Placement` |selectString| combo box. #. You can refine the placement of the item by setting a Horizontal and/or Vertical `Marging from (Canvas) Edge`. These values can be a distance in **Millimeter** or **Pixels** or set as **Percentage** of the width or height of the map canvas. #. You can change the color to apply. #. Click **[Apply]** to verify that it looks as expected or **[OK]** if you're satisfied. In the example above, which is the default, QGIS places a copyright symbol followed by the date in the lower right-hand corner of the map canvas. .. index:: North arrow .. _northarrow_decoration: North Arrow ----------- |northArrow| :sup:`North Arrow` places a simple north arrow on the map canvas. Currently, there is only one style available. You can adjust the angle of the arrow or let QGIS set the direction automatically. If you choose to let QGIS determine the direction, it makes its best guess as to how the arrow should be oriented. For placement of the arrow, you have four options, corresponding to the four corners of the map canvas. You can refine the placement of the arrow by setting a Horizontal and/or Vertical `Marging from (Canvas) Edge`. These values can be a distance in **Millimeter** or **Pixels** or set as **Percentage** of the width or height of the map canvas. .. _figure_decorations_north: .. figure:: /static/user_manual/introduction/north_arrow_dialog.png :align: center The North Arrow Dialog .. index:: Scale bar .. _scalebar_decoration: Scale Bar --------- |scaleBar| :sup:`Scale Bar` adds a simple scale bar to the map canvas. You can control the style and placement, as well as the labelling of the bar. .. _figure_decorations_scale: .. figure:: /static/user_manual/introduction/scale_bar_dialog.png :align: center The Scale Bar Dialog QGIS only supports displaying the scale in the same units as your map frame. So if the units of your layers are in meters, you can't create a scale bar in feet. Likewise, if you are using decimal degrees, you can't create a scale bar to display distance in meters. To add a scale bar: #. Select from menu :menuselection:`View --> Decorations --> Scale Bar`. The dialog starts (see figure_decorations_scale_). #. Make sure the |checkbox| :guilabel:`Enable scale bar` checkbox is checked. #. Choose the style from the :guilabel:`Scale bar style` |selectString| combo box. #. Select the color for the bar :guilabel:`Color of bar` |selectColor| or use the default black color. #. Set the :guilabel:`Size of bar` |selectNumber|. #. Optionally, check |checkbox| :guilabel:`Automatically snap to round number on resize` to display values easy-to-read. #. Choose the placement from the :guilabel:`Placement` |selectString| combo box. #. You can refine the placement of the item by setting a Horizontal and/or Vertical `Marging from (Canvas) Edge`. These values can be a distance in **Millimeter** or **Pixels** or set as **Percentage** of the width or height of the map canvas. #. Click **[Apply]** to verify that it looks as expected or **[OK]** if you're satisfied. .. tip:: **Settings of Decorations** When you save a :file:`.qgs` project, any changes you have made to Grid, North Arrow, Scale Bar and Copyright will be saved in the project and restored the next time you load the project. .. _authentication: Authentication ============== QGIS has facility to store/retrieve authentication credentials in a secure manner. Users can securely save credentials into authentication configurations, which are stored in a portable database, can be applied to server or database connections, and safely referenced by their ID tokens in project or settings files. For more information see :ref:`authentication_index`. A master password needs to be set up when initializing the authentication system and its portable database. .. index:: Variables, Expressions .. _`general_tools_variables`: Variables ========= In QGIS, you can use variables to store useful recurrent values (e.g. the project's title, or the user's full name) that can be used in expressions. Variables can be defined at the application's global level, project level, layer level, composition level, and composer's item level. Just like CSS cascading rules, variables can be overwritten - e.g., a project level variable will overwrite any application's global level variables set with the same name. You can use these variables to build text strings or other custom expressions using the @ character before the variable name. For example in composer creating a label with this content:: This map was made using QGIS [% @qgis_version %]. The project file for this map is: [% @project_path %] Will render the label like this:: This map was made using QGIS 2.14. The project file for this map is: /gis/qgis-user-conference-2015.qgs Besides the :ref:`preset read-only variables `, you can define your own custom variables for any of the levels mentioned above. You can manage: * **global variables** from the :menuselection:`Settings --> Options` menu; * **project's variables** from :guilabel:`Project properties` (see :ref:`project_properties`); * **vector layer's variables** from the :guilabel:`Layer Properties` dialog (see :ref:`vector_properties_dialog`); * **composition's variables** from the :guilabel:`Composition` panel in the Print composer (see :ref:`composer_composition_tab`); * and **composer item's variables** from the :guilabel:`Item properties` panel in the Print composer (see :ref:`composer_item_options`). To differentiate from editable variables, read-only variable's names and values are emphasized in italic. On the other hand, higher level variables overwritten by lower level ones are strike through. .. _figure_variables_dialog: .. figure:: /static/user_manual/introduction/options_variables.png :align: center Variables editor at the project's level .. note:: You can read more about variables and find some examples in Nyall Dawson's `Exploring variables in QGIS 2.12, part 1 `_, `part 2 `_ and `part 3 `_ blog posts.