HSAXElement

Type

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

Properties

role

string

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

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:17

subrole

string

The element's subrole

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:20

elementDescription

string

The element's description

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:29

isEnabled

boolean

Whether the element is enabled

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:32

isFocused

boolean

Whether the element is focused

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:35

position

HSPoint

The element's position on screen

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:40

frame

HSRect

The element's frame (position and size combined)

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:46

parent

HSAXElement

The element's parent

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:51

pid

number

Get the process ID of the application that owns this element

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:99

Methods

children()

The element's children

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:55

Parameters

None

Returns

HSAXElement[] - An array of HSAXElement objects

childAtIndex(index)

Get a specific child by index

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:60

Parameters

  • index number

    The index to fetch

Returns

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

attributeNames()

Get all available attribute names

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:66

Parameters

None

Returns

string[] - An array of attribute names

attributeValue(attribute)

Get the value of a specific attribute

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:71

Parameters

  • attribute string

    The attribute name to fetch the value for

Returns

any - The requested value, or nil if none was found

setAttributeValue(attribute, value)

Set the value of a specific attribute

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:78

Parameters

  • attribute string

    The attribute name to set

  • value any

    The value to set

Returns

boolean - True if the operation succeeded, otherwise False

isAttributeSettable(attribute)

Check if an attribute is settable

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:83

Parameters

  • attribute string

    An attribute name

Returns

boolean - True if the attribute is settable, otherwise False

actionNames()

Get all available action names

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:89

Parameters

None

Returns

string[] - An array of available action names

performAction(action)

Perform a specific action

Hammerspoon 2/Modules/hs.ax/HSAXElement.swift:94

Parameters

  • action string

    The action to perform

Returns

boolean - True if the action succeeded, otherwise False