smart-webcomponents-angular/led/smart.led.d.ts

[](https://jqwidgets.com/license/)

import { Led } from './../index';
import { Animation, ClickMode, LedShape } from './../index';
import { AfterViewInit, ElementRef, OnInit, OnChanges, OnDestroy, SimpleChanges, EventEmitter } from '@angular/core';
import { BaseElement } from './smart.element';
import * as i0 from "@angular/core";
export { Animation, ClickMode, LedShape, ElementRenderMode } from './../index';
export { Smart } from './smart.element';
export { Led } from './../index';
export declare class LedComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges {
    constructor(ref: ElementRef<Led>);
    private eventHandlers;
    nativeElement: Led;
    /** @description Creates the component on demand.
     * @param properties An optional object of properties, which will be added to the template binded ones.
     */
    createComponent(properties?: {}): any;
    /** @description Sets or retrieves the current animation mode. When this property is set to 'none', all animations are disabled, and elements will display or update instantly without any transition effects. For other values, the specified animation mode will determine how visual changes are animated. */
    get animation(): Animation | string;
    set animation(value: Animation | string);
    /** @description Gets the current check state or sets it to a specified value, typically used for checkbox, radio button, or similar UI elements. The check state indicates whether the element is checked, unchecked, or (if supported) in an indeterminate state. */
    get checked(): boolean;
    set checked(value: boolean);
    /** @description Specifies the conditions under which the element will trigger a click event, allowing you to control when and how user interactions or programmatic actions cause the click event to be fired. */
    get clickMode(): ClickMode | string;
    set clickMode(value: ClickMode | string);
    /** @description Controls the LED's power state by enabling (turning on) or disabling (turning off) the LED. */
    get disabled(): boolean;
    set disabled(value: boolean);
    /** @description Specifies the content to be displayed when the state is set to 'false'. */
    get falseContent(): string;
    set falseContent(value: string);
    /** @description Defines a custom template that determines the LED's appearance or behavior when it is in the "off" or false state. */
    get falseTemplate(): any;
    set falseTemplate(value: any);
    /** @description Configures the LED to display an indeterminate state, typically represented by a blinking or animated pattern to indicate ongoing activity or a process with an unknown completion time. This is useful for scenarios where the system cannot determine or communicate a specific status or progress value. */
    get indeterminate(): boolean;
    set indeterminate(value: boolean);
    /** @description Defines the content to be displayed when the component is in a 'null' or empty state, such as when no data is available or the value is undefined. */
    get indeterminateContent(): string;
    set indeterminateContent(value: string);
    /** @description Defines a custom template to visually represent the LED component when it is in an indeterminate state, allowing you to specify the appearance or behavior of the LED during this undefined or transitional state. */
    get indeterminateTemplate(): any;
    set indeterminateTemplate(value: any);
    /** @description Sets or retrieves the unlockKey, a unique identifier or code required to unlock access to the product. This property allows you to manage product access by specifying or obtaining the key needed for unlocking restricted features or content. */
    get unlockKey(): string;
    set unlockKey(value: string);
    /** @description Specifies or retrieves the current language setting for localization purposes. This property works together with the messages property to display interface text and messages in the selected language. When you set this property, the corresponding localized messages from messages are used throughout the application. */
    get locale(): string;
    set locale(value: string);
    /** @description A callback function that allows you to customize the formatting of messages returned by the Localization Module. Use this to modify or enhance localized messages—such as applying custom templates, injecting dynamic content, or adjusting formatting—before they are delivered to the user interface. */
    get localizeFormatFunction(): any;
    set localizeFormatFunction(value: any);
    /** @description Defines or retrieves an object containing localized strings used by the widget's user interface, such as labels, messages, and tooltips. This property works in tandem with the locale property to enable support for multiple languages, allowing developers to customize text displayed to users based on their selected language or region. */
    get messages(): any;
    set messages(value: any);
    /** @description Sets or retrieves the value of the element's name attribute. The name attribute is used to identify form elements when submitting HTML forms, allowing their values to be sent to the server as key-value pairs. This attribute is essential for collecting user input in form processing. */
    get name(): string;
    set name(value: string);
    /** @description If the widget is set to read-only, users will be unable to interact with the element or modify its contents. All input and editing functionalities will be disabled, ensuring that the information displayed remains unchanged by the user. */
    get readonly(): boolean;
    set readonly(value: boolean);
    /** @description Sets or retrieves the value that determines whether the element’s content is aligned to support languages that use right-to-left (RTL) scripts, such as Arabic or Hebrew. This property ensures proper text direction and alignment for locales requiring RTL formatting. */
    get rightToLeft(): boolean;
    set rightToLeft(value: boolean);
    /** @description Specifies the geometric shape or appearance of the LED component, such as circle, square, rectangle, or custom shapes. This setting determines how the LED will be visually rendered in the user interface. */
    get shape(): LedShape | string;
    set shape(value: LedShape | string);
    /** @description Specifies the theme to be applied, which controls the visual appearance—such as colors, fonts, and styles—of the element. The selected theme ensures a consistent and cohesive look and feel across the user interface. */
    get theme(): string;
    set theme(value: string);
    /** @description Specifies the content that will be displayed or rendered when the associated state is evaluated as 'true'. */
    get trueContent(): string;
    set trueContent(value: string);
    /** @description Specifies a custom template that defines the behavior or appearance of the LED when its state is set to "true" (on). Use this template to customize how the LED should be displayed or controlled when activated. */
    get trueTemplate(): any;
    set trueTemplate(value: any);
    /** @description When set to true, this property prevents the element from receiving keyboard focus, making it inaccessible via tab navigation or scripting methods such as element.focus(). */
    get unfocusable(): boolean;
    set unfocusable(value: boolean);
    /** @description Sets a new value for the element or retrieves its current value, depending on whether an argument is provided. This is commonly used for form elements such as input, select, or textarea to programmatically update or access their contents. */
    get value(): string;
    set value(value: string);
    /** @description This event is triggered whenever the widget’s checked state changes, that is, when the user selects (checks) or deselects (unchecks) the widget. It allows you to execute custom logic in response to the widget being either checked or unchecked.
    *  @param event. The custom event. 	Custom event was created with: event.detail(	oldValue, 	value)
    *   oldValue - The previous value of the element before it was changed.
    *   value - The new value of the element.
    */
    onChange: EventEmitter<CustomEvent>;
    get isRendered(): boolean;
    ngOnInit(): void;
    ngAfterViewInit(): void;
    ngOnDestroy(): void;
    ngOnChanges(changes: SimpleChanges): void;
    /** @description Add event listeners. */
    private listen;
    /** @description Remove event listeners. */
    private unlisten;
    static ɵfac: i0.ɵɵFactoryDeclaration<LedComponent, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<LedComponent, "smart-led, [smart-led]", ["smart-led"], { "animation": "animation"; "checked": "checked"; "clickMode": "clickMode"; "disabled": "disabled"; "falseContent": "falseContent"; "falseTemplate": "falseTemplate"; "indeterminate": "indeterminate"; "indeterminateContent": "indeterminateContent"; "indeterminateTemplate": "indeterminateTemplate"; "unlockKey": "unlockKey"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "name": "name"; "readonly": "readonly"; "rightToLeft": "rightToLeft"; "shape": "shape"; "theme": "theme"; "trueContent": "trueContent"; "trueTemplate": "trueTemplate"; "unfocusable": "unfocusable"; "value": "value"; }, { "onChange": "onChange"; }, never>;
}