Created by PhpStorm. More...

Inheritance diagram for PhpOffice\PhpSpreadsheet\Chart\Axis:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Chart\Axis:

Public Member Functions
	setAxisNumberProperties ($format_code)
	Get Series Data Type. More...

	getAxisNumberFormat ()
	Get Axis Number Format Data Type. More...

	getAxisNumberSourceLinked ()
	Get Axis Number Source Linked. More...

	setAxisOptionsProperties ($axis_labels, $horizontal_crosses_value=null, $horizontal_crosses=null, $axis_orientation=null, $major_tmt=null, $minor_tmt=null, $minimum=null, $maximum=null, $major_unit=null, $minor_unit=null)
	Set Axis Options Properties. More...

	getAxisOptionsProperty ($property)
	Get Axis Options Property. More...

	setAxisOrientation ($orientation)
	Set Axis Orientation Property. More...

	setFillParameters ($color, $alpha=0, $type=self::EXCEL_COLOR_TYPE_ARGB)
	Set Fill Property. More...

	setLineParameters ($color, $alpha=0, $type=self::EXCEL_COLOR_TYPE_ARGB)
	Set Line Property. More...

	getFillProperty ($property)
	Get Fill Property. More...

	getLineProperty ($property)
	Get Line Property. More...

	setLineStyleProperties ($line_width=null, $compound_type=null, $dash_type=null, $cap_type=null, $join_type=null, $head_arrow_type=null, $head_arrow_size=null, $end_arrow_type=null, $end_arrow_size=null)
	Set Line Style Properties. More...

	getLineStyleProperty ($elements)
	Get Line Style Property. More...

	getLineStyleArrowWidth ($arrow)
	Get Line Style Arrow Excel Width. More...

	getLineStyleArrowLength ($arrow)
	Get Line Style Arrow Excel Length. More...

	setShadowProperties ($sh_presets, $sh_color_value=null, $sh_color_type=null, $sh_color_alpha=null, $sh_blur=null, $sh_angle=null, $sh_distance=null)
	Set Shadow Properties. More...

	getShadowProperty ($elements)
	Get Shadow Property. More...

	setGlowProperties ($size, $color_value=null, $color_alpha=null, $color_type=null)
	Set Glow Properties. More...

	getGlowProperty ($property)
	Get Glow Property. More...

	setSoftEdges ($size)
	Set Soft Edges Size. More...

	getSoftEdgesSize ()
	Get Soft Edges Size. More...

Private Member Functions
	setShadowPresetsProperties ($shadow_presets)
	Set Shadow Color. More...

	setShadowProperiesMapValues (array $properties_map, &$reference=null)
	Set Shadow Properties from Mapped Values. More...

	setShadowColor ($color, $alpha, $type)
	Set Shadow Color. More...

	setShadowBlur ($blur)
	Set Shadow Blur. More...

	setShadowAngle ($angle)
	Set Shadow Angle. More...

	setShadowDistance ($distance)
	Set Shadow Distance. More...

	setGlowSize ($size)
	Set Glow Color. More...

	setGlowColor ($color, $alpha, $type)
	Set Glow Color. More...

Private Attributes
	$axisNumber

	$axisOptions

	$fillProperties

	$lineProperties

	$lineStyleProperties

	$shadowProperties

	$glowProperties

	$softEdges

Additional Inherited Members
Data Fields inherited from PhpOffice\PhpSpreadsheet\Chart\Properties
const	EXCEL_COLOR_TYPE_STANDARD = 'prstClr'

const	EXCEL_COLOR_TYPE_SCHEME = 'schemeClr'

const	EXCEL_COLOR_TYPE_ARGB = 'srgbClr'

const	AXIS_LABELS_LOW = 'low'

const	AXIS_LABELS_HIGH = 'high'

const	AXIS_LABELS_NEXT_TO = 'nextTo'

const	AXIS_LABELS_NONE = 'none'

const	TICK_MARK_NONE = 'none'

const	TICK_MARK_INSIDE = 'in'

const	TICK_MARK_OUTSIDE = 'out'

const	TICK_MARK_CROSS = 'cross'

