\PhpOffice\PhpSpreadsheet\ChartAxis

Created by PhpStorm.

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

Summary

Methods
Properties
Constants
setAxisNumberProperties()
getAxisNumberFormat()
getAxisNumberSourceLinked()
setAxisOptionsProperties()
getAxisOptionsProperty()
setAxisOrientation()
setFillParameters()
setLineParameters()
getFillProperty()
getLineProperty()
setLineStyleProperties()
getLineStyleProperty()
getLineStyleArrowWidth()
getLineStyleArrowLength()
setShadowProperties()
getShadowProperty()
setGlowProperties()
getGlowProperty()
setSoftEdges()
getSoftEdgesSize()
No public properties found
EXCEL_COLOR_TYPE_STANDARD
EXCEL_COLOR_TYPE_SCHEME
EXCEL_COLOR_TYPE_ARGB
AXIS_LABELS_LOW
AXIS_LABELS_HIGH
AXIS_LABELS_NEXT_TO
AXIS_LABELS_NONE
TICK_MARK_NONE
TICK_MARK_INSIDE
TICK_MARK_OUTSIDE
TICK_MARK_CROSS
HORIZONTAL_CROSSES_AUTOZERO
HORIZONTAL_CROSSES_MAXIMUM
FORMAT_CODE_GENERAL
FORMAT_CODE_NUMBER
FORMAT_CODE_CURRENCY
FORMAT_CODE_ACCOUNTING
FORMAT_CODE_DATE
FORMAT_CODE_TIME
FORMAT_CODE_PERCENTAGE
FORMAT_CODE_FRACTION
FORMAT_CODE_SCIENTIFIC
FORMAT_CODE_TEXT
FORMAT_CODE_SPECIAL
ORIENTATION_NORMAL
ORIENTATION_REVERSED
LINE_STYLE_COMPOUND_SIMPLE
LINE_STYLE_COMPOUND_DOUBLE
LINE_STYLE_COMPOUND_THICKTHIN
LINE_STYLE_COMPOUND_THINTHICK
LINE_STYLE_COMPOUND_TRIPLE
LINE_STYLE_DASH_SOLID
LINE_STYLE_DASH_ROUND_DOT
LINE_STYLE_DASH_SQUERE_DOT
LINE_STYPE_DASH_DASH
LINE_STYLE_DASH_DASH_DOT
LINE_STYLE_DASH_LONG_DASH
LINE_STYLE_DASH_LONG_DASH_DOT
LINE_STYLE_DASH_LONG_DASH_DOT_DOT
LINE_STYLE_CAP_SQUARE
LINE_STYLE_CAP_ROUND
LINE_STYLE_CAP_FLAT
LINE_STYLE_JOIN_ROUND
LINE_STYLE_JOIN_MITER
LINE_STYLE_JOIN_BEVEL
LINE_STYLE_ARROW_TYPE_NOARROW
LINE_STYLE_ARROW_TYPE_ARROW
LINE_STYLE_ARROW_TYPE_OPEN
LINE_STYLE_ARROW_TYPE_STEALTH
LINE_STYLE_ARROW_TYPE_DIAMOND
LINE_STYLE_ARROW_TYPE_OVAL
LINE_STYLE_ARROW_SIZE_1
LINE_STYLE_ARROW_SIZE_2
LINE_STYLE_ARROW_SIZE_3
LINE_STYLE_ARROW_SIZE_4
LINE_STYLE_ARROW_SIZE_5
LINE_STYLE_ARROW_SIZE_6
LINE_STYLE_ARROW_SIZE_7
LINE_STYLE_ARROW_SIZE_8
LINE_STYLE_ARROW_SIZE_9
SHADOW_PRESETS_NOSHADOW
SHADOW_PRESETS_OUTER_BOTTTOM_RIGHT
SHADOW_PRESETS_OUTER_BOTTOM
SHADOW_PRESETS_OUTER_BOTTOM_LEFT
SHADOW_PRESETS_OUTER_RIGHT
SHADOW_PRESETS_OUTER_CENTER
SHADOW_PRESETS_OUTER_LEFT
SHADOW_PRESETS_OUTER_TOP_RIGHT
SHADOW_PRESETS_OUTER_TOP
SHADOW_PRESETS_OUTER_TOP_LEFT
SHADOW_PRESETS_INNER_BOTTTOM_RIGHT
SHADOW_PRESETS_INNER_BOTTOM
SHADOW_PRESETS_INNER_BOTTOM_LEFT
SHADOW_PRESETS_INNER_RIGHT
SHADOW_PRESETS_INNER_CENTER
SHADOW_PRESETS_INNER_LEFT
SHADOW_PRESETS_INNER_TOP_RIGHT
SHADOW_PRESETS_INNER_TOP
SHADOW_PRESETS_INNER_TOP_LEFT
SHADOW_PRESETS_PERSPECTIVE_BELOW
SHADOW_PRESETS_PERSPECTIVE_UPPER_RIGHT
SHADOW_PRESETS_PERSPECTIVE_UPPER_LEFT
SHADOW_PRESETS_PERSPECTIVE_LOWER_RIGHT
SHADOW_PRESETS_PERSPECTIVE_LOWER_LEFT
getExcelPointsWidth()
getExcelPointsAngle()
getTrueAlpha()
setColorProperties()
getLineStyleArrowSize()
getShadowPresetsMap()
getArrayElementsValue()
No protected properties found
N/A
setShadowPresetsProperties()
setShadowProperiesMapValues()
setShadowColor()
setShadowBlur()
setShadowAngle()
setShadowDistance()
setGlowSize()
setGlowColor()
$axisNumber
$axisOptions
$fillProperties
$lineProperties
$lineStyleProperties
$shadowProperties
$glowProperties
$softEdges
N/A

