---
name: "Color::Library::Dictionary"
section: "3pm"
platform: "linux"
package: "libcolor-library-perl"
version: "0.021-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Color::Library::Dictionary"
---

# Color::Library::Dictionary(3pm)

Color dictionary for Color::Library

## NAME

Color::Library::Dictionary - Color dictionary for Color::Library

## METHODS

- @colors = $dictionary-\>colors

  Returns the list of Color::Library::Color objects contained by `$dictionary`

  Will return a list in list context, and a list reference in scalar context

- @names = $dictionary-\>names

  - @names = $dictionary-\>color\_names

  Returns the list of color names contained by `$dictionary`

  Will return a list in list context, and a list reference in scalar context

- $color = $dictionary-\>color( \<query\> )

  Returns a Color::Library::Color object of `$dictionary` found via \<query\>

  A query can be any of the following:

  - color name

    A color name is like `"blue"` or `"bleached-almond"`

  - color title

    A color title is like `"Dark Green-Teal"`

  - color id

    A color id is in the form of \<dictionary\_id\>:\<color\_name\>, for example: `"x11:azure1"`

- $id = $dictionary-\>id

  - $name = $dictionary-\>name

  Returns the id (name) of `$dictionary`, e.g.

  ```
      svg
      x11
      vaccc
      nbs-iscc-f
  ```

- $title = $dictionary-\>title

  Returns the title of `$dictionary`, e.g.

  ```
      SVG
      X11
      VACCC
      NBS/ISCC F
  ```

- $subtitle = $dictionary-\>subtitle

  Returns the subtitle of `$dictionary`, if any

- $description = $dictionary-\>description

  Returns the description of `$dictionary`, if any