Skip to main content

CommonColorIsValid

Callable

  • CommonColorIsValid(color, options): color is ItemColor

  • Checks whether an item's color has a valid value that can be interpreted by the drawing functions. Valid values are null, undefined, color strings, and an array containing any of the aforementioned types.

    Parameters

    • optionalcolor: ItemColor

      The Color value to check

    • optionaloptions: { schema?: readonly BCColor[] } = null

    Returns color is ItemColor

    • Returns TRUE if the color is a valid item color