Interface PropertyApi

This API pertains to page/toolbar control properties in SAS Visual Investigator.

Accessed from the window at window.sas.vi.property.

Example

window.sas.vi.property.registerPropertyLocalizer(localizer);
interface PropertyApi {
    getChildObjectMetadata(propertyConfig: PropertyConfig<any>, propertyKey: string, control: Control<TypeAttributes>): undefined | PageTemplateMetadata;
    registerCustomEditor(elementName: string, type: string, validatorFn?: ((propertyConfig: PropertyConfig<any>, propertyKey: string, control: Control<TypeAttributes> | ToolbarPropertyControl) => boolean), metadataFn?: ((propertyConfig: PropertyConfig<any>, propertyKey: string, control: Control<TypeAttributes> | ToolbarPropertyControl) => PageTemplateMetadata)): void;
    registerPropertyLocalizer(localizer: ControlPropertyLocalizer): void;
    validateChildObjectDataSource(propertyConfig: PropertyConfig<any>, propertyKey: string, control: Control<TypeAttributes>): undefined | boolean;
}

Methods

getChildObjectMetadata registerCustomEditor registerPropertyLocalizer validateChildObjectDataSource

Methods

getChildObjectMetadata

  • getChildObjectMetadata(propertyConfig, propertyKey, control): undefined | PageTemplateMetadata

  • Parameters

    • propertyConfig: PropertyConfig<any>

      Configuration details relating to the property type. For example, required, type, and so on.

    • propertyKey: string

      Key where this property's value is stored.

    • control: Control<TypeAttributes>

      The control.

    Returns undefined | PageTemplateMetadata

    Method

    Description

    Get metadata for the child object data source property editor. Typically passed as a function reference to registerCustomEditor() instead of being called directly.

    Example

    window.sas.vi.property.registerCustomEditor(
        name,
        type,
        window.sas.vi.property.validateChildObjectDataSource,
        window.sas.vi.property.getChildObjectMetadata)

registerCustomEditor

  • registerCustomEditor(elementName, type, validatorFn?, metadataFn?): void

  • Parameters

    Returns void

    Method

    Description

    Registers a custom element to be rendered as the property editor. The element is rendered as a custom web component. The element is passed selectedNode, property, propertyKey, and categoryKey as attributes. Throws a console error if the type is already used by another registered editor.

registerPropertyLocalizer

  • registerPropertyLocalizer(localizer): void

  • Register a localizer to manage internationalization resources for control properties of a given type. Properties will be localized unless they they are explicitly configured with localizable=false (see PropertyConfig)

    Parameters

    • localizer: ControlPropertyLocalizer

      property localizer which defines resource keys to be saved, and parses the same keys to localize the properties.

    Returns void

validateChildObjectDataSource

  • validateChildObjectDataSource(propertyConfig, propertyKey, control): undefined | boolean

  • Parameters

    • propertyConfig: PropertyConfig<any>

      Configuration details relating to the property type. For example, required, type, and so on.

    • propertyKey: string

      Key where this property's value is stored.

    • control: Control<TypeAttributes>

      The control.

    Returns undefined | boolean

    Method

    Description

    Determines whether the child object data source property editor is valid. Typically passed as a function reference to registerCustomEditor() instead of being called directly.

    Example

    window.sas.vi.property.registerCustomEditor(
        name,
        type,
        window.sas.vi.property.validateChildObjectDataSource,
        window.sas.vi.property.getChildObjectMetadata)

Settings

Member Visibility

On This Page

Methods