Skip to content

Commit

Permalink
doc for enum rowtype
Browse files Browse the repository at this point in the history
  • Loading branch information
Luna Li committed Oct 26, 2023
1 parent c586b24 commit 653e21d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/developer-documentation/components/LogView.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ This component contains the table that shows the content of the log. Each row sh
| `onLogViewStateChanged` | `function` | A function to update logview state to the parent component |
| `onSelectedRowsChanged` | `function` | A function to pass the selected row to the parent component when it is changed |
| `onRowPropsChanged` | `function` | A function to pass the property of the row when it is changed |
| `forwardRef` | `React.RefObject<HTMLDivElement>` | `A ref object for update the scrolling between log view and minimap` |
| `coloredTable` | `boolean` | `boolean for switching the colored table On/Off` |
| `rowProperties` | `RowProperty[]` | `A interface to keep all the row related properties` |
| `currentStructureMatch` | `number[]` | `The current selected structure` |
| `structureMatches` | `number[][]` | `All the matched structures` |
| `structureMatchesLogRows` | `number[]` | `The row number of all the matched structures` |
| `collapsibleRows` | `{ [key: number]: Segment }` | `A map for the segment annotation, the key is the number of row where the segment starts, the value is the interface Segment contains the start row, end row and the nested level` |
| `clearSegmentation` | `function` | `A function to delete all the segmentations` |
| `forwardRef` | `React.RefObject<HTMLDivElement>` | A ref object for update the scrolling between log view and minimap |
| `coloredTable` | `boolean` | boolean for switching the colored table On/Off |
| `rowProperties` | `RowProperty[]` | A interface to keep all the row related properties |
| `currentStructureMatch` | `number[]` | The current selected structure |
| `structureMatches` | `number[][]` | All the matched structures |
| `structureMatchesLogRows` | `number[]` | The row number of all the matched structures |
| `collapsibleRows` | `{ [key: number]: Segment }` | A map for the segment annotation, the key is the number of row where the segment starts, the value is the interface Segment contains the start row, end row and the nested level |
| `clearSegmentation` | `function` | A function to delete all the segmentations |

## State

Expand Down
15 changes: 15 additions & 0 deletions docs/developer-documentation/constants/enums/SelectedRowType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

---
```TS
enum SelectedRowType {
None = "NONE",
UserSelect = "SELECTED",
QueryResult = "QUERY_RESULT",
}
```

This `enum` is used for the Structure Matching functionality to indicate if the row is selected by the user.

`NONE` if the row is not selected;
`SELECTED` if the row is selected by the user;
`QUERY_RESULT` it is not used yet.

0 comments on commit 653e21d

Please sign in to comment.