IPaletteGroups

class IPaletteGroups

Bases: ImpactCOMWrapperBase, Iterable

Summary:

A collection of IPaletteGroup objects.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property count

Gets Count.

Summary:

The number of items in this collection.

Returns:

The value of Count.

Return type:

count (int)

add(name, palettes)
Summary:

Creates a new palette group.

Remarks:

The name of the palette group must be unique and there must be at least one palette to add to the palette group. In Impact 2015 (9.0), the Palettes parameter was only permitted to be array of IPalette objects.

Parameters:
  • name (str) – The name of the palette group to create.

  • palettes (any) – The palettes to add to this palette group. This parameter may be an array of IPalette objects, a single IPalette object, or the name of a single palette.

delete(index)
Summary:

Deletes the palette group with the specified name or index.

Parameters:

index (any) – Specifies the name or index of the palette group to delete.

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

item(index)
Summary:

Gets an IPaletteGroup object with the specified name or index.

Parameters:

index (any) – The name or index of the IPaletteGroup object to retrieve.