Next: , Up: Local Parsing   [Index]


18.2.2.1 org-element-at-point

This function returns the local structure of the document around point. It returns only elements, not objects.

Function: org-element-at-point

Determines the type and attribues of the closest element to point. This function does not analyze the contents of objects, such as a paragraphs. The companion local parsing function org-element-context goes deeper into the object level.

Refer to the following links to see the difference between elements and objects:

RETURN VALUE

is a list of (type, props), where

TYPE

is the type of the element

PROPS

is a plist of properties associated with the element. The exact properties dependes on the type, but will always include the following:

:begin

is the beginning buffer position of the token

:end

is the ending buffer position of the token; the ‘:end’ property of this object matches the ‘:begin’ property of the next token.

:parent

is the element or object containing the token

:post-blank

is the numnber of blank lines or white spaces at its end