Pixso Open Documentation
guide
  • 中文
  • English
guide
  • 中文
  • English
  • Plugin API

    • Brief Introduction
    • Prerequisites
    • manifest
    • Development Guide
    • Change Log
    • Plugin API Documentation

      • Overview
      • Global Object

        • pixso
        • pixso.ui
        • pixso.host
        • pixso.mouse
        • pixso.editor
        • pixso.keyboard
        • pixso.fieldset
        • pixso.viewport
        • pixso.vectorEditor
        • pixso.clientStorage
        • pixso.serverStorage
      • Node Types

        • BooleanOperationNode
        • ComponentNode
        • ComponentSetNode
        • DocumentNode
        • EllipseNode
        • FrameNode
        • GroupNode
        • InstanceNode
        • LineNode
        • PageNode
        • PolygonNode
        • RectangleNode
        • SectionNode
        • SliceNode
        • StarNode
        • TextNode
        • VectorNode
      • Data Types

        • Action
        • ArcData
        • BlendMode
        • CommandItem
        • ComponentProperties-Related
        • Constraints
        • DialogType
        • DocumentationLink
        • Effect
        • EmbedData
        • ExportSettings
        • FontName
        • Guide
        • HandleMirroring
        • HyperlinkTarget
        • Image
        • LayoutGrid
        • LetterSpacing
        • Library
        • LineHeight
        • NodeChangeProperty
        • OverflowDirection
        • Overlay
        • Paint
        • PublishStatus
        • Reaction
        • Rect-related
        • RGB & RGBA
        • StrokeCap
        • StrokeJoin
        • StyleChangeProperty
        • TextCase
        • TextDecoration
        • TextListOptions
        • ThemeType
        • ToolType
        • Transition
        • Trigger
        • Vector
    • Host API Documentation

      • Overview
      • Host API
  • Open API

    • OpenAPI Doc

pixso.mouse

The pixso.mouse object contains an interface for reading mouse coordinates.

viewportX

  • Readonly: true

viewportX gets the X-coordinate of the mouse canvas (reference to the horizontal coordinate of the ruler).

viewportY

  • Readonly: true

viewportX gets the mouse's canvas y coordinate (refer to the vertical coordinate of the ruler).

clientX

  • Readonly: true

viewportX gets the horizontal distance of the mouse relative to the upper left corner of the browser's viewable area.

clientY

  • Readonly: true

What you get is the vertical distance of the mouse relative to the upper left corner of the browser's viewable area.

screenX

  • Readonly: true

You get the horizontal distance of the mouse relative to the upper left corner of the screen.

screenY

  • Readonly: true

What you get is the vertical distance of the mouse relative to the upper left corner of the screen.

Prev
pixso.host
Next
pixso.editor