Interface ToolbarPropertyApi

This API is available on the Toolbar Property Editor controls to handle property changes and trigger refreshes.

interface ToolbarPropertyApi {
    page: {
        onPropertyChange(handler: ((category: string, property: string, currentValue: any, previousValue: any) => void)): (() => void);
    };
}

Properties

page

Properties

Readonlypage

page: {
    onPropertyChange(handler: ((category: string, property: string, currentValue: any, previousValue: any) => void)): (() => void);
}

Methods related to the entire page.

Type declaration

  • onPropertyChange:function
    • onPropertyChange(handler): (() => void)

    • Registers a function to be invoked whenever one of the calling toolbar control's properties change.

      Parameters

      • handler: ((category: string, property: string, currentValue: any, previousValue: any) => void)

        The function to be invoked.

          • (category, property, currentValue, previousValue): void

          • Parameters

            • category: string
            • property: string
            • currentValue: any
            • previousValue: any

            Returns void

      Returns (() => void)

      A function that stops the handler from being invoked.

        • (): void

        • Returns void

      Method

Settings

Member Visibility

On This Page

Properties