devextreme-react 23.2.6 → 24.1.2-beta

package/cjs/linear-gauge.d.ts

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.6
- * Build date: Wed May 01 2024
+ * Version: 24.1.2-beta
+ * Build date: Mon May 13 2024
  *
  * Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
  *
@@ -11,18 +11,18 @@
  * https://github.com/DevExpress/devextreme-react
  */
 
-/// <reference types="react" />
+import * as React from "react";
+import { Ref, ReactElement } from "react";
 import dxLinearGauge, { Properties } from "devextreme/viz/linear_gauge";
-import { Component as BaseComponent, IHtmlOptions } from "./core/component";
-import NestedOption from "./core/nested-option";
+import { IHtmlOptions, IElementDescriptor } from "./core/component";
 import type { DisposingEvent, DrawnEvent, ExportedEvent, ExportingEvent, FileSavingEvent, IncidentOccurredEvent, InitializedEvent, TooltipHiddenEvent, TooltipShownEvent } from "devextreme/viz/linear_gauge";
 import type { Font as ChartsFont, ChartsColor } from "devextreme/common/charts";
 import type { template } from "devextreme/core/templates/template";
 import type * as LocalizationTypes from "devextreme/localization";
-declare type ReplaceFieldTypes<TSource, TReplacement> = {
+type ReplaceFieldTypes<TSource, TReplacement> = {
     [P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
 };
-declare type ILinearGaugeOptionsNarrowedEvents = {
+type ILinearGaugeOptionsNarrowedEvents = {
     onDisposing?: ((e: DisposingEvent) => void);
     onDrawn?: ((e: DrawnEvent) => void);
     onExported?: ((e: ExportedEvent) => void);
@@ -33,7 +33,7 @@ declare type ILinearGaugeOptionsNarrowedEvents = {
     onTooltipHidden?: ((e: TooltipHiddenEvent) => void);
     onTooltipShown?: ((e: TooltipShownEvent) => void);
 };
-declare type ILinearGaugeOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, ILinearGaugeOptionsNarrowedEvents> & IHtmlOptions & {
+type ILinearGaugeOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, ILinearGaugeOptionsNarrowedEvents> & IHtmlOptions & {
     defaultLoadingIndicator?: Record<string, any>;
     defaultSubvalues?: Array<number>;
     defaultValue?: number;
@@ -41,100 +41,41 @@ declare type ILinearGaugeOptions = React.PropsWithChildren<ReplaceFieldTypes<Pro
     onSubvaluesChange?: (value: Array<number>) => void;
     onValueChange?: (value: number) => void;
 }>;
-declare class LinearGauge extends BaseComponent<React.PropsWithChildren<ILinearGaugeOptions>> {
-    get instance(): dxLinearGauge;
-    protected _WidgetClass: typeof dxLinearGauge;
-    protected subscribableOptions: string[];
-    protected independentEvents: string[];
-    protected _defaults: {
-        defaultLoadingIndicator: string;
-        defaultSubvalues: string;
-        defaultValue: string;
-    };
-    protected _expectedChildren: {
-        animation: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        export: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        geometry: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        loadingIndicator: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        margin: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        rangeContainer: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        scale: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        size: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        subvalueIndicator: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        title: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tooltip: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        valueIndicator: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
+interface LinearGaugeRef {
+    instance: () => dxLinearGauge;
 }
-declare type IAnimationProps = React.PropsWithChildren<{
+declare const LinearGauge: (props: React.PropsWithChildren<ILinearGaugeOptions> & {
+    ref?: Ref<LinearGaugeRef>;
+}) => ReactElement | null;
+type IAnimationProps = React.PropsWithChildren<{
     duration?: number;
     easing?: "easeOutCubic" | "linear";
     enabled?: boolean;
 }>;
-declare class Animation extends NestedOption<IAnimationProps> {
-    static OptionName: string;
-}
-declare type IBackgroundColorProps = React.PropsWithChildren<{
+declare const _componentAnimation: React.MemoExoticComponent<(props: IAnimationProps) => React.FunctionComponentElement<IAnimationProps>>;
+declare const Animation: typeof _componentAnimation & IElementDescriptor;
+type IBackgroundColorProps = React.PropsWithChildren<{
     base?: string;
     fillId?: string;
 }>;
-declare class BackgroundColor extends NestedOption<IBackgroundColorProps> {
-    static OptionName: string;
-}
-declare type IBorderProps = React.PropsWithChildren<{
+declare const _componentBackgroundColor: React.MemoExoticComponent<(props: IBackgroundColorProps) => React.FunctionComponentElement<IBackgroundColorProps>>;
+declare const BackgroundColor: typeof _componentBackgroundColor & IElementDescriptor;
+type IBorderProps = React.PropsWithChildren<{
     color?: string;
     dashStyle?: "dash" | "dot" | "longDash" | "solid";
     opacity?: number;
     visible?: boolean;
     width?: number;
 }>;
-declare class Border extends NestedOption<IBorderProps> {
-    static OptionName: string;
-}
-declare type IColorProps = React.PropsWithChildren<{
+declare const _componentBorder: React.MemoExoticComponent<(props: IBorderProps) => React.FunctionComponentElement<IBorderProps>>;
+declare const Border: typeof _componentBorder & IElementDescriptor;
+type IColorProps = React.PropsWithChildren<{
     base?: string;
     fillId?: string;
 }>;
-declare class Color extends NestedOption<IColorProps> {
-    static OptionName: string;
-}
-declare type IExportProps = React.PropsWithChildren<{
+declare const _componentColor: React.MemoExoticComponent<(props: IColorProps) => React.FunctionComponentElement<IColorProps>>;
+declare const Color: typeof _componentColor & IElementDescriptor;
+type IExportProps = React.PropsWithChildren<{
     backgroundColor?: string;
     enabled?: boolean;
     fileName?: string;
@@ -143,20 +84,18 @@ declare type IExportProps = React.PropsWithChildren<{
     printingEnabled?: boolean;
     svgToCanvas?: ((svg: any, canvas: any) => any);
 }>;
-declare class Export extends NestedOption<IExportProps> {
-    static OptionName: string;
-}
-declare type IFontProps = React.PropsWithChildren<{
+declare const _componentExport: React.MemoExoticComponent<(props: IExportProps) => React.FunctionComponentElement<IExportProps>>;
+declare const Export: typeof _componentExport & IElementDescriptor;
+type IFontProps = React.PropsWithChildren<{
     color?: string;
     family?: string;
     opacity?: number;
     size?: number | string;
     weight?: number;
 }>;
-declare class Font extends NestedOption<IFontProps> {
-    static OptionName: string;
-}
-declare type IFormatProps = React.PropsWithChildren<{
+declare const _componentFont: React.MemoExoticComponent<(props: IFontProps) => React.FunctionComponentElement<IFontProps>>;
+declare const Font: typeof _componentFont & IElementDescriptor;
+type IFormatProps = React.PropsWithChildren<{
     currency?: string;
     formatter?: ((value: number | Date) => string);
     parser?: ((value: string) => number | Date);
@@ -164,16 +103,14 @@ declare type IFormatProps = React.PropsWithChildren<{
     type?: "billions" | "currency" | "day" | "decimal" | "exponential" | "fixedPoint" | "largeNumber" | "longDate" | "longTime" | "millions" | "millisecond" | "month" | "monthAndDay" | "monthAndYear" | "percent" | "quarter" | "quarterAndYear" | "shortDate" | "shortTime" | "thousands" | "trillions" | "year" | "dayOfWeek" | "hour" | "longDateLongTime" | "minute" | "second" | "shortDateShortTime";
     useCurrencyAccountingStyle?: boolean;
 }>;
-declare class Format extends NestedOption<IFormatProps> {
-    static OptionName: string;
-}
-declare type IGeometryProps = React.PropsWithChildren<{
+declare const _componentFormat: React.MemoExoticComponent<(props: IFormatProps) => React.FunctionComponentElement<IFormatProps>>;
+declare const Format: typeof _componentFormat & IElementDescriptor;
+type IGeometryProps = React.PropsWithChildren<{
     orientation?: "horizontal" | "vertical";
 }>;
-declare class Geometry extends NestedOption<IGeometryProps> {
-    static OptionName: string;
-}
-declare type ILabelProps = React.PropsWithChildren<{
+declare const _componentGeometry: React.MemoExoticComponent<(props: IGeometryProps) => React.FunctionComponentElement<IGeometryProps>>;
+declare const Geometry: typeof _componentGeometry & IElementDescriptor;
+type ILabelProps = React.PropsWithChildren<{
     customizeText?: ((scaleValue: {
         value: number;
         valueText: string;
@@ -185,20 +122,9 @@ declare type ILabelProps = React.PropsWithChildren<{
     useRangeColors?: boolean;
     visible?: boolean;
 }>;
-declare class Label extends NestedOption<ILabelProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        format: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ILoadingIndicatorProps = React.PropsWithChildren<{
+declare const _componentLabel: React.MemoExoticComponent<(props: ILabelProps) => React.FunctionComponentElement<ILabelProps>>;
+declare const Label: typeof _componentLabel & IElementDescriptor;
+type ILoadingIndicatorProps = React.PropsWithChildren<{
     backgroundColor?: string;
     font?: ChartsFont;
     show?: boolean;
@@ -206,53 +132,33 @@ declare type ILoadingIndicatorProps = React.PropsWithChildren<{
     defaultShow?: boolean;
     onShowChange?: (value: boolean) => void;
 }>;
-declare class LoadingIndicator extends NestedOption<ILoadingIndicatorProps> {
-    static OptionName: string;
-    static DefaultsProps: {
-        defaultShow: string;
-    };
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IMarginProps = React.PropsWithChildren<{
+declare const _componentLoadingIndicator: React.MemoExoticComponent<(props: ILoadingIndicatorProps) => React.FunctionComponentElement<ILoadingIndicatorProps>>;
+declare const LoadingIndicator: typeof _componentLoadingIndicator & IElementDescriptor;
+type IMarginProps = React.PropsWithChildren<{
     bottom?: number;
     left?: number;
     right?: number;
     top?: number;
 }>;
-declare class Margin extends NestedOption<IMarginProps> {
-    static OptionName: string;
-}
-declare type IMinorTickProps = React.PropsWithChildren<{
+declare const _componentMargin: React.MemoExoticComponent<(props: IMarginProps) => React.FunctionComponentElement<IMarginProps>>;
+declare const Margin: typeof _componentMargin & IElementDescriptor;
+type IMinorTickProps = React.PropsWithChildren<{
     color?: string;
     length?: number;
     opacity?: number;
     visible?: boolean;
     width?: number;
 }>;
-declare class MinorTick extends NestedOption<IMinorTickProps> {
-    static OptionName: string;
-}
-declare type IRangeProps = React.PropsWithChildren<{
+declare const _componentMinorTick: React.MemoExoticComponent<(props: IMinorTickProps) => React.FunctionComponentElement<IMinorTickProps>>;
+declare const MinorTick: typeof _componentMinorTick & IElementDescriptor;
+type IRangeProps = React.PropsWithChildren<{
     color?: ChartsColor | string;
     endValue?: number;
     startValue?: number;
 }>;
-declare class Range extends NestedOption<IRangeProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-    static ExpectedChildren: {
-        color: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IRangeContainerProps = React.PropsWithChildren<{
+declare const _componentRange: React.MemoExoticComponent<(props: IRangeProps) => React.FunctionComponentElement<IRangeProps>>;
+declare const Range: typeof _componentRange & IElementDescriptor;
+type IRangeContainerProps = React.PropsWithChildren<{
     backgroundColor?: ChartsColor | string;
     horizontalOrientation?: "center" | "left" | "right";
     offset?: number;
@@ -269,24 +175,9 @@ declare type IRangeContainerProps = React.PropsWithChildren<{
         start?: number;
     };
 }>;
-declare class RangeContainer extends NestedOption<IRangeContainerProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        backgroundColor: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        range: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        width: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IScaleProps = React.PropsWithChildren<{
+declare const _componentRangeContainer: React.MemoExoticComponent<(props: IRangeContainerProps) => React.FunctionComponentElement<IRangeContainerProps>>;
+declare const RangeContainer: typeof _componentRangeContainer & IElementDescriptor;
+type IScaleProps = React.PropsWithChildren<{
     allowDecimals?: boolean;
     customMinorTicks?: Array<number>;
     customTicks?: Array<number>;
@@ -324,57 +215,33 @@ declare type IScaleProps = React.PropsWithChildren<{
     tickInterval?: number;
     verticalOrientation?: "bottom" | "center" | "top";
 }>;
-declare class Scale extends NestedOption<IScaleProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        label: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        minorTick: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tick: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IShadowProps = React.PropsWithChildren<{
+declare const _componentScale: React.MemoExoticComponent<(props: IScaleProps) => React.FunctionComponentElement<IScaleProps>>;
+declare const Scale: typeof _componentScale & IElementDescriptor;
+type IShadowProps = React.PropsWithChildren<{
     blur?: number;
     color?: string;
     offsetX?: number;
     offsetY?: number;
     opacity?: number;
 }>;
-declare class Shadow extends NestedOption<IShadowProps> {
-    static OptionName: string;
-}
-declare type ISizeProps = React.PropsWithChildren<{
+declare const _componentShadow: React.MemoExoticComponent<(props: IShadowProps) => React.FunctionComponentElement<IShadowProps>>;
+declare const Shadow: typeof _componentShadow & IElementDescriptor;
+type ISizeProps = React.PropsWithChildren<{
     height?: number;
     width?: number;
 }>;
-declare class Size extends NestedOption<ISizeProps> {
-    static OptionName: string;
-}
-declare type ISubtitleProps = React.PropsWithChildren<{
+declare const _componentSize: React.MemoExoticComponent<(props: ISizeProps) => React.FunctionComponentElement<ISizeProps>>;
+declare const Size: typeof _componentSize & IElementDescriptor;
+type ISubtitleProps = React.PropsWithChildren<{
     font?: ChartsFont;
     offset?: number;
     text?: string;
     textOverflow?: "ellipsis" | "hide" | "none";
     wordWrap?: "normal" | "breakWord" | "none";
 }>;
-declare class Subtitle extends NestedOption<ISubtitleProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ISubvalueIndicatorProps = React.PropsWithChildren<{
+declare const _componentSubtitle: React.MemoExoticComponent<(props: ISubtitleProps) => React.FunctionComponentElement<ISubtitleProps>>;
+declare const Subtitle: typeof _componentSubtitle & IElementDescriptor;
+type ISubvalueIndicatorProps = React.PropsWithChildren<{
     arrowLength?: number;
     backgroundColor?: string;
     baseValue?: number;
@@ -403,20 +270,9 @@ declare type ISubvalueIndicatorProps = React.PropsWithChildren<{
     verticalOrientation?: "bottom" | "top";
     width?: number;
 }>;
-declare class SubvalueIndicator extends NestedOption<ISubvalueIndicatorProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        color: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        text: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ITextProps = React.PropsWithChildren<{
+declare const _componentSubvalueIndicator: React.MemoExoticComponent<(props: ISubvalueIndicatorProps) => React.FunctionComponentElement<ISubvalueIndicatorProps>>;
+declare const SubvalueIndicator: typeof _componentSubvalueIndicator & IElementDescriptor;
+type ITextProps = React.PropsWithChildren<{
     customizeText?: ((indicatedValue: {
         value: number;
         valueText: string;
@@ -425,30 +281,18 @@ declare type ITextProps = React.PropsWithChildren<{
     format?: LocalizationTypes.Format;
     indent?: number;
 }>;
-declare class Text extends NestedOption<ITextProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        format: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ITickProps = React.PropsWithChildren<{
+declare const _componentText: React.MemoExoticComponent<(props: ITextProps) => React.FunctionComponentElement<ITextProps>>;
+declare const Text: typeof _componentText & IElementDescriptor;
+type ITickProps = React.PropsWithChildren<{
     color?: string;
     length?: number;
     opacity?: number;
     visible?: boolean;
     width?: number;
 }>;
-declare class Tick extends NestedOption<ITickProps> {
-    static OptionName: string;
-}
-declare type ITitleProps = React.PropsWithChildren<{
+declare const _componentTick: React.MemoExoticComponent<(props: ITickProps) => React.FunctionComponentElement<ITickProps>>;
+declare const Tick: typeof _componentTick & IElementDescriptor;
+type ITitleProps = React.PropsWithChildren<{
     font?: ChartsFont;
     horizontalAlignment?: "center" | "left" | "right";
     margin?: number | Record<string, any> | {
@@ -470,24 +314,9 @@ declare type ITitleProps = React.PropsWithChildren<{
     verticalAlignment?: "bottom" | "top";
     wordWrap?: "normal" | "breakWord" | "none";
 }>;
-declare class Title extends NestedOption<ITitleProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        margin: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        subtitle: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ITooltipProps = React.PropsWithChildren<{
+declare const _componentTitle: React.MemoExoticComponent<(props: ITitleProps) => React.FunctionComponentElement<ITitleProps>>;
+declare const Title: typeof _componentTitle & IElementDescriptor;
+type ITooltipProps = React.PropsWithChildren<{
     arrowLength?: number;
     border?: Record<string, any> | {
         color?: string;
@@ -524,36 +353,10 @@ declare type ITooltipProps = React.PropsWithChildren<{
     zIndex?: number;
     contentRender?: (...params: any) => React.ReactNode;
     contentComponent?: React.ComponentType<any>;
-    contentKeyFn?: (data: any) => string;
 }>;
-declare class Tooltip extends NestedOption<ITooltipProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        border: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        format: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        shadow: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type IValueIndicatorProps = React.PropsWithChildren<{
+declare const _componentTooltip: React.MemoExoticComponent<(props: ITooltipProps) => React.FunctionComponentElement<ITooltipProps>>;
+declare const Tooltip: typeof _componentTooltip & IElementDescriptor;
+type IValueIndicatorProps = React.PropsWithChildren<{
     arrowLength?: number;
     backgroundColor?: string;
     baseValue?: number;
@@ -582,17 +385,15 @@ declare type IValueIndicatorProps = React.PropsWithChildren<{
     verticalOrientation?: "bottom" | "top";
     width?: number;
 }>;
-declare class ValueIndicator extends NestedOption<IValueIndicatorProps> {
-    static OptionName: string;
-}
-declare type IWidthProps = React.PropsWithChildren<{
+declare const _componentValueIndicator: React.MemoExoticComponent<(props: IValueIndicatorProps) => React.FunctionComponentElement<IValueIndicatorProps>>;
+declare const ValueIndicator: typeof _componentValueIndicator & IElementDescriptor;
+type IWidthProps = React.PropsWithChildren<{
     end?: number;
     start?: number;
 }>;
-declare class Width extends NestedOption<IWidthProps> {
-    static OptionName: string;
-}
+declare const _componentWidth: React.MemoExoticComponent<(props: IWidthProps) => React.FunctionComponentElement<IWidthProps>>;
+declare const Width: typeof _componentWidth & IElementDescriptor;
 export default LinearGauge;
-export { LinearGauge, ILinearGaugeOptions, Animation, IAnimationProps, BackgroundColor, IBackgroundColorProps, Border, IBorderProps, Color, IColorProps, Export, IExportProps, Font, IFontProps, Format, IFormatProps, Geometry, IGeometryProps, Label, ILabelProps, LoadingIndicator, ILoadingIndicatorProps, Margin, IMarginProps, MinorTick, IMinorTickProps, Range, IRangeProps, RangeContainer, IRangeContainerProps, Scale, IScaleProps, Shadow, IShadowProps, Size, ISizeProps, Subtitle, ISubtitleProps, SubvalueIndicator, ISubvalueIndicatorProps, Text, ITextProps, Tick, ITickProps, Title, ITitleProps, Tooltip, ITooltipProps, ValueIndicator, IValueIndicatorProps, Width, IWidthProps };
+export { LinearGauge, ILinearGaugeOptions, LinearGaugeRef, Animation, IAnimationProps, BackgroundColor, IBackgroundColorProps, Border, IBorderProps, Color, IColorProps, Export, IExportProps, Font, IFontProps, Format, IFormatProps, Geometry, IGeometryProps, Label, ILabelProps, LoadingIndicator, ILoadingIndicatorProps, Margin, IMarginProps, MinorTick, IMinorTickProps, Range, IRangeProps, RangeContainer, IRangeContainerProps, Scale, IScaleProps, Shadow, IShadowProps, Size, ISizeProps, Subtitle, ISubtitleProps, SubvalueIndicator, ISubvalueIndicatorProps, Text, ITextProps, Tick, ITickProps, Title, ITitleProps, Tooltip, ITooltipProps, ValueIndicator, IValueIndicatorProps, Width, IWidthProps };
 import type * as LinearGaugeTypes from 'devextreme/viz/linear_gauge_types';
 export { LinearGaugeTypes };