Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPropertyFieldSliderRangeProps

interface

Public properties of the PropertyFieldSliderRange custom field

Hierarchy

  • IPropertyFieldSliderRangeProps

Index

Properties

Optional deferredValidationTime

deferredValidationTime: number

Custom Field will start to validate after users stop typing for deferredValidationTime milliseconds. Default value is 200.

Optional disabled

disabled: boolean
var

Disables the slider if set to true. Default is false.

Optional initialValue

initialValue: string
var

Initial value

Optional key

key: string
var

An UNIQUE key indicates the identity of this control

label

label: string
var

Property field label displayed on top

Optional max

max: number
var

The maximum value of the slider. Default is 100.

Optional min

min: number
var

The minimum value of the slider. Default is 0.

Optional onGetErrorMessage

onGetErrorMessage: function

The method is used to get the validation error message and determine whether the input value is valid or not.

When it returns string:

  • If valid, it returns empty string.
  • If invalid, it returns the error message string and the text field will show a red border and show an error message below the text field.

    When it returns Promise:

  • The resolved value is display as error message.
  • The rejected, the value is thrown away.

Type declaration

    • (value: string): string | Promise<string>
    • Parameters

      • value: string

      Returns string | Promise<string>

Optional orientation

orientation: string
var

Determines whether the slider handles move horizontally (min on left, max on right) or vertically (min on bottom, max on top). Possible values: "horizontal", "vertical".

properties

properties: any
var

Parent Web Part properties

Optional showValue

showValue: boolean
var

Display the value on left & right of the slider or not

Optional step

step: number
var

Default 1 - Determines the size or amount of each interval or step the slider takes between the min and max. The full specified value range of the slider (max - min) should be evenly divisible by the step.

Methods

onPropertyChange

  • onPropertyChange(propertyPath: string, oldValue: any, newValue: any): void
  • function

    Defines a onPropertyChange function to raise when the selected Color changed. Normally this function must be always defined with the 'this.onPropertyChange' method of the web part object.

    Parameters

    • propertyPath: string
    • oldValue: any
    • newValue: any

    Returns void

Generated using TypeDoc