index section

A section within the index.

index section elements

Name Refer to By
topics by numeric index, as a range of elements, before/after another element, satisfying a
test

index section properties

Property Type Access Description
all topics list of topics read A flattened list of all the child topics.
class integer read The class descriptor type.
id integer read A unique number identifying the object.
index integer read Index of the object within its parent object.
label string r/w A label that can be set to any string.
name string read The name of the object.
object reference object read An object reference for this object.
parent object read The parent of the object.
properties record r/w Property that allows setting of several properties at the same time.

index section methods

Method Returns Description
extract label string Gets the content of the label associated with the specified key (name).
insert label Nothing Sets the content of the label associated with the specified key (name), creating the
label if it does not already exist.

Leave a Comment

Previous post:

Next post: