Interface ToolJsCallbacksType

ToolJsCallbacksType defines the callbacks for tool-related events in the JavaScript engine.

Example

{
    onToolLButtonDown: (clientData: LPVOIDType, pageview: PageViewType, flags: number, point: DevicePointType) => {
        console.log('Tool left button down event：', clientData, pageview, flags, point);
    }
}
interface ToolJsCallbacksType {
    onToolLButtonDown?: (
        clientData: LPVOIDType,
        pageview: PageViewType,
        flags: number,
        point: Point,
    ) => boolean;
    onToolLButtonUp?: (
        clientData: LPVOIDType,
        pageview: PageViewType,
        flags: number,
        point: Point,
    ) => boolean;
}

Properties

onToolLButtonDown? onToolLButtonUp?

Properties

OptionalonToolLButtonDown

onToolLButtonDown?: (
    clientData: LPVOIDType,
    pageview: PageViewType,
    flags: number,
    point: Point,
) => boolean

Tool left button down event callback.

Type declaration

    • (
          clientData: LPVOIDType,
          pageview: PageViewType,
          flags: number,
          point: Point,
      ): boolean

    • Parameters

      • clientData: LPVOIDType

        User-supplied data that was passed

      • pageview: PageViewType

        The page view object associated with the tool

      • flags: number

        Additional flags for the mouse event.

      • point: Point

        The device point where the event occurred.

      Returns boolean

      Returns true if the event was handled, false otherwise.

OptionalonToolLButtonUp

onToolLButtonUp?: (
    clientData: LPVOIDType,
    pageview: PageViewType,
    flags: number,
    point: Point,
) => boolean

Tool left button up event callback.

Type declaration

    • (
          clientData: LPVOIDType,
          pageview: PageViewType,
          flags: number,
          point: Point,
      ): boolean

    • Parameters

      • clientData: LPVOIDType

        User-supplied data that was passed

      • pageview: PageViewType

        The page view object associated with the tool

      • flags: number

        Additional flags for the mouse event.

      • point: Point

        The device point where the event occurred.

      Returns boolean

      Returns true if the event was handled, false otherwise.

Settings

Member Visibility

On This Page

Properties