smart-webcomponents-angular
Version:
[](https://jqwidgets.com/license/)
84 lines (83 loc) • 7.02 kB
TypeScript
import { CircularProgressBar } from './../index';
import { Animation } 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, ElementRenderMode } from './../index';
export { Smart } from './smart.element';
export { CircularProgressBar } from './../index';
export declare class CircularProgressBarComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges {
constructor(ref: ElementRef<CircularProgressBar>);
private eventHandlers;
nativeElement: CircularProgressBar;
/** @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 Specifies or retrieves the current animation mode. When set to 'none', all animations are disabled. For other values, animations are enabled according to the specified mode. */
get animation(): Animation | string;
set animation(value: Animation | string);
/** @description Specifies whether the element is interactive and can be used by the user. When enabled, the element is active and can receive user input; when disabled, the element is inactive and user interaction is prevented. */
get disabled(): boolean;
set disabled(value: boolean);
/** @description Sets the value of the Circular Progress bar to an indeterminate state (null), indicating that progress is ongoing without a specific completion percentage. This action also initiates the progress bar’s continuous animation, signaling that a task is in progress but the duration or endpoint is unknown. */
get formatFunction(): {
(value: number): string;
};
set formatFunction(value: {
(value: number): string;
});
/** @description Specifies the direction in which the Circular Progress Bar fills as progress increases, such as clockwise or counterclockwise. */
get indeterminate(): boolean;
set indeterminate(value: boolean);
/** @description Retrieves or assigns the unlockKey, a unique value required to unlock access to the product features or content. */
get inverted(): boolean;
set inverted(value: boolean);
/** @description Specifies or retrieves the current language in use. This property is typically used together with the messages property to determine which set of localized messages should be displayed based on the selected language. Setting this property changes the language context for retrieving appropriate translated content. */
get unlockKey(): string;
set unlockKey(value: string);
/** @description Callback function associated with the localization module, typically used to handle events or processes such as language changes, translation updates, or formatting adjustments based on user locale. */
get locale(): string;
set locale(value: string);
/** @description Defines the maximum value that the progress bar can represent, determining the upper limit for the progress indicator. Values above this threshold will be capped at this maximum. */
get localizeFormatFunction(): any;
set localizeFormatFunction(value: any);
/** @description Defines or retrieves an object containing customizable strings used throughout the widget’s user interface, enabling support for multiple languages. This property works together with the locale property to provide localized text displayed in the widget, such as labels, tooltips, and messages. Use this object to supply translations and override the default UI text for different languages or regions. */
get max(): number;
set max(value: number);
/** @description Defines the lowest value that the progress bar can represent, establishing the starting point of the progress range. This value determines the minimum limit for the progress indicator. */
get messages(): any;
set messages(value: any);
/** @description Controls whether the label is displayed on the Progress Bar. When enabled, the label will be shown; when disabled, the label will be hidden. */
get min(): number;
set min(value: number);
/** @description Sets or retrieves a value that determines whether the element’s alignment supports right-to-left (RTL) text direction, which is commonly used in languages such as Arabic or Hebrew. This property ensures the element displays content appropriately for RTL locales. */
get showProgressValue(): boolean;
set showProgressValue(value: boolean);
/** @description Specifies the theme to be applied to the element, controlling its overall visual appearance—including colors, fonts, and styling. The selected theme determines how the element is displayed, ensuring consistency with the application's design guidelines. */
get rightToLeft(): boolean;
set rightToLeft(value: boolean);
/** @description When set to true, this property prevents the element from receiving keyboard focus, making it inaccessible via tab navigation or programmatic focus calls. */
get theme(): string;
set theme(value: string);
/** @description Sets or retrieves the current numerical value of the progress bar, representing the completion level of the task as a number within the defined minimum and maximum range. */
get unfocusable(): boolean;
set unfocusable(value: boolean);
/** @description undefined */
get value(): number;
set value(value: number);
/** @description This event is triggered whenever the value associated with this element changes, either through user input or programmatic updates. It allows you to respond dynamically whenever the value is modified.
* @param event. The custom event. */
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<CircularProgressBarComponent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<CircularProgressBarComponent, "smart-circular-progress-bar, [smart-circular-progress-bar]", ["smart-circular-progress-bar"], { "animation": "animation"; "disabled": "disabled"; "formatFunction": "formatFunction"; "indeterminate": "indeterminate"; "inverted": "inverted"; "unlockKey": "unlockKey"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "max": "max"; "messages": "messages"; "min": "min"; "showProgressValue": "showProgressValue"; "rightToLeft": "rightToLeft"; "theme": "theme"; "unfocusable": "unfocusable"; "value": "value"; }, { "onChange": "onChange"; }, never>;
}