Augmentation Preferences
In MetricsOverlay, augmentations provide the visual features of the overlay.
Augmentation preferences can be set up by accessing the appropriate preference page.
This can be achieved in three ways:
- Window → Preferences → MetricsOverlay → Augmentations
- Opening the Metrics Overlay view, and clicking on the cog-like icon
(
) to open the Preference Page,
then clicking Augmentations.
- While looking at an active augmentation, click on the appropriate Augmentation
cell and then follow the edit button.
A raft of options are available for customising your own augmentation types on this
page. This page details the use of all of these controls.
- At the top of the page is a drop down menu, use if you want to either edit the
details of an existing augmentation or use the details of an existing modification to
create a new one.
- All of the controls for modifying/creating an augmentation are contained within the
large group labelled Add/Edit Augmentation.
- Augmentation Name: This text field allows the unique name of the augmentation
to be defined. This must be changed if you wish to add a new augmentation.
- Augmentation Type: This drop down box details the available augmentation
types. Note if you wish to modify and augmentation, you may not change this type. It is
suggested that you create a new augmentation if you wish to do this. Certain augmentation
have specialised controls that appear when the appropriate type
is selected. The available types of augmentations are:
- Underline Augmentation - Provides an augmentation that underlines source code in
some fashion. A special option of choosing the type of underline is provided.
- Background Section Augmentation - Provides background coloring of a defined section
of the text.
- Background Line Augmentation - Colors the entire background of a line.
- Margin Augmentation - Provides a margin chip, options are provided to change the
shape and its direction, plus the ability to change its position.
None of these options will affect the existing selection highlighting, syntax colouring
or auto-complete options.
- Importance: This slider allows the importance of an augmentation to be
set, this provides a modification to its rendering order. If you wish an item to be
displayed in a primary position, give its appropriate augmentation a higher importance.
- Toggle Annotation: This check box turns on/off any annotations that
have been defined for this augmentation.
- Discrete: Determines whether the colour preferences are to be discrete
or in an interpolated spectrum.
- Color Editor: This editor provides the functionality to change the
colors in use by the augmentation. Buttons are provided to change the values,
add and remove items and change the order of items in the provided list.
A series of buttons provide the ability to manage your augmentations:
- Add New...: This button allows a new augmentation to be added. Please
make sure that the name is unique.
- Update Existing: This button allows the current augmentation to be updated.
Please do not change the name or type.
- Remove Existing: If you have not changed the name of the current
augmentation, this button will remove it.
Note, these buttons may make some of your current mappings invalid.