const	HORIZONTAL_CROSSES_AUTOZERO = 'autoZero'

const	HORIZONTAL_CROSSES_MAXIMUM = 'max'

const	FORMAT_CODE_GENERAL = 'General'

const	FORMAT_CODE_NUMBER = '#,##0.00'

const	FORMAT_CODE_CURRENCY = '$#,##0.00'

const	FORMAT_CODE_ACCOUNTING = '_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)'

const	FORMAT_CODE_DATE = 'm/d/yyyy'

const	FORMAT_CODE_TIME = '[$-F400]h:mm:ss AM/PM'

const	FORMAT_CODE_PERCENTAGE = '0.00%'

const	FORMAT_CODE_FRACTION = '# ?/?'

const	FORMAT_CODE_SCIENTIFIC = '0.00E+00'

const	FORMAT_CODE_TEXT = '@'

const	FORMAT_CODE_SPECIAL = '00000'

const	ORIENTATION_NORMAL = 'minMax'

const	ORIENTATION_REVERSED = 'maxMin'

const	LINE_STYLE_COMPOUND_SIMPLE = 'sng'

const	LINE_STYLE_COMPOUND_DOUBLE = 'dbl'

const	LINE_STYLE_COMPOUND_THICKTHIN = 'thickThin'

const	LINE_STYLE_COMPOUND_THINTHICK = 'thinThick'

const	LINE_STYLE_COMPOUND_TRIPLE = 'tri'

const	LINE_STYLE_DASH_SOLID = 'solid'

const	LINE_STYLE_DASH_ROUND_DOT = 'sysDot'

const	LINE_STYLE_DASH_SQUERE_DOT = 'sysDash'

const	LINE_STYPE_DASH_DASH = 'dash'

const	LINE_STYLE_DASH_DASH_DOT = 'dashDot'

const	LINE_STYLE_DASH_LONG_DASH = 'lgDash'

const	LINE_STYLE_DASH_LONG_DASH_DOT = 'lgDashDot'

const	LINE_STYLE_DASH_LONG_DASH_DOT_DOT = 'lgDashDotDot'

const	LINE_STYLE_CAP_SQUARE = 'sq'

const	LINE_STYLE_CAP_ROUND = 'rnd'

const	LINE_STYLE_CAP_FLAT = 'flat'

const	LINE_STYLE_JOIN_ROUND = 'bevel'

const	LINE_STYLE_JOIN_MITER = 'miter'

const	LINE_STYLE_JOIN_BEVEL = 'bevel'

const	LINE_STYLE_ARROW_TYPE_NOARROW = null

const	LINE_STYLE_ARROW_TYPE_ARROW = 'triangle'

const	LINE_STYLE_ARROW_TYPE_OPEN = 'arrow'

const	LINE_STYLE_ARROW_TYPE_STEALTH = 'stealth'

const	LINE_STYLE_ARROW_TYPE_DIAMOND = 'diamond'

const	LINE_STYLE_ARROW_TYPE_OVAL = 'oval'

const	LINE_STYLE_ARROW_SIZE_1 = 1

const	LINE_STYLE_ARROW_SIZE_2 = 2

const	LINE_STYLE_ARROW_SIZE_3 = 3

const	LINE_STYLE_ARROW_SIZE_4 = 4

const	LINE_STYLE_ARROW_SIZE_5 = 5

const	LINE_STYLE_ARROW_SIZE_6 = 6

const	LINE_STYLE_ARROW_SIZE_7 = 7

const	LINE_STYLE_ARROW_SIZE_8 = 8

const	LINE_STYLE_ARROW_SIZE_9 = 9

const	SHADOW_PRESETS_NOSHADOW = null

const	SHADOW_PRESETS_OUTER_BOTTTOM_RIGHT = 1

const	SHADOW_PRESETS_OUTER_BOTTOM = 2

const	SHADOW_PRESETS_OUTER_BOTTOM_LEFT = 3

const	SHADOW_PRESETS_OUTER_RIGHT = 4

const	SHADOW_PRESETS_OUTER_CENTER = 5

