ColorLegend

class rips.ColorLegend(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: PdmObjectBase

color_legend_name

Color Legend Name

Type:

str

Methods Summary

add_color_legend_item([category_value, ...])

Append a category item with a name and RGB color

color_legend_items()

Methods Documentation

add_color_legend_item(category_value: int = 0, category_name: str = '', color: str = '#ffa500') ColorLegendItem

Append a category item with a name and RGB color

Parameters:
  • category_value (int)

  • category_name (str)

  • color (str)

Returns:

ColorLegendItem

color_legend_items() List[ColorLegendItem]
Returns:

List[ColorLegendItem]