Files
infineon_plc/Packages/Beckhoff.TwinCAT.HMI.Controls.14.4.1/runtimes/native1.12-tchmi/dist/TcHmiLinearGauge/TcHmiLinearGauge.esm.d.ts
m.heisig 2d11c43579 Added minimal functionality for Robot teaching
- Added minimal HMI
- Added possibility to open and close all chamber doors
2026-01-17 09:20:39 +01:00

1123 lines
43 KiB
TypeScript

import { TcHmiControl } from 'Beckhoff.TwinCAT.HMI.Framework/index.esm.js';
import { type ValueBuffer, InputProcessingPoint } from '../Helpers/TcHmiValueBuffer/ValueBuffer.js';
declare class TcHmiLinearGauge extends TcHmiControl.Control {
#private;
constructor(element: JQuery, pcElement: JQuery, attrs: TcHmi.Controls.ControlAttributeList);
/** Reference to the root dom element of the current control template as jquery object. */
protected __elementTemplateRoot: JQuery;
/** Reference to the track element of the current control template as jquery object. */
protected __elementTrack: JQuery;
/** Reference to the filler element of the current control template as jquery object. */
protected __elementFiller: JQuery;
/** Reference to the knob HTMLDivElement of the current control template as jquery object. */
protected __elementKnob: JQuery;
/** Reference to the knob HTMLDivElement. */
protected __elementKnobDiv: HTMLDivElement;
/** Shared promises for the unprocessed knob string. Key is the url. */
protected static __svgKnobMap: Map<string, Promise<string>>;
/** Cached knob string for recoloring. */
protected __knobSvgString: string | null;
/** Reference to the label container element of the current control template as jquery object. */
protected __elementLabels: JQuery;
/** Reference to the tick container element of the current control template as jquery object. */
protected __elementTicks: JQuery;
/** Reference to the value container element of the current control template as jquery object. */
protected __elementDescription: JQuery;
/** Reference to the value content container element of the current control template as jquery object. */
protected __elementValueContent: JQuery;
/** Reference to the hidden min value container element of the current control template as jquery object. */
protected __elementValueHiddenMin: JQuery;
/** Reference to the hidden max value container element of the current control template as jquery object. */
protected __elementValueHiddenMax: JQuery;
/** Reference to the unit container element of the current control template as jquery object. */
protected __elementUnitContent: JQuery;
/** Reference to the range container element of the current control template as jquery object. */
protected __elementRange: JQuery;
/** Internal reference to the attribute 'data-tchmi-value' */
protected __value: number | undefined;
/** Last value reported via onPropertyChanged (The value returned by getValue when onPropertyChanged was raised) */
protected __lastReportedValue: number | bigint | null | undefined;
/** Internal reference to the attribute 'data-tchmi-min-value' */
protected __minValue: number | undefined;
/** Internal reference to the attribute 'data-tchmi-max-value' */
protected __maxValue: number | undefined;
/** Internal reference to the attribute 'data-tchmi-step' */
protected __step: number | undefined;
protected __stepOffset: number;
/** Internal reference to the attribute 'data-tchmi-start-from-zero' */
protected __startFromZero: boolean | undefined;
/** Internal reference to the attribute 'data-tchmi-editable' */
protected __editable: boolean | undefined;
/** Internal reference to the attribute 'data-tchmi-ignore-invalid-values' */
protected __ignoreInvalidValues: boolean | undefined;
protected __valueBuffer: ValueBuffer<number> | undefined;
/** Internal reference to the attribute 'data-tchmi-click-anywhere-to-edit' */
protected __clickAnywhereToEdit: boolean | undefined;
/** Internal reference to the attribute 'data-tchmi-value-format' */
protected __valueFormat: TcHmi.IFunction<string> | null | undefined;
/** Internal reference to the attribute 'data-tchmi-show-label' */
protected __showLabels: boolean | undefined;
/** Internal reference to the attribute 'data-tchmi-label-range' */
protected __labelRange: number | null | undefined;
/** Internal reference to the attribute 'data-tchmi-label-format' */
protected __labelFormat: TcHmi.IFunction<string> | null | undefined;
/** Internal reference to the attribute 'data-tchmi-show-ticks' */
protected __showTicks: boolean | undefined;
/** Internal reference to the attribute 'data-tchmi-tick-definition' */
protected __tickDefinition: TickDefinition | null | undefined;
/** Internal reference to the attribute 'data-tchmi-label-position' */
protected __labelPosition: 'Top' | 'Bottom' | 'Left' | 'Right' | undefined;
/** Internal reference to the attribute 'data-tchmi-show-value-text' */
protected __showValueText: boolean | undefined;
/** Internal reference to the attribute "data-tchmi-decimal-digits" */
protected __decimalDigits: number | null | undefined;
/** Internal reference to the attribute 'data-tchmi-unit' */
protected __unit: string | undefined;
/** Internal reference to the attribute 'data-tchmi-range' */
protected __range: Range[] | null | undefined;
/** Internal reference to the attribute 'data-tchmi-markers' */
protected __markers: Marker[] | null | undefined;
/** Internal reference to the attribute 'data-tchmi-orientation' */
protected __orientation: 'Horizontal' | 'Vertical' | 'HorizontalInverted' | 'VerticalInverted' | undefined;
/** Internal reference to the attribute 'data-tchmi-padding' */
protected __padding: TcHmi.FourSidedCss | null | undefined;
/** Internal reference to the attribute 'data-tchmi-base-animation-time' */
protected __baseAnimationTime: number | undefined;
/** Internal reference to the attribute 'data-tchmi-value-font-size' */
protected __valueFontSize: number | undefined;
/** Internal reference to the attribute 'data-tchmi-value-font-size-unit' */
protected __valueFontSizeUnit: TcHmi.FontSizeUnit | undefined;
/** Internal reference to the attribute 'data-tchmi-value-font-family' */
protected __valueFontFamily: TcHmi.FontFamily | null | undefined;
/** Internal reference to the attribute 'data-tchmi-value-font-style' */
protected __valueFontStyle: TcHmi.FontStyle | undefined;
/** Internal reference to the attribute 'data-tchmi-value-font-weight' */
protected __valueFontWeight: TcHmi.FontWeight | undefined;
/** Internal reference to the attribute 'data-tchmi-value-space' */
protected __valueSpace: number | undefined;
/** Internal reference to the attribute 'data-tchmi-value-space-unit' */
protected __valueSpaceUnit: TcHmi.DimensionUnit | undefined;
/** Internal reference to the attribute 'data-tchmi-value-color' */
protected __valueColor: TcHmi.SolidColor | null | undefined;
/** Internal reference to the attribute 'data-tchmi-label-font-size' */
protected __labelFontSize: number | undefined;
/** Internal reference to the attribute 'data-tchmi-label-font-size-unit' */
protected __labelFontSizeUnit: TcHmi.FontSizeUnit | undefined;
/** Internal reference to the attribute 'data-tchmi-label-font-family' */
protected __labelFontFamily: TcHmi.FontFamily | null | undefined;
/** Internal reference to the attribute 'data-tchmi-label-font-style' */
protected __labelFontStyle: TcHmi.FontStyle | undefined;
/** Internal reference to the attribute 'data-tchmi-label-font-weight' */
protected __labelFontWeight: TcHmi.FontWeight | undefined;
/** Internal reference to the attribute 'data-tchmi-label-color' */
protected __labelColor: TcHmi.SolidColor | null | undefined;
/** Internal reference to the attribute 'data-tchmi-unit-font-size' */
protected __unitFontSize: number | undefined;
/** Internal reference to the attribute 'data-tchmi-unit-font-size-unit' */
protected __unitFontSizeUnit: TcHmi.FontSizeUnit | undefined;
/** Internal reference to the attribute 'data-tchmi-unit-font-family' */
protected __unitFontFamily: TcHmi.FontFamily | null | undefined;
/** Internal reference to the attribute 'data-tchmi-unit-font-style' */
protected __unitFontStyle: TcHmi.FontStyle | undefined;
/** Internal reference to the attribute 'data-tchmi-unit-font-weight' */
protected __unitFontWeight: TcHmi.FontWeight | undefined;
/** Internal reference to the attribute 'data-tchmi-unit-orientation' */
protected __unitOrientation: 'Theme' | 'Horizontal' | 'Vertical' | undefined;
/** Internal reference to the attribute 'data-tchmi-unit-color' */
protected __unitColor: TcHmi.SolidColor | null | undefined;
/** Internal reference to the attribute 'data-tchmi-tick-color' */
protected __tickColor: TcHmi.Color | null | undefined;
/** Internal reference to the attribute 'data-tchmi-filler-color' */
protected __progressBackgroundColor: TcHmi.Color | null | undefined;
/** Internal reference to the attribute 'data-tchmi-filler-color' */
protected __progressForegroundColor: TcHmi.Color | null | undefined;
/** Internal reference to the attribute 'data-tchmi-knob-color' */
protected __knobColor: TcHmi.Color | null | undefined;
/** Internal reference to the attribute 'data-tchmi-knob-arrows-color' */
protected __knobArrowsColor: TcHmi.SolidColor | null | undefined;
/** Stores information about the current drag operation */
protected __draggingInfo: {
isDragging: boolean;
offset: number;
touchIdentifier: number | null;
originalValue: number;
knobConfig: KnobConfig;
};
/** Number formatter */
protected __numberFormatter: Intl.NumberFormat;
/** Caches the old progress value */
protected __oldProgressValue: number;
/** The animation running on the progress bar */
protected __progressBarAnimation: TcHmi.Animation | null;
/** The animation running on the edit knob */
protected __editKnobAnimation: TcHmi.Animation | null;
/** Normalized internal value */
protected __internalValue: number;
protected __internalMinValue: number;
protected __internalMaxValue: number;
protected __internalSetPoint: number | undefined;
/** Reference to the setPoint element */
protected __elementSetPoint: HTMLElement | null | undefined;
/** Internal reference to the attribute 'data-tchmi-set-point' */
protected __setPoint: number | undefined;
/** Internal reference to the attribute 'data-tchmi-set-point-marker-color' */
protected __setPointMarkerColor: TcHmi.SolidColor | null | undefined;
/** Saved old value of setPoint */
protected __oldSetPoint: number | undefined;
/** Reference to the div element used as error display (top most layer) as jquery object. */
protected __elementInvalidNotification: HTMLElement;
/** The interval timer for updateInvalidNotification */
protected __updateInvalidNotificationTimer: number;
protected __localizationReader: TcHmi.Locale.LocalizationReader | undefined;
/**
* If raised, the control object exists in control cache and constructor of each inheritation level was called.
* This function is only to be used by the System. Other function calls are not intended.
*/
__previnit(): void;
/**
* If raised, all attributes have been set to it's default or dom values.
* This function is only to be used by the System. Other function calls are not intended.
*/
__init(): void;
/**
* Is called by the system after the control instance gets part of the current DOM.
* This function is only to be used by the System. Other function calls are not intended.
*/
__attach(): void;
/**
* Is called by the system after the control instance is no longer part of the current DOM.
* This function is only to be used by the System. Other function calls are not intended.
*/
__detach(): void;
/**
* Destroy the current control instance.
* Will be called automatically if system destroys control!
*/
destroy(): void;
protected __onResized(): void;
protected __updateInvalidNotification(): void;
protected __fetchKnob(): void;
/**
* Resolves a LinearGradientColor object to two string representations for use in a svg fill and defs property.
* Has to be called with a valid LinearGradientColor. Use isLinearGradientColor to check
* @param gradientColor The colorObject to resolve.
*/
private __resolveLinearGradientColorAsSvgStrings;
/**
* Compiles the knob SVG String and appends the svg to the DOM
*/
protected __updateKnobColors(): void;
/**
* Is called when the mousedown event is raised from the '.TcHmi_Controls_Beckhoff_TcHmiLinearGauge-template-knob' element
*/
protected __onMouseDownKnob(event: MouseEvent): void;
/**
* Is called when the mousedown event is raised from the control element
*/
protected __onMouseDownControl(event: MouseEvent): void;
/**
* Is called when the mousemove event is raised from the window
*/
protected __onMouseMove(event: MouseEvent): void;
/**
* Is called when the mouseup event is raised from the window
*/
protected __onMouseUp(_event: MouseEvent): void;
/**
* Is called when the touchstart event is raised from the '.TcHmi_Controls_Beckhoff_TcHmiLinearGauge-template-knob' element
*/
protected __onTouchStartKnob(event: TouchEvent): void;
/**
* Is called when the touchstart event is raised from the control element
*/
protected __onTouchStartControl(event: TouchEvent): void;
/**
* Is called when the touchmove event is raised from the window
*/
protected __onTouchMove(event: TouchEvent): void;
/**
* Is called when the touchend event is raised from the window
*/
protected __onTouchEnd(event: TouchEvent): void;
/**
* Is called when the touchcancel event is raised from the window
*/
protected __onTouchCancel(event: TouchEvent): void;
/**
* Function to calculate the percentage to which the bar would be filled given a specific value.
* @param value The value of the slider.
*/
protected __calculatePercentage(value: number): number;
/**
* Function to calculate the value when the bar would be filled to a given percentage.
* @param percentage The percentage of the bar that is filled.
*/
protected __calculateValue(percentage: number): number;
/**
* Function to calculate the percentage to which the bar should be filled when the user interacts with the gauge.
* @param x The x coordinate of the mouse or touch.
* @param y The y coordinate of the mouse or touch.
*/
protected __calcValueFromEventCoords(x: number, y: number): number;
/**
* Updates the slider, progress bar and value text.
*/
protected __updateValueVisualization(): void;
/**
* Sets __internalMinValue/__inernalMaxValue based on __minValue/__maxValue;
*/
protected __setInternalMinMaxValue(): void;
/**
* Sets __internalValue;
*/
protected __setInternalValue(): void;
/**
* Checks if value is valid.
*/
protected __isValid(value: number): boolean;
/**
* Sets __internalSetPoint;
*/
protected __setInternalSetPoint(): void;
/**
* Sets the value or setpoint depending on if a setpoint is being used. Useful for handling user interaction.
* @param valueNew The new value.
*/
protected __setValueOrSetPoint(valueNew: number): void;
/**
* Gets the value or setpoint depending on if a setpoint is being used. Useful for handling user interaction.
*/
protected __getValueOrSetPoint(): number;
/**
* Sets the value attribute if the user is not currently dragging the slider.
* @param valueNew The new value for value.
*/
setValue(valueNew: number | null): void;
/**
* Sets the value attribute.
* @param valueNew The new value for value.
*/
protected __setValue(valueNew: number | null): void;
/**
* Returns the current value of internalValue (only valid values).
* @returns The current value of internalValue.
*/
getValue(): number | undefined;
/**
* Processes the current value of attribute value.
*/
protected __processValue(): void;
/**
* Sets the setPoint attribute.
* @param valueNew The new value for setPoint.
*/
setSetPoint(valueNew: number | null): void;
/**
* Sets the setPoint attribute, regardless of user interaction.
* @param valueNew The new value for setPoint.
*/
protected __setSetPoint(valueNew: number | null): void;
/**
* Returns the current value of setPoint.
* @returns The current value of setPoint.
*/
getSetPoint(): number | undefined;
/**
* Processes the current referenceValue of attribute set point.
*/
protected __processSetPoint(): void;
/**
* Sets the value of the member variable decimalDigits.
* @param valueNew The new value for decimalDigits
*/
setDecimalDigits(valueNew: number | null): void;
/**
* Returns the current value of the member variable decimalDigits.
* @returns the current value of the member variable decimalDigits.
*/
getDecimalDigits(): number | null | undefined;
/**
* Processes the current value of decimalDigits and .
*/
protected __processDecimalDigits(): void;
/**
* Updates the NumberFormat object that formats the numeric value to the displayed string due to the current zeroPadding, decimalDigits and decimalPrecisionMode.
*/
protected __updateFormatter(): void;
/**
* Create the the element that displays the set point
*/
protected __createSetPointElement(): void;
/**
* Remove the element that displays the setPoint
*/
protected __removeSetPointElement(): void;
/**
* Updates the setPoint.
* @param value The value to update to.
*/
private __updateSetPoint;
/**
* Sets the minValue attribute.
* @param valueNew The new value for minValue.
*/
setMinValue(valueNew: number | null): void;
/**
* Returns the current value of minValue.
* @returns The current value of minValue.
*/
getMinValue(): number | undefined;
/**
* Processes the current value of attribute minvalue.
*/
protected __processMinValue(): void;
/**
* Sets the maxValue attribute.
* @param valueNew The new value for maxValue.
*/
setMaxValue(valueNew: number | null): void;
/**
* Returns the current value of maxValue.
* @returns The current value of maxValue.
*/
getMaxValue(): number | undefined;
/**
* Processes the current value of attribute maxvalue.
*/
protected __processMaxValue(): void;
/**
* Sets the step attribute.
* @param valueNew The new value for step.
*/
setStep(valueNew: number | null): void;
/**
* Returns the current value of step.
* @returns The current value of step.
*/
getStep(): number | undefined;
/**
* Processes the current value of attribute step.
*/
protected __processStep(): void;
/**
* Sets the start-from-zero attribute.
* @param valueNew The new value for start-from-zero.
*/
setStartFromZero(valueNew: boolean | null): void;
/**
* Returns the current value of start-from-zero.
* @returns The current value of start-from-zero.
*/
getStartFromZero(): boolean | undefined;
/**
* Processes the current value of attribute start-from-zero.
*/
protected __processStartFromZero(): void;
/**
* Sets the editable attribute.
* @param valueNew The new value for editable.
*/
setEditable(valueNew: boolean | null): void;
/**
* Returns the current value of editable.
* @returns The current value of editable.
*/
getEditable(): boolean | undefined;
/**
* Processes the current value of attribute editable.
*/
protected __processEditable(): void;
/**
* Sets the ignoreInvalidValues attribute.
* @param valueNew The new value for ignoreInvalidValues.
*/
setIgnoreInvalidValues(valueNew: boolean | null): void;
/**
* Returns the current value of ignoreInvalidValues.
* @returns The current value of ignoreInvalidValues.
*/
getIgnoreInvalidValues(): boolean | undefined;
/**
* Processes the current value of attribute ignoreInvalidValues.
*/
protected __processIgnoreInvalidValues(): void;
/**
* Sets the inputProcessingPoint attribute.
* @param valueNew The new value for inputProcessingPoint.
*/
setInputProcessingPoint(valueNew: InputProcessingPoint | keyof typeof InputProcessingPoint | null): void;
/**
* Returns the current value of inputProcessingPoint.
* @returns The current value of inputProcessingPoint.
*/
getInputProcessingPoint(): InputProcessingPoint | undefined;
/**
* Processes the current InputProcessingPoint attribute value.
*/
__processInputProcessingPoint(): void;
/**
* Sets the clickAnywhereToEdit attribute.
* @param valueNew The new value for clickAnywhereToEdit.
*/
setClickAnywhereToEdit(valueNew: boolean | null): void;
/**
* Returns the current value of clickAnywhereToEdit.
* @returns The current value of clickAnywhereToEdit.
*/
getClickAnywhereToEdit(): boolean | undefined;
/**
* Processes the current value of attribute clickAnywhereToEdit.
*/
protected __processClickAnywhereToEdit(): void;
/**
* Sets the value of the valueFormat order attribute.
* @param value The new valueFormat method.
*/
setValueFormat(valueNew: TcHmi.IFunction<string> | null): void;
/**
* The watch callback for the valueFormat object resolver.
*/
protected __onResolverForValueFormatWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.IFunction<string>>): void;
/**
* Gets the current valueFormat method.
* @returns the current valueFormat method.
*/
getValueFormat(): TcHmi.IFunction<string> | null | undefined;
/**
* Processes the current valueFormat method
*/
protected __processValueFormat(): void;
/**
* Executes the current valueFormat function.
* @param value The value to format.
*/
private __executeValueFormatFunction;
/**
* Sets the showLabels attribute.
* @param valueNew The new value for showLabels.
*/
setShowLabels(valueNew: boolean | null): void;
/**
* Returns the current value of showLabels.
* @returns The current value of showLabels.
*/
getShowLabels(): boolean | undefined;
/**
* Processes the current value of attribute showlabels.
*/
protected __processShowLabels(): void;
/**
* Sets the labelRange attribute.
* @param valueNew The new value for labelRange.
*/
setLabelRange(valueNew: number | null): void;
/**
* Returns the current value of labelRange.
* @returns The current value of labelRange.
*/
getLabelRange(): number | null | undefined;
/**
* Processes the current value of attribute labelrange.
*/
protected __processLabelRange(): void;
/**
* Sets the value of the labelFormat order attribute.
* @param value The new labelFormat method.
*/
setLabelFormat(valueNew: TcHmi.IFunction<string> | null): void;
/**
* The watch callback for the labelFormat object resolver.
*/
protected __onResolverForLabelFormatWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.IFunction<string>>): void;
/**
* Gets the current labelFormat method.
* @returns the current labelFormat method.
*/
getLabelFormat(): TcHmi.IFunction<string> | null | undefined;
/**
* Processes the current labelFormat method
*/
protected __processLabelFormat(): void;
/**
* Executes the current labelFormat function.
* @param first The label to format.
*/
private __executeLabelFormatFunction;
/**
* Sets the showLabels attribute.
* @param valueNew The new value for showLabels.
*/
setShowTicks(valueNew: boolean | null): void;
/**
* Returns the current value of showLabels.
* @returns The current value of showLabels.
*/
getShowTicks(): boolean | undefined;
/**
* Processes the current value of attribute showlabels.
*/
protected __processShowTicks(): void;
/**
* Sets the tickDefinition attribute.
* @param valueNew The new value for tickDefinition.
*/
setTickDefinition(valueNew: TickDefinition | null): void;
/**
* The watch callback for the tickDefinition object resolver.
*/
protected __onResolverForTickDefinitionWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TickDefinition>): void;
/**
* Returns the current value of tickDefinition.
* @returns The current value of tickDefinition.
*/
getTickDefinition(): TickDefinition | null | undefined;
/**
* Processes the current value of attribute tickdefinition.
*/
protected __processTickDefinition(): void;
/**
* Sets the labelPosition attribute.
* @param valueNew The new value for labelPosition.
*/
setLabelPosition(valueNew: 'Top' | 'Bottom' | 'Left' | 'Right' | null): void;
/**
* Returns the current value of labelPosition.
*/
getLabelPosition(): "Top" | "Bottom" | "Left" | "Right" | undefined;
/**
* Processes the current value of attribute labelPosition.
*/
protected __processLabelPosition(): void;
/**
* Sets the range attribute.
* @param valueNew The new value for range.
*/
setRange(valueNew: Range[] | null): void;
/**
* The watch callback for the range object resolver.
*/
protected __onResolverForRangeWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<Range[]>): void;
/**
* Returns the current value of range.
*/
getRange(): Range[] | null | undefined;
/**
* Processes the current value of attribute range.
*/
protected __processRange(): void;
/**
* Sets the markers attribute.
* @param valueNew The new value for markers.
*/
setMarkers(valueNew: Marker[] | null): void;
/**
* The watch callback for the markers object resolver.
*/
protected __onResolverForMarkersWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<Marker[]>): void;
/**
* Returns the current value of range.
*/
getMarkers(): Marker[] | null | undefined;
/**
* Processes the current value of attribute range.
*/
protected __processMarkers(): void;
/**
* Sets the showValueText attribute.
* @param valueNew The new value for showValueText.
*/
setShowValueText(valueNew: boolean | null): void;
/**
* Returns the current value of showValueText.
*/
getShowValueText(): boolean | undefined;
/**
* Processes the current value of attribute showValueText.
*/
protected __processShowValueText(): void;
/**
* Sets the unit attribute.
* @param valueNew The new value for unit.
*/
setUnit(valueNew: string | null): void;
/**
* Returns the current value of unit.
*/
getUnit(): string | undefined;
/**
* Processes the current value of attribute unit.
*/
protected __processUnit(): void;
/**
* Sets the orientation attribute.
* @param valueNew The new value for orientation.
*/
setOrientation(valueNew: 'Horizontal' | 'Vertical' | 'HorizontalInverted' | 'VerticalInverted' | null): void;
/**
* Returns the current value of orientation.
*/
getOrientation(): "Horizontal" | "Vertical" | "HorizontalInverted" | "VerticalInverted" | undefined;
/**
* Processes the current value of attribute orientation.
*/
protected __processOrientation(): void;
/**
* Sets the padding attribute.
* @param valueNew The new value for padding.
*/
setPadding(valueNew: TcHmi.FourSidedCss | null): void;
/**
* The watch callback for the padding object resolver.
*/
protected __onResolverForPaddingWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.FourSidedCss>): void;
/**
* Returns the current value of padding.
*/
getPadding(): TcHmi.FourSidedCss | null | undefined;
/**
* Processes the current value of attribute padding.
*/
protected __processPadding(): void;
/**
* Sets the baseAnimationTime attribute.
* @param valueNew The new value for baseAnimationTime.
*/
setBaseAnimationTime(valueNew: number | null): void;
/**
* Returns the current value of baseAnimationTime.
*/
getBaseAnimationTime(): number | undefined;
/**
* Processes the current value of attribute baseAnimationTime.
*/
protected __processBaseAnimationTime(): void;
/**
* Sets the font size attribute.
* @param valueNew The new value for valueFontSize.
*/
setValueFontSize(valueNew: number | null): void;
/**
* Returns the current value of valueFontSize.
*/
getValueFontSize(): number | undefined;
/**
* Processes the current value of attribute textfontsize.
*/
protected __processValueFontSize(): void;
/**
* Sets the font size unit attribute.
* @param valueNew The new value for valueFontSizeUnit.
*/
setValueFontSizeUnit(valueNew: TcHmi.FontSizeUnit | null): void;
/**
* Returns the current value of valueFontSizeUnit.
*/
getValueFontSizeUnit(): TcHmi.FontSizeUnit | undefined;
/**
* Processes the current value of attribute textfontsizeunit.
*/
protected __processValueFontSizeUnit(): void;
/**
* Sets the font family attribute.
* @param valueNew The new value for valueFontFamily.
*/
setValueFontFamily(valueNew: TcHmi.FontFamily | null): void;
/**
* Returns the current value of valueFontFamily.
*/
getValueFontFamily(): string | null | undefined;
/**
* Processes the current value of attribute textfontfamily.
*/
protected __processValueFontFamily(): void;
/**
* Sets the font style attribute.
* @param valueNew The new value for valueFontStyle.
*/
setValueFontStyle(valueNew: TcHmi.FontStyle | null): void;
/**
* Returns the current value of valueFontStyle.
*/
getValueFontStyle(): TcHmi.FontStyle | undefined;
/**
* Processes the current value of attribute textfontstyle.
*/
protected __processValueFontStyle(): void;
/**
* Sets the font weight attribute.
* @param valueNew The new value for valueFontWeight.
*/
setValueFontWeight(valueNew: TcHmi.FontWeight | null): void;
/**
* Returns the current value of valueFontWeight.
*/
getValueFontWeight(): TcHmi.FontWeight | undefined;
/**
* Processes the current value of attribute textfontweight.
*/
protected __processValueFontWeight(): void;
/**
* Sets the text color attribute.
* @param valueNew The new value for valueColor.
*/
setValueColor(valueNew: TcHmi.SolidColor | null): void;
/**
* The watch callback for the valueColor object resolver.
*/
protected __onResolverForValueColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
/**
* Returns the current value of valueColor.
*/
getValueColor(): TcHmi.SolidColor | null | undefined;
/**
* Processes the current value of attribute valueColor.
*/
protected __processValueColor(): void;
/**
* Sets the font size attribute.
* @param valueNew The new value for labelFontSize.
*/
setLabelFontSize(valueNew: number | null): void;
/**
* Returns the current value of labelFontSize.
*/
getLabelFontSize(): number | undefined;
/**
* Processes the current value of attribute textfontsize.
*/
protected __processLabelFontSize(): void;
/**
* Sets the font size unit attribute.
* @param valueNew The new value for labelFontSizeUnit.
*/
setLabelFontSizeUnit(valueNew: TcHmi.FontSizeUnit | null): void;
/**
* Returns the current value of labelFontSizeUnit.
*/
getLabelFontSizeUnit(): TcHmi.FontSizeUnit | undefined;
/**
* Processes the current value of attribute textfontsizeunit.
*/
protected __processLabelFontSizeUnit(): void;
/**
* Sets the font family attribute.
* @param valueNew The new value for labelFontFamily.
*/
setLabelFontFamily(valueNew: TcHmi.FontFamily | null): void;
/**
* Returns the current value of labelFontFamily.
*/
getLabelFontFamily(): string | null | undefined;
/**
* Processes the current value of attribute textfontfamily.
*/
protected __processLabelFontFamily(): void;
/**
* Sets the font style attribute.
* @param valueNew The new value for labelFontStyle.
*/
setLabelFontStyle(valueNew: TcHmi.FontStyle | null): void;
/**
* Returns the current value of labelFontStyle.
*/
getLabelFontStyle(): TcHmi.FontStyle | undefined;
/**
* Processes the current value of attribute textfontstyle.
*/
protected __processLabelFontStyle(): void;
/**
* Sets the font weight attribute.
* @param valueNew The new value for labelFontWeight.
*/
setLabelFontWeight(valueNew: TcHmi.FontWeight | null): void;
/**
* Returns the current value of labelFontWeight.
*/
getLabelFontWeight(): TcHmi.FontWeight | undefined;
/**
* Processes the current value of attribute textfontweight.
*/
protected __processLabelFontWeight(): void;
/**
* Sets the text color attribute.
* @param valueNew The new value for labelColor.
*/
setLabelColor(valueNew: TcHmi.SolidColor | null): void;
/**
* The watch callback for the labelColor object resolver.
*/
protected __onResolverForLabelColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
/**
* Returns the current value of labelColor.
*/
getLabelColor(): TcHmi.SolidColor | null | undefined;
/**
* Processes the current value of attribute labelColor.
*/
protected __processLabelColor(): void;
/**
* Sets the font size attribute.
* @param valueNew The new value for unitFontSize.
*/
setUnitFontSize(valueNew: number | null): void;
/**
* Returns the current value of unitFontSize.
*/
getUnitFontSize(): number | undefined;
/**
* Processes the current value of attribute textfontsize.
*/
protected __processUnitFontSize(): void;
/**
* Sets the font size unit attribute.
* @param valueNew The new value for unitFontSizeUnit.
*/
setUnitFontSizeUnit(valueNew: TcHmi.FontSizeUnit | null): void;
/**
* Returns the current value of unitFontSizeUnit.
*/
getUnitFontSizeUnit(): TcHmi.FontSizeUnit | undefined;
/**
* Processes the current value of attribute textfontsizeunit.
*/
protected __processUnitFontSizeUnit(): void;
/**
* Sets the font family attribute.
* @param valueNew The new value for unitFontFamily.
*/
setUnitFontFamily(valueNew: TcHmi.FontFamily | null): void;
/**
* Returns the current value of unitFontFamily.
*/
getUnitFontFamily(): string | null | undefined;
/**
* Processes the current value of attribute textfontfamily.
*/
protected __processUnitFontFamily(): void;
/**
* Sets the font style attribute.
* @param valueNew The new value for unitFontStyle.
*/
setUnitFontStyle(valueNew: TcHmi.FontStyle | null): void;
/**
* Returns the current value of unitFontStyle.
*/
getUnitFontStyle(): TcHmi.FontStyle | undefined;
/**
* Processes the current value of attribute textfontstyle.
*/
protected __processUnitFontStyle(): void;
/**
* Sets the font weight attribute.
* @param valueNew The new value for unitFontWeight.
*/
setUnitFontWeight(valueNew: TcHmi.FontWeight | null): void;
/**
* Returns the current value of unitFontWeight.
*/
getUnitFontWeight(): TcHmi.FontWeight | undefined;
/**
* Processes the current value of attribute textfontweight.
*/
protected __processUnitFontWeight(): void;
/**
* Sets the unit-orientation attribute.
* @param valueNew The new value for unit-orientation.
*/
setUnitOrientation(valueNew: 'Theme' | 'Horizontal' | 'Vertical' | null): void;
/**
* Returns the current value of unit-orientation.
*/
getUnitOrientation(): "Horizontal" | "Vertical" | "Theme" | undefined;
/**
* Processes the current value of attribute unit-orientation.
*/
protected __processUnitOrientation(): void;
/**
* Sets the text color attribute.
* @param valueNew The new value for unitColor.
*/
setUnitColor(valueNew: TcHmi.SolidColor | null): void;
/**
* The watch callback for the unitColor object resolver.
*/
protected __onResolverForUnitColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
/**
* Returns the current value of unitColor.
*/
getUnitColor(): TcHmi.SolidColor | null | undefined;
/**
* Processes the current value of attribute unitColor.
*/
protected __processUnitColor(): void;
/**
* Sets the tick color attribute.
* @param valueNew The new value for tickColor.
*/
setTickColor(valueNew: TcHmi.Color | null): void;
/**
* The watch callback for the tickColor object resolver.
*/
protected __onResolverForTickColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.Color>): void;
/**
* Returns the current value of tickColor.
*/
getTickColor(): TcHmi.Color | null | undefined;
/**
* Processes the current value of attribute textfontweight.
*/
protected __processTickColor(): void;
/**
* Sets the progress background color attribute.
* @param valueNew The new value for progressBackgroundColor.
*/
setProgressBackgroundColor(valueNew: TcHmi.Color | null): void;
/**
* The watch callback for the progressBackgroundColor object resolver.
*/
protected __onResolverForProgressBackgroundColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.Color>): void;
/**
* Returns the current value of ProgressBackgroundColor.
*/
getProgressBackgroundColor(): TcHmi.Color | null | undefined;
/**
* Processes the current value of attribute fillerColor.
*/
protected __processProgressBackgroundColor(): void;
/**
* Sets the progress foreground color attribute.
* @param valueNew The new value for progressForegroundColor.
*/
setProgressForegroundColor(valueNew: TcHmi.Color | null): void;
/**
* The watch callback for the progressForegroundColor object resolver.
*/
protected __onResolverForProgressForegroundColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.Color>): void;
/**
* Returns the current value of progressForegroundColor.
*/
getProgressForegroundColor(): TcHmi.Color | null | undefined;
/**
* Processes the current value of attribute progressForegroundColor.
*/
protected __processProgressForegroundColor(): void;
/**
* Sets the knob color attribute.
* @param valueNew The new value for KnobColor.
*/
setKnobColor(valueNew: TcHmi.Color | null): void;
/**
* The watch callback for the knobColor object resolver.
*/
protected __onResolverForKnobColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.Color>): void;
/**
* Returns the current value of KnobColor.
*/
getKnobColor(): TcHmi.Color | null | undefined;
/**
* Processes the current value of attribute KnobColor.
*/
protected __processKnobColor(): void;
/**
* Sets the knob color attribute.
* @param valueNew The new value for KnobColor.
*/
setKnobArrowsColor(valueNew: TcHmi.SolidColor | null): void;
/**
* The watch callback for the knobArrowsColor object resolver.
*/
protected __onResolverForKnobArrowsColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
/**
* Returns the current value of KnobColor.
*/
getKnobArrowsColor(): TcHmi.SolidColor | null | undefined;
/**
* Processes the current value of attribute KnobColor.
*/
protected __processKnobArrowsColor(): void;
/**
* Sets the value space attribute.
* @param valueNew The new value for valueSpace.
*/
setValueSpace(valueNew: number | null): void;
/**
* Returns the current value of valueSpace.
*/
getValueSpace(): number | undefined;
/**
* Processes the current value of attribute valueSpace.
* Remove min max space reservation and set width of the description element if the control is vertical oriented and valueSpace is defined.
*/
protected __processValueSpace(): void;
/**
* Sets the font size unit attribute.
* @param valueNew The new value for valueSpaceUnit.
*/
setValueSpaceUnit(valueNew: TcHmi.DimensionUnit | null): void;
/**
* Returns the current value of valueSpaceUnit.
*/
getValueSpaceUnit(): TcHmi.DimensionUnit | undefined;
/**
* Processes the current value of attribute textfontsizeunit.
*/
protected __processValueSpaceUnit(): void;
/**
* Sets the set point marker color attribute.
* @param valueNew The new value for set point marker color.
*/
setSetPointMarkerColor(valueNew: TcHmi.SolidColor | null): void;
/**
* The watch callback for the set point marker color object resolver.
*/
protected __onResolverForSetPointMarkerColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
/**
* Returns the current value of setPointMarkerColor.
*/
getSetPointMarkerColor(): TcHmi.SolidColor | null | undefined;
/**
* Processes the current value of attribute setPointMarkerColor.
*/
protected __processSetPointMarkerColor(): void;
}
export interface Range {
color: TcHmi.SolidColor;
start: number;
end: number;
}
export interface TickDefinition {
mainTickRange: number;
subTickRange: number;
}
export interface KnobConfig {
imagePath: string;
width: number;
height: number;
offsetX: number;
offsetY: number;
}
export interface Marker {
color: TcHmi.SolidColor;
label: string;
value: number;
}
export { TcHmiLinearGauge as Control };
declare const _TcHmiLinearGauge: typeof TcHmiLinearGauge;
type tTcHmiLinearGauge = TcHmiLinearGauge;
type tRange = Range;
type tTickDefinition = TickDefinition;
type tKnobConfig = KnobConfig;
type tMarker = Marker;
declare global {
namespace TcHmi.Controls.Beckhoff {
const TcHmiLinearGauge: typeof _TcHmiLinearGauge;
type TcHmiLinearGauge = tTcHmiLinearGauge;
namespace TcHmiLinearGauge {
type Range = tRange;
type TickDefinition = tTickDefinition;
type KnobConfig = tKnobConfig;
type Marker = tMarker;
}
}
}
//# sourceMappingURL=TcHmiLinearGauge.esm.d.ts.map