packageDocumentation module public export interface DateFormatter { formateDate : ( day : Date ) => string ; parseDate ? : ( dateString : string ) => Date | undefined ; } public export enum AlternateDateFormats { None = 0 , IsoShort = 1 , IsoDateTime , UtcShort , UtcDateTime , UtcShortWithDay , UtcDateTimeWithDay } public export enum TimeDisplay { H12MC = "hh:mm aa" , H12MSC = "hh:mm:ss aa" , H24M = "hh:mm" , H24MS = "hh:mm:ss" } public export enum PropertyEditorParamTypes { ButtonGroupData = "UiAbstract-ButtonGroupData" , CheckBoxIcons = "UiAbstract-CheckBoxIcons" , Icon = "UiAbstract-Icon" , InputEditorSize = "UiAbstract-InputEditorSize" , ColorData = "UiAbstract-ColorData" , CustomFormattedNumber = "UiAbstract-CustomFormattedNumber" , IconListData = "UiAbstract-IconListData" , MultilineText = "UiAbstract-MultilineText" , Range = "UiAbstract-Range" , Slider = "UiAbstract-Slider" , SuppressEditorLabel = "UiAbstract-SuppressEditorLabel" , CheckBoxImages = "UiAbstract-CheckBoxImages" } public export interface BasePropertyEditorParams { type : string ; } public public export interface InputEditorSizeParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . InputEditorSize ; /** Optionally define the width in characters. */ size ? : number ; /** Optionally define the maximum number of characters allowed. */ maxLength ? : number ; } public export const isInputEditorSizeParams = ( item ) : item is InputEditorSizeParams => { return item . type === PropertyEditorParamTypes . InputEditorSize ; } ; public export interface ColorEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . ColorData ; /** array of color values to show in color picker popup. Use [[ColorByName]] enum values. Values should be 32-bit integer in the form 0xBBGGRR. */ colorValues : number [ ] ; /** number of columns to show in color picker popup. The value of 4 is used if not defined. */ numColumns ? : number ; } public export const isColorEditorParams = ( item ) : item is ColorEditorParams => { return item . type === PropertyEditorParamTypes . ColorData ; } ; public export interface IconListEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . IconListData ; /** active icon shown in the button */ iconValue : string ; /** array of icon (svg) names to show in icon picker popup. */ iconValues : string [ ] ; /** number of columns to show in icon picker popup. The value of 4 is used if not defined. */ numColumns ? : number ; } public export const isIconListEditorParams = ( item ) : item is IconListEditorParams => { return item . type === PropertyEditorParamTypes . IconListData ; } ; public export interface IconDefinition { /** Icon specification. The value is the name of an icon WebFont entry, or if specifying an SVG symbol, use `svg:` prefix. */ iconSpec : string ; /** Function to determine if the item is enabled. */ isEnabledFunction ? : ( ) => boolean ; } public export interface ButtonGroupEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . ButtonGroupData ; buttons : IconDefinition [ ] ; } public export const isButtonGroupEditorParams = ( item ) : item is ButtonGroupEditorParams => { return item . type === PropertyEditorParamTypes . ButtonGroupData ; } ; public export interface SuppressLabelEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . SuppressEditorLabel ; /** if false then an empty placeholder label is created. This is sometimes necessary to align editor in proper column */ suppressLabelPlaceholder ? : boolean ; } public export const isSuppressLabelEditorParams = ( item ) : item is SuppressLabelEditorParams => { return item . type === PropertyEditorParamTypes . SuppressEditorLabel ; } ; public export interface RangeEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . Range ; /** Defines the minimum value. Default is Number.MIN_SAFE_INTEGER. */ minimum ? : number ; /** Defines the maximum value. Default is Number.MAX_SAFE_INTEGER. */ maximum ? : number ; /** Defines the step value. Default is 1. */ step ? : number ; /** Defines the precision. Default is 0. */ precision ? : number ; } public export interface SliderEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . Slider ; /** Defines the minimum value. */ minimum : number ; /** Defines the maximum value. */ maximum : number ; /** Optionally define the width in pixels. */ size ? : number ; /** Step value. Default is 0.1. */ step ? : number ; /** The interaction mode. Default is 1. Possible values:
     * 1 - allows handles to cross each other.
     * 2 - keeps the sliders from crossing and separated by a step.
     */ mode ? : number ; /** Indicates whether the display of the Slider values is reversed. */ reversed ? : boolean ; /** Indicates whether to show tooltip with the value. The tooltip will be positioned above the Slider, by default. */ showTooltip ? : boolean ; /** Indicates whether the tooltip should show below the Slider instead of above. */ tooltipBelow ? : boolean ; /** Format a value for the tooltip */ formatTooltip ? : ( value : number ) => string ; /** Indicates whether to show min & max values to the left & right of the Slider. */ showMinMax ? : boolean ; /** Image to show for min. */ minIconSpec ? : string ; /** Image to show for max. */ maxIconSpec ? : string ; /** Indicates whether to show tick marks under the Slider. */ showTicks ? : boolean ; /** Indicates whether to show tick labels under the tick marks. */ showTickLabels ? : boolean ; /** Format a tick mark value */ formatTick ? : ( tick : number ) => string ; /** Function to get the tick count. The default tick count is 10. */ getTickCount ? : ( ) => number ; /** Function to get the tick values. This overrides the tick count from getTickCount.
     * Use this prop if you want to specify your own tick values instead of ticks generated by the slider.
     * The numbers should be valid numbers in the domain and correspond to the step value.
     * Invalid values will be coerced to the closet matching value in the domain.
     */ getTickValues ? : ( ) => number [ ] ; } public export interface MultilineTextEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . MultilineText ; rows : number ; } public export interface IconEditorParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . Icon ; definition : IconDefinition ; } public export interface ImageCheckBoxParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . CheckBoxImages ; imageOn : string ; imageOff : string ; } public export interface ParseResults { value ? : string | number | boolean | { } | string [ ] | Date | [ ] | undefined ; parseError ? : string ; } public export interface CustomFormattedNumberParams extends BasePropertyEditorParams { type : PropertyEditorParamTypes . CustomFormattedNumber ; formatFunction : ( numberValue : number ) => string ; parseFunction : ( stringValue : string ) => ParseResults ; } public export const isCustomFormattedNumberParams = ( item ) : item is CustomFormattedNumberParams => { return item . type === PropertyEditorParamTypes . CustomFormattedNumber ; } ; public export type PropertyEditorParams = BasePropertyEditorParams ;