IDrawElementCollection#

class ansys.stk.core.stkx.IDrawElementCollection#

Collection of elements to draw on the control.

Overview#

add

Create and add a new element to the end of the sequence.

clear

Clear the contents of the collection and updates the display.

item

Get the element at the specified index (0-based).

remove

Remove the specified element.

_new_enum

Return an object that can be used to iterate through all the strings in the collection.

count

Number of elements contained in the collection.

visible

Show or hide all the elements.

Import detail#

from ansys.stk.core.stkx import IDrawElementCollection

Property detail#

property IDrawElementCollection._new_enum: EnumeratorProxy#

Return an object that can be used to iterate through all the strings in the collection.

property IDrawElementCollection.count: int#

Number of elements contained in the collection.

property IDrawElementCollection.visible: bool#

Show or hide all the elements.

Method detail#

IDrawElementCollection.add(self, elem_type: str) IDrawElement#

Create and add a new element to the end of the sequence.

Parameters:

elem_type : str

Returns:

IDrawElement

IDrawElementCollection.clear(self) None#

Clear the contents of the collection and updates the display.

Returns:

None

IDrawElementCollection.item(self, index: int) IDrawElement#

Get the element at the specified index (0-based).

Parameters:

index : int

Returns:

IDrawElement

IDrawElementCollection.remove(self, draw_elem: IDrawElement) None#

Remove the specified element.

Parameters:

draw_elem : IDrawElement

Returns:

None