Plot Library
  1. Miscellaneous
  2. Functions

Index

lib/utils/plot.utils.ts

addValidators
addValidators(formGroup: FormGroup)

Add validators to plot settings.

Parameters :
Name Type Optional
formGroup FormGroup No
Returns : void
createLayout
createLayout(plotOptions: DefaultPlotOptions, options: PlotOptions, defaultLayout: Partial, defaultAxis: Partial)

Returns the layout for Plotly.

Parameters :
Name Type Optional Description
plotOptions DefaultPlotOptions No

The default plot options
options PlotOptions No

The plot options
defaultLayout Partial No

Default layout
defaultAxis Partial No

Default axis options
Returns : Partial<PlotlyLayout>
defaultPlot
defaultPlot(plotOptions: DefaultPlotOptions)

Returns a generic Plotly plot.

Parameters :
Name Type Optional Description
plotOptions DefaultPlotOptions No

The plot options
Returns : PlotlyPlot
plotDataToTableData
plotDataToTableData(plot: NshmpPlot, params: PlotTableDataParams)

Returns the table data corresponding to a plot.

Parameters :
Name Type Optional Default value Description
plot NshmpPlot No

The nshmp plot
params PlotTableDataParams No plotTableDataParams

The transform options
Returns : TableData[]
plotlyLayoutToSettings
plotlyLayoutToSettings(layout: Partial)

Convert the Plotly layout to application plot layout settings.

Parameters :
Name Type Optional Description
layout Partial No

The plotly layout
Returns : LayoutSettings
plotSettingsToFormGroup
plotSettingsToFormGroup(settings: NshmpPlotSettings)

Convert plot settings to a form group.

Parameters :
Name Type Optional Description
settings NshmpPlotSettings No

The NSHMp plot settings
Returns : FormGroup<NshmpPlotSettingFormGroup>
updateAppPlotSettings
updateAppPlotSettings(plots: Map)

Update the application plot settings based on the Plotly layout settings.

For generally updating the xLabel and yLabel based on service response.

Parameters :
Name Type Optional Description
plots Map No

The map of plots
Returns : Map<string, NshmpPlot>
updatePlotLabels
updatePlotLabels(props: UpdatePlotLabelsProps)

Update plot labels.

Parameters :
Name Type Optional Description
props UpdatePlotLabelsProps No

The function properties
Returns : Partial<PlotlyLayout>

results matching ""

    No results matching ""