Skip to content

Commit

Permalink
Merge pull request #41 from plantinformatics/develop
Browse files Browse the repository at this point in the history
to add feature search to documentation
  • Loading branch information
gabrielkg authored Nov 7, 2024
2 parents 178ead2 + 96a0d1c commit c1ec653
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/Basic-Functions/Feature-search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Feature search

!!!note

Feature search is case-sensitive, and the user needs to enter the full feature name for the search to work.

## Search

From the Map Viewer tab, click on the Search tab, scroll down to Feature Search, paste the full Feature name in the search box and select Search. For instance:
```
AVRIG33950
IWB31543
```
![Search (1)](https://github.com/user-attachments/assets/478b157c-f607-4f3e-8116-36fa04e0f1b7)

## View results

The search results and the total number of hits will be displayed under the Feature Search box. To view the results, click the green plus icon on the left side of each hit. Users can view the results simultaneously across all hits. The feature will be represented as a blue arrow, and the feature name can be displayed or removed by clicking on the arrow.

![View results (1)](https://github.com/user-attachments/assets/ab590a89-de94-45b7-867c-0724b682b592)

## Adding or Removing feature names

1. To add additional features, input the feature names and hit search again.

```
AVRIG33950
IWB31543
IWB65513
```

![Adding features](https://github.com/user-attachments/assets/ab9e781f-a8fa-474e-bc9d-2c17bbd775d1)

2. To remove a displayed feature, simply remove the feature name from the input list and click search again.

![Remove features (1)](https://github.com/user-attachments/assets/58283bca-355b-4ee0-84e1-19dfefa6526d)

## To view features between specified features

Brush the axes between the features, and select the Features tab on the right side. All features will be displayed in a table format.

![To view features between specified features (1)](https://github.com/user-attachments/assets/3aff178b-6817-46b2-a299-678cf7d25a31)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ nav:
- Basic-Functions/Moving-axes.md
- Basic-Functions/BLAST-search.md
- Basic-Functions/Axis-flip-orientation.md
- Basic-Functions/Feature-search.md

- Local Setup:
- Local-Setup/setup.md
Expand Down

0 comments on commit c1ec653

Please sign in to comment.