Function: get-display-property

get-display-property is a function defined in xdisp.c.

Signature

(get-display-property POSITION SPEC &optional OBJECT PROPERTIES)

Documentation

Get the value of the display specification SPEC at POSITION.

SPEC is the car of the display specification to fetch, e.g. height.

OBJECT is either a string or a buffer to fetch the specification from. If omitted, OBJECT defaults to the current buffer.

If PROPERTIES is non-nil, look for value of SPEC in PROPERTIES instead of the properties at POSITION.

View in manual

Probably introduced at or before Emacs version 29.1.

Source Code

// Defined in /usr/src/emacs/src/xdisp.c
{
  if (NILP (properties))
    properties = Fget_text_property (position, Qdisplay, object);
  else
    CHECK_LIST (properties);

  return find_display_property (properties, spec);
}