const	SHADOW_PRESETS_OUTER_LEFT = 6

const	SHADOW_PRESETS_OUTER_TOP_RIGHT = 7

const	SHADOW_PRESETS_OUTER_TOP = 8

const	SHADOW_PRESETS_OUTER_TOP_LEFT = 9

const	SHADOW_PRESETS_INNER_BOTTTOM_RIGHT = 10

const	SHADOW_PRESETS_INNER_BOTTOM = 11

const	SHADOW_PRESETS_INNER_BOTTOM_LEFT = 12

const	SHADOW_PRESETS_INNER_RIGHT = 13

const	SHADOW_PRESETS_INNER_CENTER = 14

const	SHADOW_PRESETS_INNER_LEFT = 15

const	SHADOW_PRESETS_INNER_TOP_RIGHT = 16

const	SHADOW_PRESETS_INNER_TOP = 17

const	SHADOW_PRESETS_INNER_TOP_LEFT = 18

const	SHADOW_PRESETS_PERSPECTIVE_BELOW = 19

const	SHADOW_PRESETS_PERSPECTIVE_UPPER_RIGHT = 20

const	SHADOW_PRESETS_PERSPECTIVE_UPPER_LEFT = 21

const	SHADOW_PRESETS_PERSPECTIVE_LOWER_RIGHT = 22

const	SHADOW_PRESETS_PERSPECTIVE_LOWER_LEFT = 23

Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Chart\Properties
	getExcelPointsWidth ($width)

	getExcelPointsAngle ($angle)

	getTrueAlpha ($alpha)

	setColorProperties ($color, $alpha, $type)

	getLineStyleArrowSize ($array_selector, $array_kay_selector)

	getShadowPresetsMap ($shadow_presets_option)

	getArrayElementsValue ($properties, $elements)

Detailed Description

Created by PhpStorm.

User: Wiktor Trzonkowski Date: 6/17/14 Time: 12:11 PM.

Definition at line 11 of file Axis.php.

Member Function Documentation

◆ getAxisNumberFormat()

PhpOffice\PhpSpreadsheet\Chart\Axis::getAxisNumberFormat ( )

Get Axis Number Format Data Type.

Returns: string