Constants

EXCEL_COLOR_TYPE_STANDARD

EXCEL_COLOR_TYPE_STANDARD = 'prstClr'

EXCEL_COLOR_TYPE_SCHEME

EXCEL_COLOR_TYPE_SCHEME = 'schemeClr'

EXCEL_COLOR_TYPE_ARGB

EXCEL_COLOR_TYPE_ARGB = 'srgbClr'

AXIS_LABELS_LOW

AXIS_LABELS_LOW = 'low'

AXIS_LABELS_HIGH

AXIS_LABELS_HIGH = 'high'

AXIS_LABELS_NEXT_TO

AXIS_LABELS_NEXT_TO = 'nextTo'

AXIS_LABELS_NONE

AXIS_LABELS_NONE = 'none'

TICK_MARK_NONE

TICK_MARK_NONE = 'none'

TICK_MARK_INSIDE

TICK_MARK_INSIDE = 'in'

TICK_MARK_OUTSIDE

TICK_MARK_OUTSIDE = 'out'

TICK_MARK_CROSS

TICK_MARK_CROSS = 'cross'

HORIZONTAL_CROSSES_AUTOZERO

HORIZONTAL_CROSSES_AUTOZERO = 'autoZero'

HORIZONTAL_CROSSES_MAXIMUM

HORIZONTAL_CROSSES_MAXIMUM = 'max'

FORMAT_CODE_GENERAL

FORMAT_CODE_GENERAL = 'General'

FORMAT_CODE_NUMBER

FORMAT_CODE_NUMBER = '#,##0.00'

FORMAT_CODE_CURRENCY

FORMAT_CODE_CURRENCY = '$#,##0.00'

FORMAT_CODE_ACCOUNTING

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

FORMAT_CODE_DATE

FORMAT_CODE_DATE = 'm/d/yyyy'

FORMAT_CODE_TIME

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

FORMAT_CODE_PERCENTAGE

FORMAT_CODE_PERCENTAGE = '0.00%'

FORMAT_CODE_FRACTION

FORMAT_CODE_FRACTION = '# ?/?'

FORMAT_CODE_SCIENTIFIC

FORMAT_CODE_SCIENTIFIC = '0.00E+00'

FORMAT_CODE_TEXT

FORMAT_CODE_TEXT = '@'

FORMAT_CODE_SPECIAL

FORMAT_CODE_SPECIAL = '00000'

ORIENTATION_NORMAL

ORIENTATION_NORMAL = 'minMax'

ORIENTATION_REVERSED

ORIENTATION_REVERSED = 'maxMin'

LINE_STYLE_COMPOUND_SIMPLE

LINE_STYLE_COMPOUND_SIMPLE = 'sng'

LINE_STYLE_COMPOUND_DOUBLE

LINE_STYLE_COMPOUND_DOUBLE = 'dbl'

LINE_STYLE_COMPOUND_THICKTHIN

LINE_STYLE_COMPOUND_THICKTHIN = 'thickThin'

LINE_STYLE_COMPOUND_THINTHICK

LINE_STYLE_COMPOUND_THINTHICK = 'thinThick'

LINE_STYLE_COMPOUND_TRIPLE

