See Release Notes
Long Term Support Release
<?php namespace PhpOffice\PhpSpreadsheet\Chart; /** * Created by PhpStorm. * User: Wiktor Trzonkowski * Date: 7/2/14 * Time: 2:36 PM. */ class GridLines extends Properties { /** * Properties of Class: * Object State (State for Minor Tick Mark) @var bool * Line Properties @var array of mixed * Shadow Properties @var array of mixed * Glow Properties @var array of mixed * Soft Properties @var array of mixed. */ private $objectState = false; private $lineProperties = [ 'color' => [ 'type' => self::EXCEL_COLOR_TYPE_STANDARD, 'value' => null, 'alpha' => 0, ], 'style' => [ '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, ], ], ], ]; private $shadowProperties = [ 'presets' => self::SHADOW_PRESETS_NOSHADOW, 'effect' => null, 'color' => [ 'type' => self::EXCEL_COLOR_TYPE_STANDARD, 'value' => 'black', 'alpha' => 85, ], 'size' => [ 'sx' => null, 'sy' => null, 'kx' => null, ], 'blur' => null, 'direction' => null, 'distance' => null, 'algn' => null, 'rotWithShape' => null, ]; private $glowProperties = [ 'size' => null, 'color' => [ 'type' => self::EXCEL_COLOR_TYPE_STANDARD, 'value' => 'black', 'alpha' => 40, ], ]; private $softEdges = [ 'size' => null, ]; /** * Get Object State. * * @return bool */ public function getObjectState() { return $this->objectState; } /** * Change Object State to True. *< * @return GridLines> * @return $this*/ private function activateObject() { $this->objectState = true; return $this; } /** * Set Line Color Properties. * * @param string $value * @param int $alpha< * @param string $type> * @param string $colorType*/< public function setLineColorProperties($value, $alpha = 0, $type = self::EXCEL_COLOR_TYPE_STANDARD)> public function setLineColorProperties($value, $alpha = 0, $colorType = self::EXCEL_COLOR_TYPE_STANDARD): void{ $this->activateObject() ->lineProperties['color'] = $this->setColorProperties( $value, $alpha,< $type> $colorType); } /** * Set Line Color Properties. *< * @param float $line_width < * @param string $compound_type < * @param string $dash_type < * @param string $cap_type < * @param string $join_type < * @param string $head_arrow_type < * @param string $head_arrow_size < * @param string $end_arrow_type < * @param string $end_arrow_size> * @param float $lineWidth > * @param string $compoundType > * @param string $dashType > * @param string $capType > * @param string $joinType > * @param string $headArrowType > * @param string $headArrowSize > * @param string $endArrowType > * @param string $endArrowSize*/< public function 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)> public function setLineStyleProperties($lineWidth = null, $compoundType = null, $dashType = null, $capType = null, $joinType = null, $headArrowType = null, $headArrowSize = null, $endArrowType = null, $endArrowSize = null): void{ $this->activateObject();< ($line_width !== null) < ? $this->lineProperties['style']['width'] = $this->getExcelPointsWidth((float) $line_width)> ($lineWidth !== null) > ? $this->lineProperties['style']['width'] = $this->getExcelPointsWidth((float) $lineWidth): null;< ($compound_type !== null) < ? $this->lineProperties['style']['compound'] = (string) $compound_type> ($compoundType !== null) > ? $this->lineProperties['style']['compound'] = (string) $compoundType: null;< ($dash_type !== null) < ? $this->lineProperties['style']['dash'] = (string) $dash_type> ($dashType !== null) > ? $this->lineProperties['style']['dash'] = (string) $dashType: null;< ($cap_type !== null) < ? $this->lineProperties['style']['cap'] = (string) $cap_type> ($capType !== null) > ? $this->lineProperties['style']['cap'] = (string) $capType: null;< ($join_type !== null) < ? $this->lineProperties['style']['join'] = (string) $join_type> ($joinType !== null) > ? $this->lineProperties['style']['join'] = (string) $joinType: null;< ($head_arrow_type !== null) < ? $this->lineProperties['style']['arrow']['head']['type'] = (string) $head_arrow_type> ($headArrowType !== null) > ? $this->lineProperties['style']['arrow']['head']['type'] = (string) $headArrowType: null;< ($head_arrow_size !== null) < ? $this->lineProperties['style']['arrow']['head']['size'] = (string) $head_arrow_size> ($headArrowSize !== null) > ? $this->lineProperties['style']['arrow']['head']['size'] = (string) $headArrowSize: null;< ($end_arrow_type !== null) < ? $this->lineProperties['style']['arrow']['end']['type'] = (string) $end_arrow_type> ($endArrowType !== null) > ? $this->lineProperties['style']['arrow']['end']['type'] = (string) $endArrowType: null;< ($end_arrow_size !== null) < ? $this->lineProperties['style']['arrow']['end']['size'] = (string) $end_arrow_size> ($endArrowSize !== null) > ? $this->lineProperties['style']['arrow']['end']['size'] = (string) $endArrowSize: null; } /** * Get Line Color Property. *< * @param string $parameter> * @param string $propertyName* * @return string */< public function getLineColorProperty($parameter)> public function getLineColorProperty($propertyName){< return $this->lineProperties['color'][$parameter];> return $this->lineProperties['color'][$propertyName];} /** * Get Line Style Property. * * @param array|string $elements * * @return string */ public function getLineStyleProperty($elements) { return $this->getArrayElementsValue($this->lineProperties['style'], $elements); } /** * Set Glow Properties. * * @param float $size< * @param string $color_value < * @param int $color_alpha < * @param string $color_type> * @param string $colorValue > * @param int $colorAlpha > * @param string $colorType*/< public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null)> public function setGlowProperties($size, $colorValue = null, $colorAlpha = null, $colorType = null): void{ $this ->activateObject() ->setGlowSize($size)< ->setGlowColor($color_value, $color_alpha, $color_type);> ->setGlowColor($colorValue, $colorAlpha, $colorType);} /** * Get Glow Color Property. *< * @param string $property> * @param string $propertyName* * @return string */< public function getGlowColor($property)> public function getGlowColor($propertyName){< return $this->glowProperties['color'][$property];> return $this->glowProperties['color'][$propertyName];} /** * Get Glow Size. * * @return string */ public function getGlowSize() { return $this->glowProperties['size']; } /** * Set Glow Size. * * @param float $size *< * @return GridLines> * @return $this*/ private function setGlowSize($size) { $this->glowProperties['size'] = $this->getExcelPointsWidth((float) $size); return $this; } /** * Set Glow Color. * * @param string $color * @param int $alpha< * @param string $type> * @param string $colorType*< * @return GridLines> * @return $this*/< private function setGlowColor($color, $alpha, $type)> private function setGlowColor($color, $alpha, $colorType){ if ($color !== null) { $this->glowProperties['color']['value'] = (string) $color; } if ($alpha !== null) { $this->glowProperties['color']['alpha'] = $this->getTrueAlpha((int) $alpha); }< if ($type !== null) { < $this->glowProperties['color']['type'] = (string) $type;> if ($colorType !== null) { > $this->glowProperties['color']['type'] = (string) $colorType;} return $this; } /** * Get Line Style Arrow Parameters. *< * @param string $arrow_selector < * @param string $property_selector> * @param string $arrowSelector > * @param string $propertySelector* * @return string */< public function getLineStyleArrowParameters($arrow_selector, $property_selector)> public function getLineStyleArrowParameters($arrowSelector, $propertySelector){< return $this->getLineStyleArrowSize($this->lineProperties['style']['arrow'][$arrow_selector]['size'], $property_selector);> return $this->getLineStyleArrowSize($this->lineProperties['style']['arrow'][$arrowSelector]['size'], $propertySelector);} /** * Set Shadow Properties. *< * @param int $sh_presets < * @param string $sh_color_value < * @param string $sh_color_type < * @param int $sh_color_alpha < * @param string $sh_blur < * @param int $sh_angle < * @param float $sh_distance> * @param int $presets > * @param string $colorValue > * @param string $colorType > * @param string $colorAlpha > * @param string $blur > * @param int $angle > * @param float $distance*/< public function setShadowProperties($sh_presets, $sh_color_value = null, $sh_color_type = null, $sh_color_alpha = null, $sh_blur = null, $sh_angle = null, $sh_distance = null)> public function setShadowProperties($presets, $colorValue = null, $colorType = null, $colorAlpha = null, $blur = null, $angle = null, $distance = null): void{ $this->activateObject()< ->setShadowPresetsProperties((int) $sh_presets)> ->setShadowPresetsProperties((int) $presets)->setShadowColor(< $sh_color_value === null ? $this->shadowProperties['color']['value'] : $sh_color_value, < $sh_color_alpha === null ? (int) $this->shadowProperties['color']['alpha'] : $this->getTrueAlpha($sh_color_alpha), < $sh_color_type === null ? $this->shadowProperties['color']['type'] : $sh_color_type> $colorValue ?? $this->shadowProperties['color']['value'], > $colorAlpha === null ? (int) $this->shadowProperties['color']['alpha'] : $this->getTrueAlpha($colorAlpha), > $colorType ?? $this->shadowProperties['color']['type'])< ->setShadowBlur($sh_blur) < ->setShadowAngle($sh_angle) < ->setShadowDistance($sh_distance);> ->setShadowBlur((float) $blur) > ->setShadowAngle($angle) > ->setShadowDistance($distance);} /** * Set Shadow Presets Properties. *< * @param int $shadow_presets> * @param int $presets*< * @return GridLines> * @return $this*/< private function setShadowPresetsProperties($shadow_presets)> private function setShadowPresetsProperties($presets){< $this->shadowProperties['presets'] = $shadow_presets; < $this->setShadowProperiesMapValues($this->getShadowPresetsMap($shadow_presets));> $this->shadowProperties['presets'] = $presets; > $this->setShadowPropertiesMapValues($this->getShadowPresetsMap($presets));return $this; } /** * Set Shadow Properties Values. *< * @param array $properties_map < * @param mixed &$reference> * @param mixed $reference*< * @return GridLines> * @return $this*/< private function setShadowProperiesMapValues(array $properties_map, &$reference = null)> private function setShadowPropertiesMapValues(array $propertiesMap, &$reference = null){ $base_reference = $reference;< foreach ($properties_map as $property_key => $property_val) {> foreach ($propertiesMap 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);> $this->setShadowPropertiesMapValues($property_val, $reference);} else { if ($base_reference === null) { $this->shadowProperties[$property_key] = $property_val; } else { $reference[$property_key] = $property_val; } } } return $this; } /** * Set Shadow Color. * * @param string $color * @param int $alpha< * @param string $type> * @param string $colorType*< * @return GridLines> * @return $this*/< private function setShadowColor($color, $alpha, $type)> private function setShadowColor($color, $alpha, $colorType){ if ($color !== null) { $this->shadowProperties['color']['value'] = (string) $color; } if ($alpha !== null) { $this->shadowProperties['color']['alpha'] = $this->getTrueAlpha((int) $alpha); }< if ($type !== null) { < $this->shadowProperties['color']['type'] = (string) $type;> if ($colorType !== null) { > $this->shadowProperties['color']['type'] = (string) $colorType;} return $this; } /** * Set Shadow Blur. * * @param float $blur *< * @return GridLines> * @return $this*/ private function setShadowBlur($blur) { if ($blur !== null) { $this->shadowProperties['blur'] = (string) $this->getExcelPointsWidth($blur); } return $this; } /** * Set Shadow Angle. * * @param int $angle *< * @return GridLines> * @return $this*/ private function setShadowAngle($angle) { if ($angle !== null) { $this->shadowProperties['direction'] = (string) $this->getExcelPointsAngle($angle); } return $this; } /** * Set Shadow Distance. * * @param float $distance *< * @return GridLines> * @return $this*/ private function setShadowDistance($distance) { if ($distance !== null) { $this->shadowProperties['distance'] = (string) $this->getExcelPointsWidth($distance); } return $this; } /** * Get Shadow Property. * * @param string|string[] $elements * * @return string */ public function getShadowProperty($elements) { return $this->getArrayElementsValue($this->shadowProperties, $elements); } /** * Set Soft Edges Size. * * @param float $size */< public function setSoftEdgesSize($size)> public function setSoftEdgesSize($size): void{ if ($size !== null) { $this->activateObject(); $this->softEdges['size'] = (string) $this->getExcelPointsWidth($size); } } /** * Get Soft Edges Size. * * @return string */ public function getSoftEdgesSize() { return $this->softEdges['size']; } }