Altair EEvision 2025.1 APIs
    Preparing search index...

    Type Alias PageChangeHandler

    PageChangeHandler: (
        this: EEvisionAPI,
        details: number,
        page: number,
        npages: number,
    ) => void | Promise<void>

    Handler for changes to the current page.

    Type declaration

      • (
            this: EEvisionAPI,
            details: number,
            page: number,
            npages: number,
        ): void | Promise<void>
      • Parameters

        • this: EEvisionAPI
        • details: number

          a set of flags denoting what has changed. Possible values:

          • 0x0001 The current page has switched to a different number, e.g., from page number 3 to page 4.
          • 0x0002 The page count (number of pages) has changed.
          • 0x0004 The current module has changed (switched to a different module).
          • 0x0008 The current module was cleared.

          For details (and further flags), please consult the documentation of the Nlview API.

        • page: number

          the current page number

        • npages: number

          the total number of pages

        Returns void | Promise<void>

    This handler is rarely needed because, by default, EEvision only has one page of unlimited size and only a single Nlview module.