Definition at line 150 of file Axis.php.

    {
        return $this->axisNumber['format'];
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeCategoryAxis(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the caller graph for this function:

◆ getAxisNumberSourceLinked()

PhpOffice\PhpSpreadsheet\Chart\Axis::getAxisNumberSourceLinked ( )

Get Axis Number Source Linked.

Returns: string

Definition at line 160 of file Axis.php.

    {
        return (string) $this->axisNumber['source_linked'];
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeCategoryAxis(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the caller graph for this function:

◆ getAxisOptionsProperty()

PhpOffice\PhpSpreadsheet\Chart\Axis::getAxisOptionsProperty ( $property )

Get Axis Options Property.

Parameters

string $property

Returns: string

Definition at line 201 of file Axis.php.

    {
        return $this->axisOptions[$property];
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeCategoryAxis(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the caller graph for this function:

◆ getFillProperty()

PhpOffice\PhpSpreadsheet\Chart\Axis::getFillProperty ( $property )

Get Fill Property.

Parameters

string $property

Returns: string

Definition at line 247 of file Axis.php.

    {
        return $this->fillProperties[$property];
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the caller graph for this function:

◆ getGlowProperty()

PhpOffice\PhpSpreadsheet\Chart\Axis::getGlowProperty ( $property )

Get Glow Property.

Parameters

array | string $property

Returns: string

Definition at line 496 of file Axis.php.

    {
        return $this->getArrayElementsValue($this->glowProperties, $property);
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getArrayElementsValue().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLineProperty()

PhpOffice\PhpSpreadsheet\Chart\Axis::getLineProperty ( $property )

Get Line Property.

Parameters

string $property

Returns: string

Definition at line 259 of file Axis.php.

    {
        return $this->lineProperties[$property];
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the caller graph for this function:

◆ getLineStyleArrowLength()

PhpOffice\PhpSpreadsheet\Chart\Axis::getLineStyleArrowLength ( $arrow )

Get Line Style Arrow Excel Length.

Parameters

string $arrow

Returns: string

Definition at line 321 of file Axis.php.

    {
        return $this->getLineStyleArrowSize($this->lineStyleProperties['arrow'][$arrow]['size'], 'len');
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getLineStyleArrowSize().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLineStyleArrowWidth()

PhpOffice\PhpSpreadsheet\Chart\Axis::getLineStyleArrowWidth ( $arrow )

Get Line Style Arrow Excel Width.

Parameters

string $arrow

Returns: string

Definition at line 309 of file Axis.php.

    {
        return $this->getLineStyleArrowSize($this->lineStyleProperties['arrow'][$arrow]['size'], 'w');
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getLineStyleArrowSize().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLineStyleProperty()

PhpOffice\PhpSpreadsheet\Chart\Axis::getLineStyleProperty ( $elements )

Get Line Style Property.

Parameters

array | string $elements

Returns: string

Definition at line 297 of file Axis.php.

    {
        return $this->getArrayElementsValue($this->lineStyleProperties, $elements);
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getArrayElementsValue().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShadowProperty()

PhpOffice\PhpSpreadsheet\Chart\Axis::getShadowProperty ( $elements )

Get Shadow Property.

Parameters

string | string[] $elements

Returns: null|array|int|string

Definition at line 466 of file Axis.php.

    {
        return $this->getArrayElementsValue($this->shadowProperties, $elements);
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getArrayElementsValue().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSoftEdgesSize()

PhpOffice\PhpSpreadsheet\Chart\Axis::getSoftEdgesSize ( )

Get Soft Edges Size.

Returns: string

Definition at line 550 of file Axis.php.

    {
        return $this->softEdges['size'];
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Chart\writeValueAxis().

Here is the caller graph for this function:

◆ setAxisNumberProperties()

PhpOffice\PhpSpreadsheet\Chart\Axis::setAxisNumberProperties ( $format_code )

Get Series Data Type.

Parameters

mixed $format_code

Definition at line 139 of file Axis.php.

                                                         : void
    {
        $this->axisNumber['format'] = (string) $format_code;
        $this->axisNumber['source_linked'] = 0;
    }

◆ setAxisOptionsProperties()

PhpOffice\PhpSpreadsheet\Chart\Axis::setAxisOptionsProperties	(	$axis_labels,
		$horizontal_crosses_value = `null`,
		$horizontal_crosses = `null`,
		$axis_orientation = `null`,
		$major_tmt = `null`,
		$minor_tmt = `null`,
		$minimum = `null`,
		$maximum = `null`,
		$major_unit = `null`,
		$minor_unit = `null`
	)

Set Axis Options Properties.

Parameters

string	$axis_labels
string	$horizontal_crosses_value
string	$horizontal_crosses
string	$axis_orientation
string	$major_tmt
string	$minor_tmt
string	$minimum
string	$maximum
string	$major_unit
string	$minor_unit

Definition at line 179 of file Axis.php.

                                                                                                                                                                                                                                                                  : void
    {
        $this->axisOptions['axis_labels'] = (string) $axis_labels;
        ($horizontal_crosses_value !== null) ? $this->axisOptions['horizontal_crosses_value'] = (string) $horizontal_crosses_value : null;
        ($horizontal_crosses !== null) ? $this->axisOptions['horizontal_crosses'] = (string) $horizontal_crosses : null;
        ($axis_orientation !== null) ? $this->axisOptions['orientation'] = (string) $axis_orientation : null;
        ($major_tmt !== null) ? $this->axisOptions['major_tick_mark'] = (string) $major_tmt : null;
        ($minor_tmt !== null) ? $this->axisOptions['minor_tick_mark'] = (string) $minor_tmt : null;
        ($minor_tmt !== null) ? $this->axisOptions['minor_tick_mark'] = (string) $minor_tmt : null;
        ($minimum !== null) ? $this->axisOptions['minimum'] = (string) $minimum : null;
        ($maximum !== null) ? $this->axisOptions['maximum'] = (string) $maximum : null;
        ($major_unit !== null) ? $this->axisOptions['major_unit'] = (string) $major_unit : null;
        ($minor_unit !== null) ? $this->axisOptions['minor_unit'] = (string) $minor_unit : null;
    }

◆ setAxisOrientation()

PhpOffice\PhpSpreadsheet\Chart\Axis::setAxisOrientation ( $orientation )

Set Axis Orientation Property.

Parameters

string $orientation

Definition at line 211 of file Axis.php.

                                                    : void
    {
        $this->axisOptions['orientation'] = (string) $orientation;
    }

◆ setFillParameters()

PhpOffice\PhpSpreadsheet\Chart\Axis::setFillParameters	(	$color,
		$alpha = `0`,
		$type = `self::EXCEL_COLOR_TYPE_ARGB`
	)

Set Fill Property.

Parameters

string	$color
int	$alpha
string	$type

Definition at line 223 of file Axis.php.

                                                                                            : void
    {
        $this->fillProperties = $this->setColorProperties($color, $alpha, $type);
    }

References $type, and PhpOffice\PhpSpreadsheet\Chart\Properties\setColorProperties().

Here is the call graph for this function:

◆ setGlowColor()

PhpOffice\PhpSpreadsheet\Chart\Axis::setGlowColor	(	$color,
		$alpha,
		$type
	)

private

Set Glow Color.

Parameters

string	$color
int	$alpha
string	$type

Returns: $this

Definition at line 526 of file Axis.php.

    {
        $this->glowProperties['color'] = $this->setColorProperties($color, $alpha, $type);
 
        return $this;
    }

References $type, and PhpOffice\PhpSpreadsheet\Chart\Properties\setColorProperties().

Here is the call graph for this function:

◆ setGlowProperties()

PhpOffice\PhpSpreadsheet\Chart\Axis::setGlowProperties	(	$size,
		$color_value = `null`,
		$color_alpha = `null`,
		$color_type = `null`
	)

Set Glow Properties.

Parameters

float	$size
string	$color_value
int	$color_alpha
string	$color_type

Definition at line 479 of file Axis.php.

                                                                                                          : void
    {
        $this->setGlowSize($size)
            ->setGlowColor(
                $color_value ?? $this->glowProperties['color']['value'],
                $color_alpha ?? (int) $this->glowProperties['color']['alpha'],
                $color_type ?? $this->glowProperties['color']['type']
            );
    }

References $size, and PhpOffice\PhpSpreadsheet\Chart\Axis\setGlowSize().

Here is the call graph for this function:

◆ setGlowSize()

PhpOffice\PhpSpreadsheet\Chart\Axis::setGlowSize ( $size )

private

Set Glow Color.

Parameters

float $size

Returns: $this

Definition at line 508 of file Axis.php.

    {
        if ($size !== null) {
            $this->glowProperties['size'] = $this->getExcelPointsWidth($size);
        }
 
        return $this;
    }

References $size, and PhpOffice\PhpSpreadsheet\Chart\Properties\getExcelPointsWidth().

Referenced by PhpOffice\PhpSpreadsheet\Chart\Axis\setGlowProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLineParameters()

PhpOffice\PhpSpreadsheet\Chart\Axis::setLineParameters	(	$color,
		$alpha = `0`,
		$type = `self::EXCEL_COLOR_TYPE_ARGB`
	)

Set Line Property.

Parameters

string	$color
int	$alpha
string	$type

Definition at line 235 of file Axis.php.

                                                                                            : void
    {
        $this->lineProperties = $this->setColorProperties($color, $alpha, $type);
    }

References $type, and PhpOffice\PhpSpreadsheet\Chart\Properties\setColorProperties().

Here is the call graph for this function:

◆ setLineStyleProperties()

PhpOffice\PhpSpreadsheet\Chart\Axis::setLineStyleProperties	(	$line_width = `null`,
		$compound_type = `null`,
		$dash_type = `null`,
		$cap_type = `null`,
		$join_type = `null`,
		$head_arrow_type = `null`,
		$head_arrow_size = `null`,
		$end_arrow_type = `null`,
		$end_arrow_size = `null`
	)

Set Line Style Properties.

Parameters

float	$line_width
string	$compound_type
string	$dash_type
string	$cap_type
string	$join_type
string	$head_arrow_type
string	$head_arrow_size
string	$end_arrow_type
string	$end_arrow_size

Definition at line 277 of file Axis.php.

                                                                                                                                                                                                                                               : void
    {
        ($line_width !== null) ? $this->lineStyleProperties['width'] = $this->getExcelPointsWidth((float) $line_width) : null;
        ($compound_type !== null) ? $this->lineStyleProperties['compound'] = (string) $compound_type : null;
        ($dash_type !== null) ? $this->lineStyleProperties['dash'] = (string) $dash_type : null;
        ($cap_type !== null) ? $this->lineStyleProperties['cap'] = (string) $cap_type : null;
        ($join_type !== null) ? $this->lineStyleProperties['join'] = (string) $join_type : null;
        ($head_arrow_type !== null) ? $this->lineStyleProperties['arrow']['head']['type'] = (string) $head_arrow_type : null;
        ($head_arrow_size !== null) ? $this->lineStyleProperties['arrow']['head']['size'] = (string) $head_arrow_size : null;
        ($end_arrow_type !== null) ? $this->lineStyleProperties['arrow']['end']['type'] = (string) $end_arrow_type : null;
        ($end_arrow_size !== null) ? $this->lineStyleProperties['arrow']['end']['size'] = (string) $end_arrow_size : null;
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getExcelPointsWidth().

Here is the call graph for this function:

◆ setShadowAngle()

PhpOffice\PhpSpreadsheet\Chart\Axis::setShadowAngle ( $angle )

private

Set Shadow Angle.

Parameters

int $angle

Returns: $this

Definition at line 434 of file Axis.php.

    {
        if ($angle !== null) {
            $this->shadowProperties['direction'] = (string) $this->getExcelPointsAngle($angle);
        }
 
        return $this;
    }

References $angle, and PhpOffice\PhpSpreadsheet\Chart\Properties\getExcelPointsAngle().

Here is the call graph for this function:

◆ setShadowBlur()

PhpOffice\PhpSpreadsheet\Chart\Axis::setShadowBlur ( $blur )

private

Set Shadow Blur.

Parameters

float $blur

Returns: $this

Definition at line 418 of file Axis.php.

    {
        if ($blur !== null) {
            $this->shadowProperties['blur'] = (string) $this->getExcelPointsWidth($blur);
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getExcelPointsWidth().

Here is the call graph for this function:

◆ setShadowColor()

PhpOffice\PhpSpreadsheet\Chart\Axis::setShadowColor	(	$color,
		$alpha,
		$type
	)

private

Set Shadow Color.

Parameters

string	$color
int	$alpha
string	$type

Returns: $this

Definition at line 404 of file Axis.php.

    {
        $this->shadowProperties['color'] = $this->setColorProperties($color, $alpha, $type);
 
        return $this;
    }

References $type, and PhpOffice\PhpSpreadsheet\Chart\Properties\setColorProperties().

Here is the call graph for this function:

◆ setShadowDistance()

PhpOffice\PhpSpreadsheet\Chart\Axis::setShadowDistance ( $distance )

private

Set Shadow Distance.

Parameters

float $distance

Returns: $this

Definition at line 450 of file Axis.php.

    {
        if ($distance !== null) {
            $this->shadowProperties['distance'] = (string) $this->getExcelPointsWidth($distance);
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getExcelPointsWidth().

Here is the call graph for this function:

◆ setShadowPresetsProperties()

PhpOffice\PhpSpreadsheet\Chart\Axis::setShadowPresetsProperties ( $shadow_presets )

private

Set Shadow Color.

Parameters

int $shadow_presets

Returns: $this

Definition at line 357 of file Axis.php.

    {
        $this->shadowProperties['presets'] = $shadow_presets;
        $this->setShadowProperiesMapValues($this->getShadowPresetsMap($shadow_presets));
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Chart\Properties\getShadowPresetsMap(), and PhpOffice\PhpSpreadsheet\Chart\Axis\setShadowProperiesMapValues().

Referenced by PhpOffice\PhpSpreadsheet\Chart\Axis\setShadowProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setShadowProperiesMapValues()

PhpOffice\PhpSpreadsheet\Chart\Axis::setShadowProperiesMapValues	(	array	$properties_map,
		&	$reference = `null`
	)

private

Set Shadow Properties from Mapped Values.

Parameters

mixed $reference

Returns: $this

Definition at line 372 of file Axis.php.

    {
        $base_reference = $reference;
        foreach ($properties_map as $property_key => $property_val) {
            if (is_array($property_val)) {
                if ($reference === null) {
                    $reference = &$this->shadowProperties[$property_key];
                } else {
                    $reference = &$reference[$property_key];
                }
                $this->setShadowProperiesMapValues($property_val, $reference);
            } else {
                if ($base_reference === null) {
                    $this->shadowProperties[$property_key] = $property_val;
                } else {
                    $reference[$property_key] = $property_val;
                }
            }
        }
 
        return $this;
    }

References PhpOffice\PhpSpreadsheet\Chart\Axis\setShadowProperiesMapValues().

Referenced by PhpOffice\PhpSpreadsheet\Chart\Axis\setShadowPresetsProperties(), and PhpOffice\PhpSpreadsheet\Chart\Axis\setShadowProperiesMapValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setShadowProperties()

PhpOffice\PhpSpreadsheet\Chart\Axis::setShadowProperties	(	$sh_presets,
		$sh_color_value = `null`,
		$sh_color_type = `null`,
		$sh_color_alpha = `null`,
		$sh_blur = `null`,
		$sh_angle = `null`,
		$sh_distance = `null`
	)

Set Shadow Properties.

Parameters

int	$sh_presets
string	$sh_color_value
string	$sh_color_type
string	$sh_color_alpha
float	$sh_blur
int	$sh_angle
float	$sh_distance

Definition at line 337 of file Axis.php.

                                                                                                                                                                                   : void
    {
        $this->setShadowPresetsProperties((int) $sh_presets)
            ->setShadowColor(
                $sh_color_value ?? $this->shadowProperties['color']['value'],
                $sh_color_alpha ?? (int) $this->shadowProperties['color']['alpha'],
                $sh_color_type ?? $this->shadowProperties['color']['type']
            )
            ->setShadowBlur($sh_blur)
            ->setShadowAngle($sh_angle)
            ->setShadowDistance($sh_distance);
    }

References PhpOffice\PhpSpreadsheet\Chart\Axis\setShadowPresetsProperties().

Here is the call graph for this function:

◆ setSoftEdges()

PhpOffice\PhpSpreadsheet\Chart\Axis::setSoftEdges ( $size )

Set Soft Edges Size.

Parameters

float $size

Definition at line 538 of file Axis.php.

                                       : void
    {
        if ($size !== null) {
            $softEdges['size'] = (string) $this->getExcelPointsWidth($size);
        }
    }

References $size, PhpOffice\PhpSpreadsheet\Chart\Axis\$softEdges, and PhpOffice\PhpSpreadsheet\Chart\Properties\getExcelPointsWidth().

Here is the call graph for this function:

Field Documentation

◆ $axisNumber

PhpOffice\PhpSpreadsheet\Chart\Axis::$axisNumber

private

Initial value:

= [
        'format' => self::FORMAT_CODE_GENERAL,
        'source_linked' => 1,
    ]

Definition at line 18 of file Axis.php.

◆ $axisOptions

PhpOffice\PhpSpreadsheet\Chart\Axis::$axisOptions

private

Initial value:

= [
        'minimum' => null,
        'maximum' => null,
        'major_unit' => null,
        'minor_unit' => null,
        'orientation' => self::ORIENTATION_NORMAL,
        'minor_tick_mark' => self::TICK_MARK_NONE,
        'major_tick_mark' => self::TICK_MARK_NONE,
        'axis_labels' => self::AXIS_LABELS_NEXT_TO,
        'horizontal_crosses' => self::HORIZONTAL_CROSSES_AUTOZERO,
        'horizontal_crosses_value' => null,
    ]

Definition at line 28 of file Axis.php.

◆ $fillProperties

PhpOffice\PhpSpreadsheet\Chart\Axis::$fillProperties

private

Initial value:

= [
        'type' => self::EXCEL_COLOR_TYPE_ARGB,
        'value' => null,
        'alpha' => 0,
    ]

Definition at line 46 of file Axis.php.

◆ $glowProperties

PhpOffice\PhpSpreadsheet\Chart\Axis::$glowProperties

private

Initial value:

= [
        'size' => null,
        'color' => [
            'type' => self::EXCEL_COLOR_TYPE_STANDARD,
            'value' => 'black',
            'alpha' => 40,
        ],
    ]

Definition at line 116 of file Axis.php.

◆ $lineProperties

PhpOffice\PhpSpreadsheet\Chart\Axis::$lineProperties

private

Initial value:

= [
        'type' => self::EXCEL_COLOR_TYPE_ARGB,
        'value' => null,
        'alpha' => 0,
    ]

Definition at line 57 of file Axis.php.

◆ $lineStyleProperties

PhpOffice\PhpSpreadsheet\Chart\Axis::$lineStyleProperties

private

Initial value:

= [
        'width' => '9525',
        'compound' => self::LINE_STYLE_COMPOUND_SIMPLE,
        'dash' => self::LINE_STYLE_DASH_SOLID,
        'cap' => self::LINE_STYLE_CAP_FLAT,
        'join' => self::LINE_STYLE_JOIN_BEVEL,
        'arrow' => [
            'head' => [
                'type' => self::LINE_STYLE_ARROW_TYPE_NOARROW,
                'size' => self::LINE_STYLE_ARROW_SIZE_5,
            ],
            'end' => [
                'type' => self::LINE_STYLE_ARROW_TYPE_NOARROW,
                'size' => self::LINE_STYLE_ARROW_SIZE_8,
            ],
        ],
    ]

Definition at line 68 of file Axis.php.

◆ $shadowProperties

PhpOffice\PhpSpreadsheet\Chart\Axis::$shadowProperties

private

Initial value:

= [
        'presets' => self::SHADOW_PRESETS_NOSHADOW,
        'effect' => null,
        'color' => [
            'type' => self::EXCEL_COLOR_TYPE_STANDARD,
            'value' => 'black',
            'alpha' => 40,
        ],
        'size' => [
            'sx' => null,
            'sy' => null,
            'kx' => null,
        ],
        'blur' => null,
        'direction' => null,
        'distance' => null,
        'algn' => null,
        'rotWithShape' => null,
    ]

Definition at line 91 of file Axis.php.

◆ $softEdges

PhpOffice\PhpSpreadsheet\Chart\Axis::$softEdges

private

Initial value:

= [
        'size' => null,
    ]

Definition at line 130 of file Axis.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Axis\setSoftEdges().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Chart/Axis.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAxisNumberFormat()

◆ getAxisNumberSourceLinked()

◆ getAxisOptionsProperty()

◆ getFillProperty()

◆ getGlowProperty()

◆ getLineProperty()

◆ getLineStyleArrowLength()

◆ getLineStyleArrowWidth()

◆ getLineStyleProperty()

◆ getShadowProperty()

◆ getSoftEdgesSize()

◆ setAxisNumberProperties()

◆ setAxisOptionsProperties()

◆ setAxisOrientation()

◆ setFillParameters()

◆ setGlowColor()

◆ setGlowProperties()

◆ setGlowSize()

◆ setLineParameters()

◆ setLineStyleProperties()

◆ setShadowAngle()

◆ setShadowBlur()

◆ setShadowColor()

◆ setShadowDistance()

◆ setShadowPresetsProperties()

◆ setShadowProperiesMapValues()

◆ setShadowProperties()

◆ setSoftEdges()

Field Documentation

◆ $axisNumber

◆ $axisOptions

◆ $fillProperties

◆ $glowProperties

◆ $lineProperties

◆ $lineStyleProperties

◆ $shadowProperties

◆ $softEdges