LINE_STYLE_COMPOUND_TRIPLE = 'tri'

LINE_STYLE_DASH_SOLID

LINE_STYLE_DASH_SOLID = 'solid'

LINE_STYLE_DASH_ROUND_DOT

LINE_STYLE_DASH_ROUND_DOT = 'sysDot'

LINE_STYLE_DASH_SQUERE_DOT

LINE_STYLE_DASH_SQUERE_DOT = 'sysDash'

LINE_STYPE_DASH_DASH

LINE_STYPE_DASH_DASH = 'dash'

LINE_STYLE_DASH_DASH_DOT

LINE_STYLE_DASH_DASH_DOT = 'dashDot'

LINE_STYLE_DASH_LONG_DASH

LINE_STYLE_DASH_LONG_DASH = 'lgDash'

LINE_STYLE_DASH_LONG_DASH_DOT

LINE_STYLE_DASH_LONG_DASH_DOT = 'lgDashDot'

LINE_STYLE_DASH_LONG_DASH_DOT_DOT

LINE_STYLE_DASH_LONG_DASH_DOT_DOT = 'lgDashDotDot'

LINE_STYLE_CAP_SQUARE

LINE_STYLE_CAP_SQUARE = 'sq'

LINE_STYLE_CAP_ROUND

LINE_STYLE_CAP_ROUND = 'rnd'

LINE_STYLE_CAP_FLAT

LINE_STYLE_CAP_FLAT = 'flat'

LINE_STYLE_JOIN_ROUND

LINE_STYLE_JOIN_ROUND = 'bevel'

LINE_STYLE_JOIN_MITER

LINE_STYLE_JOIN_MITER = 'miter'

LINE_STYLE_JOIN_BEVEL

LINE_STYLE_JOIN_BEVEL = 'bevel'

LINE_STYLE_ARROW_TYPE_NOARROW

LINE_STYLE_ARROW_TYPE_NOARROW = null

LINE_STYLE_ARROW_TYPE_ARROW

LINE_STYLE_ARROW_TYPE_ARROW = 'triangle'

LINE_STYLE_ARROW_TYPE_OPEN

LINE_STYLE_ARROW_TYPE_OPEN = 'arrow'

LINE_STYLE_ARROW_TYPE_STEALTH

LINE_STYLE_ARROW_TYPE_STEALTH = 'stealth'

LINE_STYLE_ARROW_TYPE_DIAMOND

LINE_STYLE_ARROW_TYPE_DIAMOND = 'diamond'

LINE_STYLE_ARROW_TYPE_OVAL

LINE_STYLE_ARROW_TYPE_OVAL = 'oval'

LINE_STYLE_ARROW_SIZE_1

LINE_STYLE_ARROW_SIZE_1 = 1

LINE_STYLE_ARROW_SIZE_2

LINE_STYLE_ARROW_SIZE_2 = 2

LINE_STYLE_ARROW_SIZE_3

LINE_STYLE_ARROW_SIZE_3 = 3

LINE_STYLE_ARROW_SIZE_4

LINE_STYLE_ARROW_SIZE_4 = 4

LINE_STYLE_ARROW_SIZE_5

LINE_STYLE_ARROW_SIZE_5 = 5

LINE_STYLE_ARROW_SIZE_6

LINE_STYLE_ARROW_SIZE_6 = 6

LINE_STYLE_ARROW_SIZE_7

LINE_STYLE_ARROW_SIZE_7 = 7

LINE_STYLE_ARROW_SIZE_8

LINE_STYLE_ARROW_SIZE_8 = 8

LINE_STYLE_ARROW_SIZE_9

LINE_STYLE_ARROW_SIZE_9 = 9

SHADOW_PRESETS_NOSHADOW

SHADOW_PRESETS_NOSHADOW = null

SHADOW_PRESETS_OUTER_BOTTTOM_RIGHT

SHADOW_PRESETS_OUTER_BOTTTOM_RIGHT = 1

SHADOW_PRESETS_OUTER_BOTTOM

SHADOW_PRESETS_OUTER_BOTTOM = 2

SHADOW_PRESETS_OUTER_BOTTOM_LEFT

SHADOW_PRESETS_OUTER_BOTTOM_LEFT = 3

SHADOW_PRESETS_OUTER_RIGHT

SHADOW_PRESETS_OUTER_RIGHT = 4

SHADOW_PRESETS_OUTER_CENTER

SHADOW_PRESETS_OUTER_CENTER = 5

