@senx/discovery-widgets
Version:
Discovery Widgets Elements
215 lines (214 loc) • 5.33 kB
TypeScript
import { ChartType, DiscoveryEvent, MapParams, TimeMode, TimeUnit } from './types';
import { HeatMaps } from '../utils/color-lib';
export declare class Param {
skippedVars?: string[];
mutedVars?: string[];
scheme: string;
bgColor?: string;
datasetColor?: string;
datasetNoAlpha?: boolean;
fillColor?: string;
fontColor?: string;
timeZone: string;
timeFormat?: string;
unit?: string;
title?: string;
type?: ChartType;
subType?: ChartType;
showRangeSelector?: boolean;
showYRangeSelector?: boolean;
timeMode?: TimeMode;
showDots: boolean;
timeUnit: TimeUnit;
borderColor?: string;
minColorValue?: string;
maxColorValue?: string;
startColor?: string;
endColor?: string;
numColorSteps?: number;
maxValue: number;
minValue: number;
key?: string;
properties?: any;
yAxis?: number;
xAxis?: number;
hideYAxis: boolean;
hideXAxis: boolean;
showLegend: boolean;
showValues: boolean;
fullDateDisplay: boolean;
responsive?: boolean;
autoRefresh?: number;
showControls: boolean;
discontinue: boolean;
actions?: {
title?: string;
icon?: string;
macro?: string;
}[];
thresholds?: {
color?: string;
fill?: boolean;
value?: number;
from?: number;
name?: string;
type?: 'solid' | 'dashed' | 'dotted';
}[];
markers?: {
color?: string;
value?: number;
start?: number;
fill?: boolean;
name?: string;
type?: 'solid' | 'dashed' | 'dotted';
alpha?: number;
}[];
pieces?: {
color?: string;
lte?: number;
gte?: number;
}[];
yLabelsMapping?: {
[key: number]: string;
};
xpieces?: boolean;
showErrors?: boolean;
showStatus?: boolean;
expandAnnotation: boolean;
displayExpander: boolean;
showGTSTree?: boolean;
foldGTSTree?: boolean;
split?: 'Y' | 'M' | 'D' | 'h' | 'm' | 's';
popupButtonValidateClass?: string;
popupButtonValidateLabel?: string;
bounds?: {
minDate?: number;
maxDate?: number;
yRanges?: [number, number];
};
isRefresh?: boolean;
elemsCount?: number;
fadeOutAfter?: number;
windowed?: number;
eventHandler?: string;
customStyles?: {
[key: string]: string;
};
httpHeaders?: {
[key: string]: string;
};
leftMargin: number;
showLoader: boolean;
noDataLabel: string;
tooltipDelay?: number;
polygons?: {
shape: number[][];
color?: string;
name?: string;
fill?: boolean;
}[];
xCursor?: boolean;
yCursor?: boolean;
yAxisFocus?: boolean;
poi?: boolean;
poiColor: '#D81B60';
poiLine: 'solid' | 'dashed' | 'dotted';
dotSize: number;
strokeWidth: number;
stacked?: boolean;
popup?: {
width?: string;
height?: string;
bgColor?: string;
backdropColor?: string;
fontColor?: string;
};
bar?: {
horizontal?: boolean;
groupedTooltip?: boolean;
animate?: boolean;
stacked?: boolean;
startAngle?: number;
fillGap?: boolean;
circular?: boolean;
rounded?: boolean;
track?: boolean;
trackColor?: string;
};
box?: {
horizontal?: boolean;
animate?: boolean;
};
button?: {
label?: string;
vertical?: boolean;
labelPosition?: 'start' | 'end' | 'center';
};
tabular?: {
fixedWidth?: boolean;
sortable?: boolean;
filterable?: boolean;
onTop?: boolean;
stickyHeader?: boolean;
stripped?: boolean;
};
gauge?: {
horizontal?: boolean;
showTicks?: false;
decimals?: number;
color?: any[][] | HeatMaps;
pointer?: boolean;
width?: number;
};
display?: {
showChart?: boolean;
chartType?: ChartType;
labelPosition?: 'n' | 's' | 'e' | 'w' | 'c' | 'ne' | 'se' | 'nw' | 'sw';
decimals?: number;
value?: string | number;
markdown?: boolean;
};
input?: {
showButton?: boolean;
value?: string | number | number[];
min?: number;
max?: number;
step?: number;
stepCount?: number;
horizontal?: boolean;
progress?: boolean;
showTicks?: boolean;
showFilter?: boolean;
immediate?: boolean;
caseSensitive?: boolean;
onlyFromAutocomplete?: boolean;
locale?: string;
delayRequest?: number;
accept?: string;
validation?: boolean;
disabled?: boolean;
allLabel?: string;
noneLabel?: string;
ranges?: any;
disableTime?: boolean;
customRangeLabel?: string;
applyLabel?: string;
cancelLabel?: string;
};
map?: MapParams;
svg?: {
handlers?: {
selector?: string;
event: DiscoveryEvent;
hover: boolean;
click: boolean;
}[];
};
calendar?: {
horizontal?: boolean;
firstDay?: number;
dayLabel?: string[];
monthLabel?: string[];
};
extra?: any;
}