PropertyDescriptionHelper Class

Beta  

Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.

Methods

Name Description
constructor(): PropertyDescriptionHelper    
buildCheckboxDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds a boolean description for a tool settings or dialog property that will display a checkbox control. Beta  
buildColorPickerDescription(name: string, label: string, colorValues: number[], numColumns: number, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds a number description for a tool settings or dialog property that will display a "color-picker" control. Beta  
buildEnumPicklistEditorDescription(name: string, label: string, choices: EnumerationChoice[] | Promise<EnumerationChoice[]>, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds an enum description Beta  
buildImageCheckBoxDescription(name: string, label: string, imageOff: string, imageOn: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control. Beta  
buildLockPropertyDescription(name: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds a property description for a tool settings or dialog lock property. Beta  
buildNumberEditorDescription(name: string, label: string, overrideParams?: RangeEditorParams, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds an editor that uses NumberInput control Beta  
buildTextEditorDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds a string description Beta  
buildToggleDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds a boolean description for a tool settings or dialog property that will display a "toggle" control. Beta  
buildWeightPickerDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription Static Builds a number description with a "weight-picker" editor name Beta  
bumpEnumProperty(description: PropertyDescription, value: string | number): Promise<string | number> Static Bumps an enum property description value Beta  

Defined in

Last Updated: 12 June, 2024