Graphics3DDataDisplayCollection

class ansys.stk.core.stkobjects.Graphics3DDataDisplayCollection

Collection of 3D Graphics data display text.

Overview

Methods

item	Given an index, returns an element in the collection.
remove_at	Remove an element from the collection using specified index.
remove_all	Remove all elements from the collection.
add	Add a new element to the collection.
is_pre_data_required	Determine if the data display needs additional data, such as a comparison object for an RIC report or a set of axes for a vector.
add_data_display_requiring_pre_data	Add a data display using additional data, such as a comparison object for an RIC report or a set of axes for a vector.

Properties

count	Return the number of elements in a collection.
_new_enum	Return an enumerator that can iterate through the collection.
available_data	Get the available data.

Import detail

from ansys.stk.core.stkobjects import Graphics3DDataDisplayCollection

Property detail

property Graphics3DDataDisplayCollection.count: int

Return the number of elements in a collection.

property Graphics3DDataDisplayCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

property Graphics3DDataDisplayCollection.available_data: list

Get the available data.

Method detail

Graphics3DDataDisplayCollection.item(self, index: int) → Graphics3DDataDisplayElement

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

Graphics3DDataDisplayElement

Graphics3DDataDisplayCollection.remove_at(self, index: int) → None

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

Graphics3DDataDisplayCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

Graphics3DDataDisplayCollection.add(self, name: str) → Graphics3DDataDisplayElement

Add a new element to the collection.

Parameters:

name : str

Returns:

Graphics3DDataDisplayElement

Graphics3DDataDisplayCollection.is_pre_data_required(self, data_display_name: str) → bool

Determine if the data display needs additional data, such as a comparison object for an RIC report or a set of axes for a vector.

Parameters:

data_display_name : str

Returns:

bool

Graphics3DDataDisplayCollection.add_data_display_requiring_pre_data(self, name: str, pre_data: str) → Graphics3DDataDisplayElement

Add a data display using additional data, such as a comparison object for an RIC report or a set of axes for a vector.

Parameters:

name : str

pre_data : str

Returns:

Graphics3DDataDisplayElement