Dm 9164 add lc help links #317
Conversation
| @@ -268,7 +272,7 @@ class PeriodogramOptionsBox extends Component { | |||
| </button> | |||
| <br/> | |||
| <div style={{marginTop: 10}}> | |||
| {'Leave the fields blank to use default values.'} <HelpIcon helpId={'periodogram.options'}/> | |||
| {'Leave the fields blank to use default values.'} <HelpIcon helpId={'findpTSV.pgramresults'}/> | |||
There was a problem hiding this comment.
this icon position could be adjusted to the lower right corner of the option panel, or line up with the "Periodogram Calculation" button
| @@ -143,9 +143,9 @@ export function getDefaultXYPlotOptions(tbl_id) { | |||
| * @param {string} params.tblId - table id | |||
| * @param {Function} [params.dispatcher=flux.process] - only for special dispatching uses such as remote | |||
| */ | |||
| export function loadXYPlot({chartId, xyPlotParams, tblId, dispatcher=flux.process}) { | |||
| export function loadXYPlot({chartId, xyPlotParams, help_id, tblId, dispatcher=flux.process}) { | |||
There was a problem hiding this comment.
Parameter help_id added without updating jsdoc.
There was a problem hiding this comment.
Will add it before merging. Good point!
| @@ -37,13 +37,14 @@ export class TablesContainer extends Component { | |||
| } | |||
|
|
|||
| nextState(props) { | |||
| var {mode, tbl_group, closeable} = props; | |||
| var {mode, tbl_group, closeable, tableOptions} = props; | |||
There was a problem hiding this comment.
I think it should take help_id similar to other components, not tableOptions.
There was a problem hiding this comment.
Well, i add it this way because you could add height, width, etc to it also.
| } else { | ||
| return ( | ||
| <Tabs defaultSelected={activeIdx} onTabSelect={onTabSelect} resizable={true}> | ||
| {tablesAsTab(tables, expandedMode)} | ||
| {tablesAsTab(tables, tableOptions, expandedMode)} |
There was a problem hiding this comment.
help_id can be passed on to TabPanel, which should also take help_id.
| @@ -203,7 +203,7 @@ function updatePhaseTableChart(flux) { | |||
| x: {columnOrExpr: LC.PHASE_CNAME, options: 'grid'}, | |||
| y: {columnOrExpr: flux, options: 'grid,flip'} | |||
| }; | |||
| loadXYPlot({chartId: LC.PHASE_FOLDED, tblId: LC.PHASE_FOLDED, xyPlotParams}); | |||
| loadXYPlot({chartId: LC.PHASE_FOLDED, tblId: LC.PHASE_FOLDED, xyPlotParams, help_id: 'main1TSV.plot'}); | |||
There was a problem hiding this comment.
Instead of passing the same help_id into the individual chart, it should be passed into ChartContainer.
Although in this case, it may appear the same.
There was a problem hiding this comment.
This would require a major refactoring. Chart is expecting the help_id from the dispatcher. We can talk to @tgoldina and make a separate ticket for the future.
|
The new placement of the help icons looks much better. Thanks for the fix. |
I've added the help links as discussed during the review. Luisa has been writing the docs that can be found in the wiki. See ticket in JIRA.
To test, checkout and build the branch. Then go to .../firefly/ts.html.