SHADOW_PRESETS_OUTER_LEFT

SHADOW_PRESETS_OUTER_LEFT = 6

SHADOW_PRESETS_OUTER_TOP_RIGHT

SHADOW_PRESETS_OUTER_TOP_RIGHT = 7

SHADOW_PRESETS_OUTER_TOP

SHADOW_PRESETS_OUTER_TOP = 8

SHADOW_PRESETS_OUTER_TOP_LEFT

SHADOW_PRESETS_OUTER_TOP_LEFT = 9

SHADOW_PRESETS_INNER_BOTTTOM_RIGHT

SHADOW_PRESETS_INNER_BOTTTOM_RIGHT = 10

SHADOW_PRESETS_INNER_BOTTOM

SHADOW_PRESETS_INNER_BOTTOM = 11

SHADOW_PRESETS_INNER_BOTTOM_LEFT

SHADOW_PRESETS_INNER_BOTTOM_LEFT = 12

SHADOW_PRESETS_INNER_RIGHT

SHADOW_PRESETS_INNER_RIGHT = 13

SHADOW_PRESETS_INNER_CENTER

SHADOW_PRESETS_INNER_CENTER = 14

SHADOW_PRESETS_INNER_LEFT

SHADOW_PRESETS_INNER_LEFT = 15

SHADOW_PRESETS_INNER_TOP_RIGHT

SHADOW_PRESETS_INNER_TOP_RIGHT = 16

SHADOW_PRESETS_INNER_TOP

SHADOW_PRESETS_INNER_TOP = 17

SHADOW_PRESETS_INNER_TOP_LEFT

SHADOW_PRESETS_INNER_TOP_LEFT = 18

SHADOW_PRESETS_PERSPECTIVE_BELOW

SHADOW_PRESETS_PERSPECTIVE_BELOW = 19

SHADOW_PRESETS_PERSPECTIVE_UPPER_RIGHT

SHADOW_PRESETS_PERSPECTIVE_UPPER_RIGHT = 20

SHADOW_PRESETS_PERSPECTIVE_UPPER_LEFT

SHADOW_PRESETS_PERSPECTIVE_UPPER_LEFT = 21

SHADOW_PRESETS_PERSPECTIVE_LOWER_RIGHT

SHADOW_PRESETS_PERSPECTIVE_LOWER_RIGHT = 22

SHADOW_PRESETS_PERSPECTIVE_LOWER_LEFT

SHADOW_PRESETS_PERSPECTIVE_LOWER_LEFT = 23

Properties

$axisNumber

$axisNumber : array

Axis Number.

Type

array — of mixed

$axisOptions

$axisOptions : array

Axis Options.

Type

array — of mixed

$fillProperties

$fillProperties : array

Fill Properties.

Type

array — of mixed

$lineProperties

$lineProperties : array

Line Properties.

Type

array — of mixed

$lineStyleProperties

$lineStyleProperties : array

Line Style Properties.

Type

array — of mixed

$shadowProperties

$shadowProperties : array

Shadow Properties.

Type

array — of mixed

$glowProperties

$glowProperties : array

Glow Properties.

Type

array — of mixed

$softEdges

$softEdges : array

Soft Edge Properties.

Type

array — of mixed

Methods

setAxisNumberProperties()

setAxisNumberProperties(mixed  $format_code) : string

Get Series Data Type.

Parameters

mixed $format_code

Returns

string

getAxisNumberFormat()

getAxisNumberFormat() : string

Get Axis Number Format Data Type.

Returns

string

getAxisNumberSourceLinked()

getAxisNumberSourceLinked() : string

Get Axis Number Source Linked.

Returns

string

setAxisOptionsProperties()

