survey-react 1.9.115 → 1.9.116

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/survey.react.d.ts CHANGED
@@ -1343,13 +1343,13 @@ declare module "actions/action" {
1343
1343
  *
1344
1344
  * Action items are used in the Toolbar, matrix rows, titles of pages, panels, questions, and other survey elements.
1345
1345
  *
1346
- * [View Demo](/form-library/examples/add-custom-navigation-button/ (linkStyle))
1346
+ * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
1347
1347
  */
1348
1348
  export interface IAction {
1349
1349
  /**
1350
1350
  * A unique action item identifier.
1351
1351
  *
1352
- * [View Demo](/form-library/examples/add-custom-navigation-button/ (linkStyle))
1352
+ * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
1353
1353
  */
1354
1354
  id?: string;
1355
1355
  /**
@@ -1361,7 +1361,7 @@ declare module "actions/action" {
1361
1361
  /**
1362
1362
  * The action item's title.
1363
1363
  *
1364
- * [View Demo](/form-library/examples/add-custom-navigation-button/ (linkStyle))
1364
+ * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
1365
1365
  * @see showTitle
1366
1366
  * @see disableShrink
1367
1367
  */
@@ -1389,7 +1389,7 @@ declare module "actions/action" {
1389
1389
  /**
1390
1390
  * A function that is executed when users click the action item.
1391
1391
  *
1392
- * [View Demo](/form-library/examples/add-custom-navigation-button/ (linkStyle))
1392
+ * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
1393
1393
  */
1394
1394
  action?: (context?: any) => void;
1395
1395
  /**
@@ -1399,7 +1399,7 @@ declare module "actions/action" {
1399
1399
  *
1400
1400
  * To apply several classes, separate them with a space character: `"myclass1 myclass2"`.
1401
1401
  *
1402
- * [View Demo](/form-library/examples/add-custom-navigation-button/ (linkStyle))
1402
+ * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
1403
1403
  * @see innerCss
1404
1404
  */
1405
1405
  css?: string;
@@ -1410,7 +1410,7 @@ declare module "actions/action" {
1410
1410
  *
1411
1411
  * To apply several classes, separate them with a space character: `"myclass1 myclass2"`.
1412
1412
  *
1413
- * [View Demo](/form-library/examples/add-custom-navigation-button/ (linkStyle))
1413
+ * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
1414
1414
  * @see css
1415
1415
  */
1416
1416
  innerCss?: string;
@@ -1473,7 +1473,7 @@ declare module "actions/action" {
1473
1473
  /**
1474
1474
  * A number that specifies the action's position relative to other actions.
1475
1475
  *
1476
- * [View Demo](/form-library/examples/add-custom-navigation-button/ (linkStyle))
1476
+ * [View Demo](https://surveyjs.io/form-library/examples/add-custom-navigation-button/ (linkStyle))
1477
1477
  */
1478
1478
  visibleIndex?: number;
1479
1479
  needSpace?: boolean;
@@ -5593,7 +5593,7 @@ declare module "question_paneldynamic" {
5593
5593
  *
5594
5594
  * If you want to customize individual tab titles, handle `SurveyModel`'s [`onGetDynamicPanelTabTitle`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onGetDynamicPanelTabTitle) event.
5595
5595
  *
5596
- * [View Demo](/form-library/examples/tabbed-interface-for-duplicate-group-option/ (linkStyle))
5596
+ * [View Demo](https://surveyjs.io/form-library/examples/tabbed-interface-for-duplicate-group-option/ (linkStyle))
5597
5597
  * @see templateTitle
5598
5598
  * @see renderMode
5599
5599
  */
@@ -5882,7 +5882,7 @@ declare module "question_paneldynamic" {
5882
5882
  * - `"progressTop"` - Renders each panel as a card and displays a progress bar at the top. [View Demo](https://surveyjs.io/form-library/examples/questiontype-paneldynamic/)
5883
5883
  * - `"progressBottom"` - Renders each panel panel as a card and displays a progress bar at the bottom.
5884
5884
  * - `"progressTopBottom"` - Renders each panel as a card and displays a progress bar at the top and bottom.
5885
- * - `"tab"` - Renders each panel within a tab. Use the [`templateTabTitle`](https://surveyjs.io/form-library/documentation/api-reference/dynamic-panel-model#templateTabTitle) to specify a template for tab titles. [View Demo](/form-library/examples/tabbed-interface-for-duplicate-group-option/)
5885
+ * - `"tab"` - Renders each panel within a tab. Use the [`templateTabTitle`](https://surveyjs.io/form-library/documentation/api-reference/dynamic-panel-model#templateTabTitle) to specify a template for tab titles. [View Demo](https://surveyjs.io/form-library/examples/tabbed-interface-for-duplicate-group-option/)
5886
5886
  */
5887
5887
  get renderMode(): string;
5888
5888
  set renderMode(val: string);
@@ -6590,7 +6590,7 @@ declare module "survey-events-api" {
6590
6590
  }
6591
6591
  export interface UploadFilesEvent extends LoadFilesEvent {
6592
6592
  /**
6593
- * A callback function that you should call when a file is uploaded successfully or when file upload fails. Pass `"success"` or `"error"` to indicate the operation status and, optionally, the downloaded file's data.
6593
+ * A callback function that you should call when a file is uploaded successfully or when file upload fails. Pass `"success"` or `"error"` as the first argument to indicate the operation status. As the second argument, you can pass the uploaded file's data if file upload was successful or an error message if file upload failed.
6594
6594
  */
6595
6595
  callback: (status: string, data?: any) => any;
6596
6596
  /**
@@ -6600,7 +6600,7 @@ declare module "survey-events-api" {
6600
6600
  }
6601
6601
  export interface DownloadFileEvent extends LoadFilesEvent {
6602
6602
  /**
6603
- * A callback function that you should call when a file is downloaded successfully or when deletion fails. Pass `"success"` or `"error"` to indicate the operation status and, optionally, the downloaded file's data as a Base64 string.
6603
+ * A callback function that you should call when a file is downloaded successfully or when deletion fails. Pass `"success"` or `"error"` as the first argument to indicate the operation status. As the second argument, you can pass the downloaded file's data as a Base64 string if file upload was successful or an error message if file upload failed.
6604
6604
  */
6605
6605
  callback: (status: string, data?: any) => any;
6606
6606
  /**
@@ -6614,7 +6614,7 @@ declare module "survey-events-api" {
6614
6614
  }
6615
6615
  export interface ClearFilesEvent extends LoadFilesEvent {
6616
6616
  /**
6617
- * A callback function that you should call when files are deleted successfully or when deletion fails. Pass `"success"` or `"error"` to indicate the operation status and, optionally, deleted files' data (`options.value`).
6617
+ * A callback function that you should call when files are deleted successfully or when deletion fails. Pass `"success"` or `"error"` as the first argument to indicate the operation status. As the second argument, you can pass deleted files' data (`options.value`) if file upload was successful or an error message if file upload failed.
6618
6618
  */
6619
6619
  callback: (status: string, data?: any) => any;
6620
6620
  /**
@@ -7641,7 +7641,7 @@ declare module "question_multipletext" {
7641
7641
  /**
7642
7642
  * A class that describes an item in a [Multiple Textboxes](https://surveyjs.io/form-library/documentation/api-reference/multiple-text-entry-question-model) question.
7643
7643
  *
7644
- * [View Demo](/form-library/examples/multiple-text-box-question/)
7644
+ * [View Demo](https://surveyjs.io/form-library/examples/multiple-text-box-question/)
7645
7645
  */
7646
7646
  export class MultipleTextItemModel extends Base implements IValidatorOwner, ISurveyData, ISurveyImpl {
7647
7647
  private editorValue;
@@ -8390,16 +8390,16 @@ declare module "survey" {
8390
8390
  *
8391
8391
  * For information on event handler parameters, refer to descriptions within the interface.
8392
8392
  *
8393
- * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
8393
+ * [View Demo](https://surveyjs.io/form-library/examples/customize-survey-with-css/ (linkStyle))
8394
8394
  * @see css
8395
8395
  */
8396
8396
  onUpdateQuestionCssClasses: EventBase<SurveyModel, UpdateQuestionCssClassesEvent>;
8397
8397
  /**
8398
- * An event that is raised before rendering a standalone panel and panels within [Dynamic Panel](/form-library/examples/duplicate-group-of-fields-in-form/). Use it to override default panel CSS classes.
8398
+ * An event that is raised before rendering a standalone panel and panels within [Dynamic Panel](https://surveyjs.io/form-library/examples/duplicate-group-of-fields-in-form/). Use it to override default panel CSS classes.
8399
8399
  *
8400
8400
  * For information on event handler parameters, refer to descriptions within the interface.
8401
8401
  *
8402
- * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
8402
+ * [View Demo](https://surveyjs.io/form-library/examples/customize-survey-with-css/ (linkStyle))
8403
8403
  * @see css
8404
8404
  */
8405
8405
  onUpdatePanelCssClasses: EventBase<SurveyModel, UpdatePanelCssClassesEvent>;
@@ -8408,7 +8408,7 @@ declare module "survey" {
8408
8408
  *
8409
8409
  * For information on event handler parameters, refer to descriptions within the interface.
8410
8410
  *
8411
- * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
8411
+ * [View Demo](https://surveyjs.io/form-library/examples/customize-survey-with-css/ (linkStyle))
8412
8412
  * @see css
8413
8413
  */
8414
8414
  onUpdatePageCssClasses: EventBase<SurveyModel, UpdatePageCssClassesEvent>;
@@ -8417,7 +8417,7 @@ declare module "survey" {
8417
8417
  *
8418
8418
  * For information on event handler parameters, refer to descriptions within the interface.
8419
8419
  *
8420
- * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
8420
+ * [View Demo](https://surveyjs.io/form-library/examples/customize-survey-with-css/ (linkStyle))
8421
8421
  * @see css
8422
8422
  */
8423
8423
  onUpdateChoiceItemCss: EventBase<SurveyModel, UpdateChoiceItemCssEvent>;
@@ -8509,7 +8509,7 @@ declare module "survey" {
8509
8509
  */
8510
8510
  onMatrixRowAdding: EventBase<SurveyModel, MatrixBeforeRowAddedEvent>;
8511
8511
  /**
8512
- * This event is obsolete. Use the [`onMatrixRowAdding`](/form-library/documentation/api-reference/survey-data-model#onMatrixRowAdding) event instead.
8512
+ * This event is obsolete. Use the [`onMatrixRowAdding`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onMatrixRowAdding) event instead.
8513
8513
  */
8514
8514
  onMatrixBeforeRowAdded: EventBase<SurveyModel, MatrixBeforeRowAddedEvent>;
8515
8515
  /**
@@ -8529,7 +8529,7 @@ declare module "survey" {
8529
8529
  */
8530
8530
  onMatrixRenderRemoveButton: EventBase<SurveyModel, MatrixAllowRemoveRowEvent>;
8531
8531
  /**
8532
- * This event is obsolete. Use the [`onMatrixRenderRemoveButton`](/form-library/documentation/api-reference/survey-data-model#onMatrixRenderRemoveButton) event instead.
8532
+ * This event is obsolete. Use the [`onMatrixRenderRemoveButton`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onMatrixRenderRemoveButton) event instead.
8533
8533
  */
8534
8534
  onMatrixAllowRemoveRow: EventBase<SurveyModel, MatrixAllowRemoveRowEvent>;
8535
8535
  /**
@@ -8548,7 +8548,7 @@ declare module "survey" {
8548
8548
  */
8549
8549
  onAfterRenderMatrixCell: EventBase<SurveyModel, MatrixAfterCellRenderEvent>;
8550
8550
  /**
8551
- * This event is obsolete. Use the [`onAfterRenderMatrixCell`](/form-library/documentation/api-reference/survey-data-model#onAfterRenderMatrixCell) event instead.
8551
+ * This event is obsolete. Use the [`onAfterRenderMatrixCell`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onAfterRenderMatrixCell) event instead.
8552
8552
  */
8553
8553
  onMatrixAfterCellRender: EventBase<SurveyModel, MatrixAfterCellRenderEvent>;
8554
8554
  /**
@@ -8606,7 +8606,7 @@ declare module "survey" {
8606
8606
  *
8607
8607
  * For information on event handler parameters, refer to descriptions within the interface.
8608
8608
  *
8609
- * [View Demo](/form-library/examples/tabbed-interface-for-duplicate-group-option/ (linkStyle))
8609
+ * [View Demo](https://surveyjs.io/form-library/examples/tabbed-interface-for-duplicate-group-option/ (linkStyle))
8610
8610
  */
8611
8611
  onGetDynamicPanelTabTitle: EventBase<SurveyModel, DynamicPanelGetTabTitleEvent>;
8612
8612
  /**
@@ -8700,7 +8700,7 @@ declare module "survey" {
8700
8700
  /**
8701
8701
  * Gets or sets an object in which keys are UI elements and values are CSS classes applied to them.
8702
8702
  *
8703
- * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
8703
+ * [View Demo](https://surveyjs.io/form-library/examples/customize-survey-with-css/ (linkStyle))
8704
8704
  */
8705
8705
  get css(): any;
8706
8706
  set css(value: any);
@@ -10676,8 +10676,8 @@ declare module "survey" {
10676
10676
  /**
10677
10677
  * Applies a specified theme to the survey.
10678
10678
  *
10679
- * [Themes & Styles](/form-library/documentation/manage-default-themes-and-styles (linkStyle))
10680
- * @param theme An [`ITheme`](/form-library/documentation/api-reference/itheme) object with theme settings.
10679
+ * [Themes & Styles](https://surveyjs.io/form-library/documentation/manage-default-themes-and-styles (linkStyle))
10680
+ * @param theme An [`ITheme`](https://surveyjs.io/form-library/documentation/api-reference/itheme) object with theme settings.
10681
10681
  */
10682
10682
  applyTheme(theme: ITheme): void;
10683
10683
  themeChanged(theme: ITheme): void;
@@ -11958,6 +11958,7 @@ declare module "question" {
11958
11958
  protected onChangeQuestionValue(newValue: any): void;
11959
11959
  protected setValueChangedDirectly(val: boolean): void;
11960
11960
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
11961
+ private get isParentChangingViaDefaultValue();
11961
11962
  onSurveyValueChanged(newValue: any): void;
11962
11963
  setVisibleIndex(val: number): number;
11963
11964
  removeElement(element: IElement): boolean;
@@ -15146,6 +15147,7 @@ declare module "question_comment" {
15146
15147
  beforeDestroyQuestionElement(el: HTMLElement): void;
15147
15148
  onInput(event: any): void;
15148
15149
  onKeyDown(event: any): void;
15150
+ protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
15149
15151
  onValueChanged(): void;
15150
15152
  protected setNewValue(newValue: string): any;
15151
15153
  protected getValueSeparator(): string;
@@ -15275,7 +15277,7 @@ declare module "question_rating" {
15275
15277
  *
15276
15278
  * If you do not specify the `rateValues` property, rate values are generated automatically based upon the [`rateMin`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMin), [`rateMax`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMax), [`rateStep`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateStep), and [`rateCount`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateCount) property values.
15277
15279
  *
15278
- * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
15280
+ * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
15279
15281
  */
15280
15282
  get rateValues(): Array<any>;
15281
15283
  set rateValues(val: Array<any>);
@@ -15284,7 +15286,7 @@ declare module "question_rating" {
15284
15286
  *
15285
15287
  * Default value: 1
15286
15288
  *
15287
- * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
15289
+ * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
15288
15290
  * @see rateMax
15289
15291
  * @see rateStep
15290
15292
  * @see rateCount
@@ -15296,7 +15298,7 @@ declare module "question_rating" {
15296
15298
  *
15297
15299
  * Default value: 5
15298
15300
  *
15299
- * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
15301
+ * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
15300
15302
  * @see rateMin
15301
15303
  * @see rateStep
15302
15304
  * @see rateCount
@@ -15308,7 +15310,7 @@ declare module "question_rating" {
15308
15310
  *
15309
15311
  * Default value: 1
15310
15312
  *
15311
- * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
15313
+ * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
15312
15314
  * @see rateMin
15313
15315
  * @see rateMax
15314
15316
  * @see rateCount
@@ -15320,7 +15322,7 @@ declare module "question_rating" {
15320
15322
  *
15321
15323
  * Set the [`rateMin`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMin) or [`rateMax`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMax) property to specify the first or the last rate value. Use the [`rateStep`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateStep) property to specify a step with which to generate rate values.
15322
15324
  *
15323
- * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
15325
+ * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
15324
15326
  */
15325
15327
  rateCount: number;
15326
15328
  private static colorsCalculated;
@@ -15389,7 +15391,7 @@ declare module "question_rating" {
15389
15391
  * - `"dropdown"` - Displays rate values as items in a drop-down list.
15390
15392
  * - `"auto"` (default) - Selects between the `"buttons"` and `"dropdown"` modes based on the available width. When the width is insufficient to display buttons, the question displays a dropdown.
15391
15393
  *
15392
- * [View Demo](/form-library/examples/ui-adaptation-modes-for-rating-scale/ (linkStyle))
15394
+ * [View Demo](https://surveyjs.io/form-library/examples/ui-adaptation-modes-for-rating-scale/ (linkStyle))
15393
15395
  * @see rateType
15394
15396
  */
15395
15397
  displayMode: "dropdown" | "buttons" | "auto";
@@ -15402,7 +15404,7 @@ declare module "question_rating" {
15402
15404
  * - `"stars"` - Displays rate values as stars.
15403
15405
  * - `"smileys"` - Displays rate values as smiley faces.
15404
15406
  *
15405
- * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
15407
+ * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
15406
15408
  * @see scaleColorMode
15407
15409
  * @see rateColorMode
15408
15410
  * @see displayMode
@@ -15418,7 +15420,7 @@ declare module "question_rating" {
15418
15420
  * - `"monochrome"` (default) - Displays emojis in monochrome.
15419
15421
  * - `"colored"` - Displays emojis in color.
15420
15422
  *
15421
- * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
15423
+ * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
15422
15424
  * @see rateColorMode
15423
15425
  */
15424
15426
  scaleColorMode: "monochrome" | "colored";
@@ -15673,7 +15675,6 @@ declare module "question_image" {
15673
15675
  declare module "question_signaturepad" {
15674
15676
  import { Question } from "question";
15675
15677
  import { ITheme } from "themes";
15676
- export function getCanvasRatio(canvas: HTMLCanvasElement): number;
15677
15678
  /**
15678
15679
  * A class that describes the Signature question type.
15679
15680
  *
@@ -15690,6 +15691,13 @@ declare module "question_signaturepad" {
15690
15691
  afterRenderQuestionElement(el: HTMLElement): void;
15691
15692
  beforeDestroyQuestionElement(el: HTMLElement): void;
15692
15693
  themeChanged(theme: ITheme): void;
15694
+ private canvas;
15695
+ private scale;
15696
+ private valueIsUpdatingInternally;
15697
+ private resizeCanvas;
15698
+ private scaleCanvas;
15699
+ private refreshCanvas;
15700
+ private updateValueHandler;
15693
15701
  initSignaturePad(el: HTMLElement): void;
15694
15702
  destroySignaturePad(el: HTMLElement): void;
15695
15703
  /**
@@ -15713,6 +15721,29 @@ declare module "question_signaturepad" {
15713
15721
  */
15714
15722
  get signatureHeight(): number;
15715
15723
  set signatureHeight(val: number);
15724
+ /**
15725
+ * Specifies whether the signature area should be scaled to fit into the question width.
15726
+ *
15727
+ * Default value: `false`
15728
+ *
15729
+ * > The signature area is scaled only for display. The resulting image will have dimensions specified by the [`signatureHeight`](#signatureHeight) and [`signatureWidth`](#signatureWidth) properties.
15730
+ */
15731
+ signatureAutoScaleEnabled: boolean;
15732
+ /**
15733
+ * Speicifies the minimum width of pen strokes, measured in pixels.
15734
+ *
15735
+ * Default value: 0.5
15736
+ */
15737
+ penMinWidth: number;
15738
+ /**
15739
+ * Speicifies the maximum width of pen strokes, measured in pixels.
15740
+ *
15741
+ * Default value: 2.5
15742
+ */
15743
+ penMaxWidth: number;
15744
+ private get containerHeight();
15745
+ private get containerWidth();
15746
+ get renderedCanvasWidth(): string;
15716
15747
  get height(): number;
15717
15748
  set height(val: number);
15718
15749
  /**