LabelNoteCollection

class ansys.stk.core.stkobjects.LabelNoteCollection

Collection representing label notes list.

Overview

Methods

add	Add a label note to the collection.
remove	Remove an item given an index.
item	Get a LabelNote.

Properties

count	Number of label notes.
_new_enum	Enumerates through the LabelNotes.

Import detail

from ansys.stk.core.stkobjects import LabelNoteCollection

Property detail

property LabelNoteCollection.count: int

Number of label notes.

property LabelNoteCollection._new_enum: EnumeratorProxy

Enumerates through the LabelNotes.

Method detail

LabelNoteCollection.add(self, msg: str) → LabelNote

Add a label note to the collection.

Parameters:

msg : str

Returns:

LabelNote

LabelNoteCollection.remove(self, index: int) → None

Remove an item given an index.

Parameters:

index : int

Returns:

None

LabelNoteCollection.item(self, index: int) → LabelNote

Get a LabelNote.

Parameters:

index : int

Returns:

LabelNote