setAxisOptionsProperties(string  $axis_labels, string  $horizontal_crosses_value = null, string  $horizontal_crosses = null, string  $axis_orientation = null, string  $major_tmt = null, string  $minor_tmt = null, string  $minimum = null, string  $maximum = null, string  $major_unit = null, string  $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

getAxisOptionsProperty()

getAxisOptionsProperty(string  $property) : string

Get Axis Options Property.

Parameters

string $property

Returns

string

setAxisOrientation()

setAxisOrientation(string  $orientation) 

Set Axis Orientation Property.

Parameters

string $orientation

setFillParameters()

setFillParameters(string  $color, integer  $alpha, string  $type = self::EXCEL_COLOR_TYPE_ARGB) 

Set Fill Property.

Parameters

string $color
integer $alpha
string $type

setLineParameters()

setLineParameters(string  $color, integer  $alpha, string  $type = self::EXCEL_COLOR_TYPE_ARGB) 

Set Line Property.

Parameters

string $color
integer $alpha
string $type

getFillProperty()

getFillProperty(string  $property) : string

Get Fill Property.

Parameters

string $property

Returns

string

getLineProperty()

getLineProperty(string  $property) : string

Get Line Property.

Parameters

string $property

Returns

string

setLineStyleProperties()

setLineStyleProperties(float  $line_width = null, string  $compound_type = null, string  $dash_type = null, string  $cap_type = null, string  $join_type = null, string  $head_arrow_type = null, string  $head_arrow_size = null, string  $end_arrow_type = null, string  $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

getLineStyleProperty()

getLineStyleProperty(array|string  $elements) : string

Get Line Style Property.

Parameters

array|string $elements

Returns

string

getLineStyleArrowWidth()

getLineStyleArrowWidth(string  $arrow) : string

Get Line Style Arrow Excel Width.

Parameters

string $arrow

Returns

string

getLineStyleArrowLength()

getLineStyleArrowLength(string  $arrow) : string

Get Line Style Arrow Excel Length.

Parameters

string $arrow

Returns

string

setShadowProperties()

setShadowProperties(integer  $sh_presets, string  $sh_color_value = null, string  $sh_color_type = null, string  $sh_color_alpha = null, float  $sh_blur = null, integer  $sh_angle = null, float  $sh_distance = null) 

Set Shadow Properties.

Parameters

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

getShadowProperty()

getShadowProperty(string|array<mixed,string>  $elements) : null|array|integer|string

Get Shadow Property.

Parameters

string|array<mixed,string> $elements

Returns

null|array|integer|string

setGlowProperties()

setGlowProperties(float  $size, string  $color_value = null, integer  $color_alpha = null, string  $color_type = null) 

Set Glow Properties.

Parameters

float $size
string $color_value
integer $color_alpha
string $color_type

getGlowProperty()

getGlowProperty(array|string  $property) : string

Get Glow Property.

Parameters

array|string $property

Returns

string

setSoftEdges()

setSoftEdges(float  $size) 

Set Soft Edges Size.

Parameters

float $size

getSoftEdgesSize()

getSoftEdgesSize() : string

Get Soft Edges Size.

Returns

string

getExcelPointsWidth()

getExcelPointsWidth(float  $width) : float

Parameters

float $width

Returns

float

getExcelPointsAngle()

getExcelPointsAngle(float  $angle) : float

Parameters

float $angle

Returns

float

getTrueAlpha()

getTrueAlpha(  $alpha) 

Parameters

$alpha

setColorProperties()

setColorProperties(  $color,   $alpha,   $type) 

Parameters

$color
$alpha
$type

getLineStyleArrowSize()

getLineStyleArrowSize(  $array_selector,   $array_kay_selector) 

Parameters

$array_selector
$array_kay_selector

getShadowPresetsMap()

getShadowPresetsMap(  $shadow_presets_option) 

Parameters

$shadow_presets_option

getArrayElementsValue()

getArrayElementsValue(  $properties,   $elements) 

Parameters

$properties
$elements

setShadowPresetsProperties()

setShadowPresetsProperties(integer  $shadow_presets) : $this

Set Shadow Color.

Parameters

integer $shadow_presets

Returns

$this

setShadowProperiesMapValues()

setShadowProperiesMapValues(array  $properties_map,   $reference = null) : $this

Set Shadow Properties from Mapped Values.

Parameters

array $properties_map
$reference

Returns

$this

setShadowColor()

setShadowColor(string  $color, integer  $alpha, string  $type) : $this

Set Shadow Color.

Parameters

string $color
integer $alpha
string $type

Returns

$this

setShadowBlur()

setShadowBlur(float  $blur) : $this

Set Shadow Blur.

Parameters

float $blur

Returns

$this

setShadowAngle()

setShadowAngle(integer  $angle) : $this

Set Shadow Angle.

Parameters

integer $angle

Returns

$this

setShadowDistance()

setShadowDistance(float  $distance) : $this

Set Shadow Distance.

Parameters

float $distance

Returns

$this

setGlowSize()

setGlowSize(float  $size) : $this

Set Glow Color.

Parameters

float $size

Returns

$this

setGlowColor()

setGlowColor(string  $color, integer  $alpha, string  $type) : $this

Set Glow Color.

Parameters

string $color
integer $alpha
string $type

Returns

$this