@eva-ics/webengine-react
Version:
React components for EVA ICS HMI Web Engine
69 lines (68 loc) • 2.38 kB
TypeScript
import { Eva, EvaError, StateProp, ItemState } from "@eva-ics/webengine";
declare const get_engine: () => Eva | null;
declare const set_engine: (engine: Eva) => void;
interface CanvasPosition {
x: number;
y: number;
}
interface EvaStateParams {
oid?: string;
engine?: Eva;
}
declare const useEvaState: (params: EvaStateParams, dependencies: Array<any>) => ItemState;
interface EvaStateBulkParams {
oid?: Array<string>;
engine?: Eva;
}
declare const useEvaStateBulk: (params: EvaStateBulkParams, dependencies: Array<any>) => {
[key: string]: ItemState;
};
interface EvaStateBlockParams {
name: string;
state_updates: string[];
engine?: Eva;
}
declare const useEvaStateBlock: (params: EvaStateBlockParams, dependencies: Array<any>) => void;
interface StateHistoryData {
data: any;
error?: EvaError;
}
interface EvaStateHistoryParams {
oid?: string | Array<string>;
timeframe: string | Array<string>;
update?: number;
update_uninit?: number;
prop?: StateProp;
fill?: string;
digits?: number;
args?: any;
engine?: Eva;
}
declare const useEvaStateHistory: (params: EvaStateHistoryParams, dependencies: Array<any>) => StateHistoryData;
interface EvaAPICallParams {
method?: string;
params?: object;
update?: number;
update_uninit?: number;
engine?: Eva;
}
interface APICallData {
data: any;
error?: EvaError;
}
declare const useEvaAPICall: (params: EvaAPICallParams, dependencies: Array<any>) => APICallData;
declare enum EvaSubscriptionState {
Working = 0,
Active = 1,
Failed = 2
}
interface EvaStateUpdatesParams {
engine?: Eva;
state_updates: Array<string> | boolean;
clear_existing?: boolean;
keep?: boolean;
append?: boolean;
}
declare const useEvaStateUpdates: (params: EvaStateUpdatesParams, dependencies: Array<any>) => EvaSubscriptionState;
declare const calculateProgressColor: (kind: string, value?: number, warnValue?: number, critValue?: number, lowWarnValue?: number, lowCritValue?: number) => string;
export { get_engine, set_engine, CanvasPosition, useEvaState, useEvaStateBulk, useEvaStateBlock, useEvaStateHistory, useEvaAPICall, EvaStateParams, EvaStateBulkParams, EvaStateHistoryParams, StateHistoryData, EvaAPICallParams, APICallData, EvaSubscriptionState, EvaStateUpdatesParams, useEvaStateUpdates, calculateProgressColor };