hammerspoon2-docs
    Preparing search index...

    Class HSAXElement

    Object representing an Accessibility element. You should not instantiate this directly, but rather, use the hs.ax methods to create these as required.

    Index

    Constructors

    Properties

    elementDescription: string | null

    The element's description

    frame: HSRect | null

    The element's frame (position and size combined)

    isEnabled: boolean

    Whether the element is enabled

    isFocused: boolean

    Whether the element is focused

    parent: HSAXElement | null

    The element's parent

    pid: number

    Get the process ID of the application that owns this element

    position: HSPoint | null

    The element's position on screen

    role: string | null

    The element's role (e.g., "AXWindow", "AXButton")

    size: HSSize | null

    The element's size

    subrole: string | null

    The element's subrole

    title: string | null

    The element's title

    value: any

    The element's value

    Methods

    • Get all available action names

      Returns string[]

      An array of available action names

    • Get all available attribute names

      Returns string[]

      An array of attribute names

    • Get the value of a specific attribute

      Parameters

      • attribute: string

        The attribute name to fetch the value for

      Returns any

      The requested value, or nil if none was found

    • Get a specific child by index

      Parameters

      • index: number

        The index to fetch

      Returns HSAXElement | null

      An HSAXElement object, if a child exists at the given index

    • Check if an attribute is settable

      Parameters

      • attribute: string

        An attribute name

      Returns boolean

      True if the attribute is settable, otherwise False

    • Perform a specific action

      Parameters

      • action: string

        The action to perform

      Returns boolean

      True if the action succeeded, otherwise False

    • Set the value of a specific attribute

      Parameters

      • attribute: string

        The attribute name to set

      • value: any

        The value to set

      Returns boolean

      True if the operation succeeded, otherwise False