Index

  1. \setasign\SetaPDF2
    1. Core
      1. ColorSpace
        1. AbstractResource
        2. ColorSpace
        3. DeviceCmyk
        4. DeviceGray
        5. DeviceN
        6. DeviceRgb
        7. IccBased
        8. Indexed
        9. Lab
        10. Separation

setasign\SetaPDF2\Core\ColorSpace

Separation Separation Color Space

File: /SetaPDF v2/Core/ColorSpace/Separation.php
Old class name (alias): \SetaPDF_Core_ColorSpace_Separation

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

TYPE_COLOR_SPACE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_X_OBJECT = 'XObject'

Type constant


Properties

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObjectInterface ColorSpace::$_indirectObject

The indirect object for this color space

$_value

protected \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array ColorSpace::$_value

The main color space PDF value


Static Methods

createByDefinition()

public static ColorSpace::createByDefinition (): \SetaPDF_Core_ColorSpace|\SetaPDF_Core_ColorSpace_DeviceCmyk|\SetaPDF_Core_ColorSpace_DeviceGray|\SetaPDF_Core_ColorSpace_DeviceRgb|\SetaPDF_Core_ColorSpace_IccBased|\SetaPDF_Core_ColorSpace_Separation

Creates a color space instance based on the incoming value.

Parameters
$object : string|\SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_IndirectObjectInterface

A color space definition

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Exception

createSpotColor()

public static Separation::createSpotColor (
\SetaPDF_Core_Document $document,
string $name,
int|float|array $c,
int|float $m = null,
int|float $y = null,
int|float $k = null
): \SetaPDF_Core_ColorSpace_Separation

Creates a spot color color-space.

Parameters
$document : \SetaPDF_Core_Document
 
$name : string
 
$c : int|float|array

If is array $m, $y, $k will be ignored. The array need 4 entries.

$m : int|float
 
$y : int|float
 
$k : int|float
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception


Methods

__construct()

public Separation::__construct ()

The constructor.

Parameters
$definition : \SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Exception

getAlternateColorSpace()

public Separation::getAlternateColorSpace (
void
): \SetaPDF_Core_ColorSpace|\SetaPDF_Core_ColorSpace_DeviceCmyk|\SetaPDF_Core_ColorSpace_DeviceGray|\SetaPDF_Core_ColorSpace_DeviceRgb|\SetaPDF_Core_ColorSpace_IccBased|\SetaPDF_Core_ColorSpace_Separation

Get the alternate color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getAlternateSpace()

WARNING: This method is marked as deprecated!

public Separation::getAlternateSpace (
void
): \SetaPDF_Core_ColorSpace|\SetaPDF_Core_ColorSpace_DeviceCmyk|\SetaPDF_Core_ColorSpace_DeviceGray|\SetaPDF_Core_ColorSpace_DeviceRgb|\SetaPDF_Core_ColorSpace_IccBased|\SetaPDF_Core_ColorSpace_Separation

Get the alternate color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getColorComponents()

public ColorSpace::getColorComponents (
void
): void

Get the color components of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getDefaultDecodeArray()

public ColorSpace::getDefaultDecodeArray (
void
): void

Get the default decode array of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getFamily()

public ColorSpace::getFamily (
void
): string

Get the color space family name of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getIndirectObject()

public AbstractResource::getIndirectObject (
?\SetaPDF_Core_Document $document = null
): \SetaPDF_Core_Type_IndirectObjectInterface

Gets an indirect object for this color space dictionary.

Parameters
$document : ?\SetaPDF_Core_Document
 
Exceptions

Throws \InvalidArgumentException

See

getName()

public Separation::getName (
void
): string

Get the name of the colorant that this Separation color space is intended to represent.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getPdfValue()

public ColorSpace::getPdfValue (
void
): \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array

Get the main color space PDF value.

getResourceType()

public AbstractResource::getResourceType (
void
): string

Get the resource-type of an implementation.

getTintTransform()

public Separation::getTintTransform (
void
): \SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_Stream

Get the tint transformation function.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setAlternateColorSpace()

public Separation::setAlternateColorSpace (): void

Set the alternate color space.

Parameters
$colorSpace : \SetaPDF_Core_ColorSpace
 

setName()

public Separation::setName (
string $name
): void

Set the name of the colorant that this Separation color space is intended to represent.

Parameters
$name : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setTintTransform()

public Separation::setTintTransform (): void

Set the tint transformation function.

Parameters
$tintTransform : \SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception


© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)