Interface IPropertyAPI

Changed

RequestRefresh

Add

• Add<T>(
      name: string,
      type?: cPropertyType,
      options?: IPropertyConfig,
  ): IProperty<T>

  Adds a new property to the component.

  Type Parameters

  • T

  Parameters

  • name: string

    The property name.

  • Optionaltype: cPropertyType

    The property type. (Default: cPropertyType.Text)

  • Optionaloptions: IPropertyConfig

    The property options (containing any of the options in IPropertyInfo).

  Returns IProperty<T>

AddListener

• AddListener(listener: TPropertyListener, propertyname?: string): void

  Adds a property change listener.

  Parameters

  • listener: TPropertyListener

    A function that is called when a property value is changed (the property name is passed as a parameter to the function).

  • Optionalpropertyname: string

    The name of the property whose changes are listened. (If undefined or null, listens to all properties.)

  Returns void

Contains

• Contains(name: string): boolean

  Checks if the property with the given name exists.

  Parameters

  • name: string

    The name of the property.

  Returns boolean

GetHandle

• GetHandle<T>(propertyname: string): IProperty<T>

  Get a property handle

  Type Parameters

  • T

  Parameters

  • propertyname: string

    The name of an existing property.

  Returns IProperty<T>

GetInfo

• GetInfo(propertyname: string): IPropertyInfo

  Gets the attributes of a property. The instance specific attribute values can be changed using this object. RequestRefresh event is raised automatically when a property attribute is changed.

  Parameters

  • propertyname: string

    The name of the property.

  Returns IPropertyInfo

GetNewItem

• GetNewItem(propertyname: string): unknown

  Parameters

  • propertyname: string

  Returns unknown

GetNewItemName

• GetNewItemName(propertyname: string): string

  Parameters

  • propertyname: string

  Returns string

GetResolvedColorValue

• GetResolvedColorValue(colorpropertyname: string): IThemeColor

  Gets resolved color value for specified color property.

  Parameters

  • colorpropertyname: string

    The name of the color property

  Returns IThemeColor

HasDefaultValue

• HasDefaultValue(propertyname: string): boolean

  Does given property have its default value.

  Parameters

  • propertyname: string

    The property name.

  Returns boolean

InstantiateProperties

• InstantiateProperties(): void

  Returns void

IsVisible

• IsVisible(propertyname: string): boolean

  [ADVANCED] Resolve visibility of a property

  Parameters

  • propertyname: string

    The property name.

  Returns boolean

List

• List(): string[]

  Get names of all the properties in the component.

  Returns string[]

OverrideGetter

• OverrideGetter<T>(propertyname: string, newgetter: TGet<T>): void

  Override the default getter function for the property.

  Type Parameters

  • T

  Parameters

  • propertyname: string

    The name of the property.

  • newgetter: TGet<T>

    The new getter function.

  Returns void

OverrideSetter

• OverrideSetter<T>(
      propertyname: string,
      newsetter: TSet<T>,
      nodefaultstorage?: boolean,
  ): void

  Override the default setter function for the property.

  Type Parameters

  • T

  Parameters

  • propertyname: string

    The name of the property.

  • newsetter: TSet<T>

    The new setter function.

  • Optionalnodefaultstorage: boolean

    Don't update the default property storage after calling the setter.

  Returns void

Read

• Read(config: IComponentConfig, removehandled?: boolean): void

  Reads property values from an object and sets them to this component. (Disregards properties that aren't found in the current component.)

  Parameters

  • config: IComponentConfig

    An object containing property names and values ({PropertyName1: PropertyValue1, PropertyName2: PropertyValue2, ...}).

  • Optionalremovehandled: boolean

    Remove read name value pairs from the properties object. Intended for preventing inheriting components reading the properties twice.

  Returns void

Remove

• Remove(name: string): void

  Remove a property

  Parameters

  • name: string

    The property name.

  Returns void

RemoveListener

• RemoveListener(listener: TPropertyListener, propertyname?: string): void

  Removes a property change listener.

  Parameters

  • listener: TPropertyListener

    The function to be removed.

  • Optionalpropertyname: string

    The name of the property whose changes were listened.

  Returns void

SaveOnlyChanged

• SaveOnlyChanged(
      collectionpropertyname: string,
      defaults: object | unknown[],
  ): void

  Creates an auxilary property to store for the changes from defaults. Works only with Array and Dictionary type properties.

  Parameters

  • collectionpropertyname: string
  • defaults: object | unknown[]

  Returns void

SetAttributes

• SetAttributes(propertyname: string, attributes: IPropertyConfig): void

  Modifies one or several attributes of a property.

  Parameters

  • propertyname: string

    Name of the property.

  • attributes: IPropertyConfig

    Attributes with their new values.

  Returns void

SetDefaultValue

• SetDefaultValue(
      propertyname: string,
      value: unknown,
      initialconfig?: IComponentConfig,
  ): void

  Update the default value of a property (for this component instance).

  Parameters

  • propertyname: string
  • value: unknown
  • Optionalinitialconfig: IComponentConfig

  Returns void

SetNewItemHandler

• SetNewItemHandler(propertyname: string, handler: () => unknown): void

  Set the new item handler of a collection property. (Currently only supported for array or dictionary properties)

  Parameters

  • propertyname: string

    The collection property name.

  • handler: () => unknown

    The function creating a new item (to be added in the collection).

  Returns void

SetNewItemNameHandler

• SetNewItemNameHandler(propertyname: string, namehandler: () => string): void

  Set the new item name handler of a collection property.

  Parameters

  • propertyname: string
  • namehandler: () => string

  Returns void