smart-webcomponents-react
Version:
[](https://jqwidgets.com/license/)
129 lines (128 loc) • 4.71 kB
TypeScript
import React from "react";
import { CircularProgressBarProperties } from "./../index";
import { Animation } from './../index';
export { CircularProgressBarProperties } from "./../index";
export { Animation } from './../index';
declare let Smart: any;
export { Smart };
export interface CircularProgressBarProps extends CircularProgressBarProperties {
className?: string;
style?: React.CSSProperties;
onChange?: ((event?: Event) => void) | undefined;
onCreate?: ((event?: Event) => void) | undefined;
onReady?: ((event?: Event) => void) | undefined;
}
/**
Progress Bar displayed as a circle.
*/
export declare class CircularProgressBar extends React.Component<React.HTMLAttributes<Element> & CircularProgressBarProps, any> {
private _id;
private nativeElement;
private componentRef;
get id(): string;
/** Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
* Property type: Animation | string
*/
get animation(): Animation | string;
set animation(value: Animation | string);
/** Enables or disables the element.
* Property type: boolean
*/
get disabled(): boolean;
set disabled(value: boolean);
/** Sets the value of the Circular Progress bar to indeterminate state(null) and starts the animation.
* Property type: {(value: number): string}
*/
get formatFunction(): {
(value: number): string;
};
set formatFunction(value: {
(value: number): string;
});
/** Sets the filling direction of the Circular Progress Bar.
* Property type: boolean
*/
get indeterminate(): boolean;
set indeterminate(value: boolean);
/** Sets or gets the unlockKey which unlocks the product.
* Property type: boolean
*/
get inverted(): boolean;
set inverted(value: boolean);
/** Sets or gets the language. Used in conjunction with the property messages.
* Property type: string
*/
get unlockKey(): string;
set unlockKey(value: string);
/** Callback, related to localization module.
* Property type: string
*/
get locale(): string;
set locale(value: string);
/** Sets progress bars maximum possible value.
* Property type: any
*/
get localizeFormatFunction(): any;
set localizeFormatFunction(value: any);
/** Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
* Property type: number
*/
get max(): number;
set max(value: number);
/** Sets progress bars minimum possible value.
* Property type: any
*/
get messages(): any;
set messages(value: any);
/** Enables/Disabled the label for the Progress Bar.
* Property type: number
*/
get min(): number;
set min(value: number);
/** Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
* Property type: boolean
*/
get showProgressValue(): boolean;
set showProgressValue(value: boolean);
/** Determines the theme. Theme defines the look of the element
* Property type: boolean
*/
get rightToLeft(): boolean;
set rightToLeft(value: boolean);
/** If is set to true, the element cannot be focused.
* Property type: string
*/
get theme(): string;
set theme(value: string);
/** Sets or gets the value of the progress bar
* Property type: boolean
*/
get unfocusable(): boolean;
set unfocusable(value: boolean);
/** undefined
* Property type: number
*/
get value(): number;
set value(value: number);
get properties(): string[];
/** This event is triggered when the value is changed.
* @param event. The custom event. */
onChange?: ((event?: Event) => void) | undefined;
/** This event occurs, when the React component is created.
* @param event. The custom event. */
onCreate?: ((event?: Event) => void) | undefined;
/** This event occurs, when the React component is completely rendered.
* @param event. The custom event. */
onReady?: ((event?: Event) => void) | undefined;
get eventListeners(): string[];
constructor(props: any);
componentDidRender(initialize: boolean): void;
componentDidMount(): void;
componentDidUpdate(): void;
componentWillUnmount(): void;
render(): React.ReactElement<{
ref: any;
suppressHydrationWarning: boolean;
}, string | React.JSXElementConstructor<any>>;
}
export default CircularProgressBar;