Plot Library
  1. Interfaces
  2. PlotTableDataParams

File

lib/models/plot-table-data-params.model.ts

Description

Options and functions to apply when converting plot data to table data.

Index

Properties

Properties

addLabel
addLabel: boolean
Type : boolean
Optional

Whether to add the plot label to data table
hideX
hideX: boolean
Type : boolean
Optional

Whether to hide X values
hideY
hideY: boolean
Type : boolean
Optional

Whether to hide Y values
labelTransform
labelTransform: function
Type : function
Optional

Function to apply to the plot label
xLabelTransform
xLabelTransform: function
Type : function
Optional

Function to apply to the X label
xValueFormat
xValueFormat: function
Type : function
Optional

Function to apply to X values
yLabelTransform
yLabelTransform: function
Type : function
Optional

Function to apply to the Y label
yValueFormat
yValueFormat: function
Type : function
Optional

Function to apply to Y values

 
import {PlotData} from 'plotly.js';

/**
 * Options and functions to apply when converting plot data to table data.
 */
export interface PlotTableDataParams {
  /** Whether to add the plot label to data table */
  addLabel?: boolean;
  /** Whether to hide X values */
  hideX?: boolean;
  /** Whether to hide Y values */
  hideY?: boolean;
  /** Function to apply to the plot label */
  labelTransform?: (label: string) => string;
  /** Function to apply to the X label */
  xLabelTransform?: (label: string, data: Partial<PlotData>) => string;
  /** Function to apply to X values */
  xValueFormat?: (x: number | string) => number | string;
  /** Function to apply to the Y label */
  yLabelTransform?: (label: string, data: Partial<PlotData>) => string;
  /** Function to apply to Y values */
  yValueFormat?: (y: number | string) => number | string;
}

results matching ""

    No results matching ""