Plot Library
  1. Interfaces
  2. DefaultPlotOptions

File

lib/models/default-plot-options.model.ts

Description

The default plot options.

Index

Properties

Properties

id
id: string
Type : string

Plot id
mobileOptions
mobileOptions: PlotOptions
Type : PlotOptions
Optional

Plot config and layout options for mobile devices
options
options: PlotOptions
Type : PlotOptions
Optional

Plot config and layout options
panelBreakpoint
panelBreakpoint: number
Type : number
Optional

Breapoint to use mobile settings
title
title: string
Type : string

Plot title
xLabel
xLabel: string
Type : string

X label
yLabel
yLabel: string
Type : string

Y label

 
import {PlotlyConfig, PlotlyLayout} from '@ghsc/nshmp-utils-ts/libs/plotly';

/**
 * The default plot options.
 */
export interface DefaultPlotOptions {
  /** Plot id */
  id: string;
  /** Plot title */
  title: string;
  /** X label */
  xLabel: string;
  /** Y label */
  yLabel: string;

  /** Plot config and layout options for mobile devices */
  mobileOptions?: PlotOptions;
  /** Plot config and layout options */
  options?: PlotOptions;
  /** Breapoint to use mobile settings */
  panelBreakpoint?: number;
}

/**
 * Plotly config and layout options.
 */
export interface PlotOptions {
  /** Plotly config */
  config?: PlotlyConfig;
  /** Plotly layout */
  layout?: PlotlyLayout;
}

results matching ""

    No results matching ""