Skip to content

fixing incorrect info in preferences panels table #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fixing incorrect info in preferences panels table #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95ecf1a
dependencies fix
tomlebl Apr 8, 2022
78dd475
fixing incorect info in preferences panels table
tomlebl Apr 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 53 additions & 57 deletions docs/80_for-developers/10_include-react-component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,71 +16,67 @@ function MyComponent() {

## Component props

| Name | Type | Default | Description |
| -----------------------| ------------------------|--------------------------|--------------------------------------------------------------------------------------------------------|
| docsBaseUrl | String | https://docs.nmrium.org | Documentation base url |
| onDataChange | Function():Object | | This callback function will be called when change data in nmrium component |
| preferences | Object | | Customize what tools and panels that can be used or displayed,see table below |
| data | Object | { spectra: [] } | NMRium data |
| emptyText | Object | | Customize text when no data |
| workspace | String | default | Customize Nmrium based on predefined workspaces, one of default, process1D, exercise, prediction |
| getSpinner | Function():ReactElement | Default spinner | Customize spinner component |



| Name | Type | Default | Description |
| ------------ | ----------------------- | ----------------------- | ------------------------------------------------------------------------------------------------ |
| docsBaseUrl | String | https://docs.nmrium.org | Documentation base url |
| onDataChange | Function():Object | | This callback function will be called when change data in nmrium component |
| preferences | Object | | Customize what tools and panels that can be used or displayed,see table below |
| data | Object | { spectra: [] } | NMRium data |
| emptyText | Object | | Customize text when no data |
| workspace | String | default | Customize Nmrium based on predefined workspaces, one of default, process1D, exercise, prediction |
| getSpinner | Function():ReactElement | Default spinner | Customize spinner component |

### preferences

| Name | Type | Default | Description |
| -----------------------| ---------------|--------------------------|---------------------------------------------------------------------------|
| general | Object | | Customize general tools and features, see table below |
| panels | Object | | Customize which panels to display, see table below |
| toolBarButtons | Object | | Customize which tools can be used, see table below |
| Name | Type | Default | Description |
| -------------- | ------ | ------- | ----------------------------------------------------- |
| general | Object | | Customize general tools and features, see table below |
| panels | Object | | Customize which panels to display, see table below |
| toolBarButtons | Object | | Customize which tools can be used, see table below |

#### general

| Name | Type | Default | Description |
| -----------------------------| ---------------|--------------------------|---------------------------------------------------------------------------|
| disableMultipletAnalysis | Boolean | false | Whether can use myltiple analysis feature |
| hideSetSumFromMolecule | Boolean | false | Whether can set the sum from molecule |
| hideGeneralSettings | Boolean | false | Whether can open general settings or not |
| Name | Type | Default | Description |
| ------------------------ | ------- | ------- | ----------------------------------------- |
| disableMultipletAnalysis | Boolean | false | Whether can use myltiple analysis feature |
| hideSetSumFromMolecule | Boolean | false | Whether can set the sum from molecule |
| hideGeneralSettings | Boolean | false | Whether can open general settings or not |

#### panels

| Name | Type | Default | Description |
| -------------------------------| ---------------|-----------------------------------------------|----------------------------------------------------|
| spectraPanel | Object | {display: true,open: true ,hidden: false} | Show/Hide Spectra panel |
| informationPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Information panel |
| peaksPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Peaks panel |
| integralsPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Integrals panel |
| rangesPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Ranges panel |
| structuresPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Structures panel |
| filtersPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Filters panel |
| zonesPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Zones panel |
| summaryPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Summary panel |
| multipleSpectraAnalysisPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Multiple Spectra Analysis panel |
| databasePanel | Object | {display: true,open: false,hidden: false} | Show/Hide Database panel |
| predictionPanel | Object | {display: true,open: false,hidden: false} | Show/Hide Prediction panel |
#### toolBarButtons
| Name | Type | Default | Description |
| -------------------------------- | ------- | ------- | ----------------------------------------- |
| hideSpectraPanel | Boolean | false | Show/Hide Spectra panel |
| hideInformationPanel | Boolean | false | Show/Hide Information panel |
| hidePeaksPanel | Boolean | false | Show/Hide Peaks panel |
| hideIntegralsPanel | Boolean | false | Show/Hide Integrals panel |
| hideRangesPanel | Boolean | false | Show/Hide Ranges panel |
| hideStructuresPanel | Boolean | false | Show/Hide Structures panel |
| hideFiltersPanel | Boolean | false | Show/Hide Filters panel |
| hideZonesPanel | Boolean | false | Show/Hide Zones panel |
| hideSummaryPanel | Boolean | false | Show/Hide Summary panel |
| hideMultipleSpectraAnalysisPanel | Boolean | false | Show/Hide Multiple Spectra Analysis panel |
| hideDatabasePanel | Boolean | false | Show/Hide Database panel |

| Name | Type | Default | Description |
| ---------------------------------| ---------------|--------------------------|---------------------------------------------------------------------------|
| hideZoomTool | Boolean | false | Specify whether can zoom in |
| hideZoomOutTool | Boolean | false | Specify whether can full zoom out |
| hideImport | Boolean | false | Specify whether can import from system files and remote url |
| hideExportAs | Boolean | false | Specify whether can export data to various extentions |
| hideSpectraStackAlignments | Boolean | false | Specify whether can align the spectra in a stack |
| hideSpectraCenterAlignments | Boolean | false | Specify whether can align the spectra in the center |
| hideRealImaginary | Boolean | false | Specify whether can switch display between imaginary and real spectrum |
| hidePeakTool | Boolean | false | Specify whether can peaks picking ( manual and automatic picking ) |
| hideIntegralTool | Boolean | false | Specify whether can add integral manually |
| hideZonePickingTool | Boolean | false | Specify whether can zones picking ( manual and automatic picking) |
| hideSlicingTool | Boolean | false | Specify whether can use slicing tool |
| hideAutoRangesTool | Boolean | false | Specify whether can ranges picking ( manual and automatic picking ) |
| hideZeroFillingTool | Boolean | false | Specify whether can apply Zero Filling filter |
| hidePhaseCorrectionTool | Boolean | false | Specify whether can apply Phase Correction filter |
| hideBaseLineCorrectionTool | Boolean | false | Specify whether can apply Base Line Correction filter |
| hideFFTTool | Boolean | false | Specify whether can apply Fourier Transform filter |
| hideMultipleSpectraAnalysisTool | Boolean | false | Specify whether can use multiple spectr anaysis tool |
| hideExclusionZonesTool | Boolean | false | Specify whether can define exclusive zones |
#### toolBarButtons

| Name | Type | Default | Description |
| ------------------------------- | ------- | ------- | ---------------------------------------------------------------------- |
| hideZoomTool | Boolean | false | Specify whether can zoom in |
| hideZoomOutTool | Boolean | false | Specify whether can full zoom out |
| hideImport | Boolean | false | Specify whether can import from system files and remote url |
| hideExportAs | Boolean | false | Specify whether can export data to various extentions |
| hideSpectraStackAlignments | Boolean | false | Specify whether can align the spectra in a stack |
| hideSpectraCenterAlignments | Boolean | false | Specify whether can align the spectra in the center |
| hideRealImaginary | Boolean | false | Specify whether can switch display between imaginary and real spectrum |
| hidePeakTool | Boolean | false | Specify whether can peaks picking ( manual and automatic picking ) |
| hideIntegralTool | Boolean | false | Specify whether can add integral manually |
| hideZonePickingTool | Boolean | false | Specify whether can zones picking ( manual and automatic picking) |
| hideSlicingTool | Boolean | false | Specify whether can use slicing tool |
| hideAutoRangesTool | Boolean | false | Specify whether can ranges picking ( manual and automatic picking ) |
| hideZeroFillingTool | Boolean | false | Specify whether can apply Zero Filling filter |
| hidePhaseCorrectionTool | Boolean | false | Specify whether can apply Phase Correction filter |
| hideBaseLineCorrectionTool | Boolean | false | Specify whether can apply Base Line Correction filter |
| hideFFTTool | Boolean | false | Specify whether can apply Fourier Transform filter |
| hideMultipleSpectraAnalysisTool | Boolean | false | Specify whether can use multiple spectr anaysis tool |
| hideExclusionZonesTool | Boolean | false | Specify whether can define exclusive zones |
Loading