libs/d3/src/lib/model/d3-plot-options.ts
Plot options for D3 component.
Properties |
|
copyright |
copyright:
|
Type : D3Copyright
|
Optional |
show copyright label default position is top left |
generalizeAllways |
generalizeAllways:
|
Type : boolean
|
Optional |
requests the dataset data generalized |
grid |
grid:
|
Type : boolean
|
Optional |
show or hide grid lines inside plot |
groupYaxis |
groupYaxis:
|
Type : boolean
|
Optional |
toggle dataset grouping by uom true = group y axis by uom false = single y axis for each timeseries |
hoverable |
hoverable:
|
Type : boolean
|
Optional |
show or hide lines with values when hovering with mouse |
hoverStyle |
hoverStyle:
|
Type : HoveringStyle
|
Optional |
style when hovering with mouse |
overview |
overview:
|
Type : boolean
|
Optional |
indicating if component should build overview diagram or not |
requestBeforeAfterValues |
requestBeforeAfterValues:
|
Type : boolean
|
Optional |
Request the data with expanded=true, to get valueBeforeTimespan/valueAfterTimespan |
sendDataRequestOnlyIfDatasetTimespanCovered |
sendDataRequestOnlyIfDatasetTimespanCovered:
|
Type : boolean
|
Optional |
Sends request only, when the corresponding dataset has values inside the request timespan. So the first and last values must cover the timespan. |
showReferenceValues |
showReferenceValues:
|
Type : boolean
|
Optional |
show reference values for a graph |
showTimeLabel |
showTimeLabel:
|
Type : boolean
|
Optional |
show the label of the xaxis |
timespanBufferFactor |
timespanBufferFactor:
|
Type : number
|
Optional |
Buffering factor for the get Data requests, which will be added before and after the timespan for every get data request. |
togglePanZoom |
togglePanZoom:
|
Type : boolean
|
Optional |
toggle panning (true) and zooming (false) |
yaxis |
yaxis:
|
Type : boolean
|
Optional |
show or hide y axis |
yAxisStepper |
yAxisStepper:
|
Type : boolean
|
Optional |
Show stepper for every Y-axis. This stepper allows to change the range of the axis. |
export interface D3PlotOptions {
/**
* Show stepper for every Y-axis. This stepper allows to change the range of the axis.
*/
yAxisStepper?: boolean;
/**
* show reference values for a graph
*/
showReferenceValues?: boolean;
/**
* requests the dataset data generalized
*/
generalizeAllways?: boolean;
/**
* toggle panning (true) and zooming (false)
*/
togglePanZoom?: boolean;
/**
* show or hide y axis
*/
yaxis?: boolean;
/**
* show or hide grid lines inside plot
*/
grid?: boolean;
/**
* show or hide lines with values when hovering with mouse
*/
hoverable?: boolean;
/**
* style when hovering with mouse
*/
hoverStyle?: HoveringStyle;
/**
* indicating if component should build overview diagram or not
*/
overview?: boolean;
/**
* show copyright label
*
* default position is top left
*/
copyright?: D3Copyright;
/**
* toggle dataset grouping by uom
* true = group y axis by uom
* false = single y axis for each timeseries
*/
groupYaxis?: boolean;
/**
* show the label of the xaxis
*/
showTimeLabel?: boolean;
/**
* Request the data with expanded=true, to get valueBeforeTimespan/valueAfterTimespan
*/
requestBeforeAfterValues?: boolean;
/**
* Buffering factor for the get Data requests, which will be added before and after the timespan for every get data request.
*/
timespanBufferFactor?: number;
/**
* Sends request only, when the corresponding dataset has values inside the request timespan. So the first and last values must cover the timespan.
*/
sendDataRequestOnlyIfDatasetTimespanCovered?: boolean;
}
export interface D3Copyright {
label: string;
positionX?: 'right' | 'left';
positionY?: 'top' | 'bottom';
}
export enum HoveringStyle {
none = 'none',
line = 'line',
point = 'point'
}