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

Lab Lab Color Space

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

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


Methods

__construct()

public Lab::__construct ()

The constructor.

Parameters
$definition : \SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Exception

_getDictionary()

private Lab::_getDictionary (
void
): \SetaPDF_Core_Type_Dictionary
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getBlackPoint()

public Lab::getBlackPoint (
void
): array|float[]

Get the BlackPoint values.

Exceptions

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

getPdfValue()

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

Get the main color space PDF value.

getRange()

public Lab::getRange (
void
): array|int[]

Get the Range values.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getResourceType()

public AbstractResource::getResourceType (
void
): string

Get the resource-type of an implementation.

getWhitePoint()

public Lab::getWhitePoint (
void
): array

Get the WhitePoint value.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

setBlackPoint()

public Lab::setBlackPoint (
int|float|int[] $x,
int|float $y = null,
int|float $z = null
): void

Set the BlackPoint value.

Parameters
$x : int|float|int[]
 
$y : int|float
 
$z : int|float
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setRange()

public Lab::setRange (
int|float|int[] $aMin,
int|float $aMax = null,
int|float $bMin = null,
int|float $bMax = null
): void

Set the Range values.

Parameters
$aMin : int|float|int[]
 
$aMax : int|float
 
$bMin : int|float
 
$bMax : int|float
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setWhitePoint()

public Lab::setWhitePoint (
int|float|int[] $x,
int|float $y = null,
int|float $z = null
): void

Set the WhitePoint values.

Parameters
$x : int|float|int[]
 
$y : int|float
 
$z : int|float
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception


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