pydim.delete_text

Deletes 2d annotation texts together with their leaders.

Similar to the Text -> Delete function in the PYTHA user interface.

pydim.delete_text(text)

Parameter	Type	Description
text	element_handle or {element_handle, ...}	A single element handle of type "text" or a table of them.

Return value

Type	Description
boolean	true if at least one text was deleted, false otherwise.

Example:

local t1 = pydim.create_text("12", {{600, 400, 0}}, {view = "xy", leader = true})
local t2 = pydim.create_text("13", {{600, 0, 0}}, {view = "xy"})

pydim.delete_text({t1, t2})

Remarks:

• The leaders of a text are deleted with it. To remove only the leader and keep the text, use pydim.update_text with leader = false.
• Texts on locked layers are skipped. If every given text sits on a locked layer, the function returns false.
• pytha.delete_element deletes parts, groups and NGOs; it does not accept text handles.

Version Support:

Minimum PYTHA Version: V27

See also:

pydim, pydim.create_text, pydim.delete_dimension, element handles