GetPropertyQuery

type GetPropertyQuery: object;

Type declaration

id?

optional id: string;

ID of the LucidElement to read a property from, or undefined to read from the LucidDocument

p

p: string;

Name of the property to read.

For text area properties, this returns the plain text string by default. To get rich text
(text + inline markup such as bold, italic, links, and line spacing), prefix the text area
name with Rich:. For example, properties.get('Rich:Text') returns an object with the
structure {t: string, m: Array} where t is the text content and m is an array of
markup entries. Each markup entry has:

  • s (number): start index
  • e (number, optional): end index (omitted for block-level markup)
  • n (string): markup name (e.g. 'b' for bold, 'i' for italic, 'lk' for link, 'p' for line spacing)
  • v (any): markup value