UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

427 lines (344 loc) 15.6 kB
/*! * devextreme-angular * Version: 24.2.6 * Build date: Mon Mar 17 2025 * * Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file in the root of the project for details. * * https://github.com/DevExpress/devextreme-angular */ import { TransferState, ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core'; import { DisposingEvent, DrawnEvent, ExportedEvent, ExportingEvent, FileSavingEvent, IncidentOccurredEvent, InitializedEvent, OptionChangedEvent, TooltipHiddenEvent, TooltipShownEvent } from 'devextreme/viz/bullet'; import { Theme, DashStyle, Font } from 'devextreme/common/charts'; import { Format } from 'devextreme/common/core/localization'; import DxBullet from 'devextreme/viz/bullet'; import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core'; import type * as DxBulletTypes from "devextreme/viz/bullet_types"; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/ui/nested"; import * as i2 from "devextreme-angular/ui/bullet/nested"; import * as i3 from "devextreme-angular/core"; /** * The Bullet UI component is useful when you need to compare a single measure to a target value. The UI component comprises a horizontal bar indicating the measure and a vertical line indicating the target value. */ export declare class DxBulletComponent extends DxComponent implements OnDestroy { instance: DxBullet; /** * Specifies a color for the bullet bar. */ get color(): string; set color(value: string); /** * Specifies whether the UI component responds to user interaction. */ get disabled(): boolean; set disabled(value: boolean); /** * Specifies the global attributes to be attached to the UI component&apos;s container element. */ get elementAttr(): Record<string, any>; set elementAttr(value: Record<string, any>); /** * Specifies an end value for the invisible scale. */ get endScaleValue(): number | undefined; set endScaleValue(value: number | undefined); /** * Generates space around the UI component. */ get margin(): { bottom?: number; left?: number; right?: number; top?: number; }; set margin(value: { bottom?: number; left?: number; right?: number; top?: number; }); /** * Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. */ get pathModified(): boolean; set pathModified(value: boolean); /** * Switches the UI component to a right-to-left representation. */ get rtlEnabled(): boolean; set rtlEnabled(value: boolean); /** * Specifies whether or not to show the target line. */ get showTarget(): boolean; set showTarget(value: boolean); /** * Specifies whether or not to show the line indicating zero on the invisible scale. */ get showZeroLevel(): boolean; set showZeroLevel(value: boolean); /** * Specifies the UI component&apos;s size in pixels. */ get size(): { height?: number | undefined; width?: number | undefined; }; set size(value: { height?: number | undefined; width?: number | undefined; }); /** * Specifies a start value for the invisible scale. */ get startScaleValue(): number; set startScaleValue(value: number); /** * Specifies the value indicated by the target line. */ get target(): number; set target(value: number); /** * Specifies a color for both the target and zero level lines. */ get targetColor(): string; set targetColor(value: string); /** * Specifies the width of the target line. */ get targetWidth(): number; set targetWidth(value: number); /** * Sets the name of the theme the UI component uses. */ get theme(): Theme; set theme(value: Theme); /** * Configures the tooltip. */ get tooltip(): { arrowLength?: number; border?: { color?: string; dashStyle?: DashStyle; opacity?: number | undefined; visible?: boolean; width?: number; }; color?: string; container?: any | string | undefined; contentTemplate?: any; cornerRadius?: number; customizeTooltip?: ((pointsInfo: any) => Record<string, any>) | undefined; enabled?: boolean; font?: Font; format?: Format | undefined; interactive?: boolean; opacity?: number | undefined; paddingLeftRight?: number; paddingTopBottom?: number; shadow?: { blur?: number; color?: string; offsetX?: number; offsetY?: number; opacity?: number; }; zIndex?: number | undefined; }; set tooltip(value: { arrowLength?: number; border?: { color?: string; dashStyle?: DashStyle; opacity?: number | undefined; visible?: boolean; width?: number; }; color?: string; container?: any | string | undefined; contentTemplate?: any; cornerRadius?: number; customizeTooltip?: ((pointsInfo: any) => Record<string, any>) | undefined; enabled?: boolean; font?: Font; format?: Format | undefined; interactive?: boolean; opacity?: number | undefined; paddingLeftRight?: number; paddingTopBottom?: number; shadow?: { blur?: number; color?: string; offsetX?: number; offsetY?: number; opacity?: number; }; zIndex?: number | undefined; }); /** * Specifies the primary value indicated by the bullet bar. */ get value(): number; set value(value: number); /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<DisposingEvent>; /** * A function that is executed when the UI component&apos;s rendering has finished. */ onDrawn: EventEmitter<DrawnEvent>; /** * A function that is executed after the UI component is exported. */ onExported: EventEmitter<ExportedEvent>; /** * A function that is executed before the UI component is exported. */ onExporting: EventEmitter<ExportingEvent>; /** * A function that is executed before a file with exported UI component is saved to the user&apos;s local storage. */ onFileSaving: EventEmitter<FileSavingEvent>; /** * A function that is executed when an error or warning occurs. */ onIncidentOccurred: EventEmitter<IncidentOccurredEvent>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<InitializedEvent>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<OptionChangedEvent>; /** * A function that is executed when a tooltip becomes hidden. */ onTooltipHidden: EventEmitter<TooltipHiddenEvent>; /** * A function that is executed when a tooltip appears. */ onTooltipShown: EventEmitter<TooltipShownEvent>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ colorChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter<Record<string, any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ endScaleValueChange: EventEmitter<number | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ marginChange: EventEmitter<{ bottom?: number; left?: number; right?: number; top?: number; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pathModifiedChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showTargetChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showZeroLevelChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ sizeChange: EventEmitter<{ height?: number | undefined; width?: number | undefined; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ startScaleValueChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ targetChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ targetColorChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ targetWidthChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ themeChange: EventEmitter<Theme>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tooltipChange: EventEmitter<{ arrowLength?: number; border?: { color?: string; dashStyle?: DashStyle; opacity?: number | undefined; visible?: boolean; width?: number; }; color?: string; container?: any | string | undefined; contentTemplate?: any; cornerRadius?: number; customizeTooltip?: ((pointsInfo: any) => Record<string, any>) | undefined; enabled?: boolean; font?: Font; format?: Format | undefined; interactive?: boolean; opacity?: number | undefined; paddingLeftRight?: number; paddingTopBottom?: number; shadow?: { blur?: number; color?: string; offsetX?: number; offsetY?: number; opacity?: number; }; zIndex?: number | undefined; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ valueChange: EventEmitter<number>; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxBullet; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<DxBulletComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxBulletComponent, "dx-bullet", never, { "color": { "alias": "color"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "elementAttr": { "alias": "elementAttr"; "required": false; }; "endScaleValue": { "alias": "endScaleValue"; "required": false; }; "margin": { "alias": "margin"; "required": false; }; "pathModified": { "alias": "pathModified"; "required": false; }; "rtlEnabled": { "alias": "rtlEnabled"; "required": false; }; "showTarget": { "alias": "showTarget"; "required": false; }; "showZeroLevel": { "alias": "showZeroLevel"; "required": false; }; "size": { "alias": "size"; "required": false; }; "startScaleValue": { "alias": "startScaleValue"; "required": false; }; "target": { "alias": "target"; "required": false; }; "targetColor": { "alias": "targetColor"; "required": false; }; "targetWidth": { "alias": "targetWidth"; "required": false; }; "theme": { "alias": "theme"; "required": false; }; "tooltip": { "alias": "tooltip"; "required": false; }; "value": { "alias": "value"; "required": false; }; }, { "onDisposing": "onDisposing"; "onDrawn": "onDrawn"; "onExported": "onExported"; "onExporting": "onExporting"; "onFileSaving": "onFileSaving"; "onIncidentOccurred": "onIncidentOccurred"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "onTooltipHidden": "onTooltipHidden"; "onTooltipShown": "onTooltipShown"; "colorChange": "colorChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "endScaleValueChange": "endScaleValueChange"; "marginChange": "marginChange"; "pathModifiedChange": "pathModifiedChange"; "rtlEnabledChange": "rtlEnabledChange"; "showTargetChange": "showTargetChange"; "showZeroLevelChange": "showZeroLevelChange"; "sizeChange": "sizeChange"; "startScaleValueChange": "startScaleValueChange"; "targetChange": "targetChange"; "targetColorChange": "targetColorChange"; "targetWidthChange": "targetWidthChange"; "themeChange": "themeChange"; "tooltipChange": "tooltipChange"; "valueChange": "valueChange"; }, never, never, false, never>; } export declare class DxBulletModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxBulletModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxBulletModule, [typeof DxBulletComponent], [typeof i1.DxoMarginModule, typeof i1.DxoSizeModule, typeof i1.DxoTooltipModule, typeof i1.DxoBorderModule, typeof i1.DxoFontModule, typeof i1.DxoFormatModule, typeof i1.DxoShadowModule, typeof i2.DxoBulletBorderModule, typeof i2.DxoBulletFontModule, typeof i2.DxoBulletFormatModule, typeof i2.DxoBulletMarginModule, typeof i2.DxoBulletShadowModule, typeof i2.DxoBulletSizeModule, typeof i2.DxoBulletTooltipModule, typeof i3.DxIntegrationModule, typeof i3.DxTemplateModule], [typeof DxBulletComponent, typeof i1.DxoMarginModule, typeof i1.DxoSizeModule, typeof i1.DxoTooltipModule, typeof i1.DxoBorderModule, typeof i1.DxoFontModule, typeof i1.DxoFormatModule, typeof i1.DxoShadowModule, typeof i2.DxoBulletBorderModule, typeof i2.DxoBulletFontModule, typeof i2.DxoBulletFormatModule, typeof i2.DxoBulletMarginModule, typeof i2.DxoBulletShadowModule, typeof i2.DxoBulletSizeModule, typeof i2.DxoBulletTooltipModule, typeof i3.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxBulletModule>; } export { DxBulletTypes };