Documentation

SparklineGroup
in package

A group of sparklines that share formatting (type, colours, markers, axis).

In OOXML this is the x14:sparklineGroup element. A group contains one or more Sparkline objects (x14:sparkline), each pairing a data range with the cell it is drawn in.

Table of Contents

Constants

AXIS_CUSTOM  = 'custom'
AXIS_GROUP  = 'group'
AXIS_INDIVIDUAL  = 'individual'
EMPTY_AS_GAP  = 'gap'
EMPTY_AS_SPAN  = 'span'
EMPTY_AS_ZERO  = 'zero'

Methods

addSparkline()  : self
createSparkline()  : self
Convenience helper: create and add a sparkline from a location cell and data range, returning this group for chaining.
getColorAxis()  : string|null
getColorFirst()  : string|null
getColorHigh()  : string|null
getColorLast()  : string|null
getColorLow()  : string|null
getColorMarkers()  : string|null
getColorNegative()  : string|null
getColorSeries()  : string|null
getDisplayEmptyCellsAs()  : string
getDisplayFirst()  : bool
getDisplayHidden()  : bool
getDisplayHigh()  : bool
getDisplayLast()  : bool
getDisplayLow()  : bool
getDisplayMarkers()  : bool
getDisplayNegative()  : bool
getDisplayXAxis()  : bool
getLineWeight()  : float
getManualMax()  : float|null
getManualMin()  : float|null
getMaxAxisType()  : string
getMinAxisType()  : string
getRightToLeft()  : bool
getSparklines()  : array<string|int, Sparkline>
getType()  : SparklineType
setColorAxis()  : self
setColorFirst()  : self
setColorHigh()  : self
setColorLast()  : self
setColorLow()  : self
setColorMarkers()  : self
setColorNegative()  : self
setColorSeries()  : self
setDisplayEmptyCellsAs()  : self
setDisplayFirst()  : self
setDisplayHidden()  : self
setDisplayHigh()  : self
setDisplayLast()  : self
setDisplayLow()  : self
setDisplayMarkers()  : self
setDisplayNegative()  : self
setDisplayXAxis()  : self
setLineWeight()  : self
setManualMax()  : self
setManualMin()  : self
setMaxAxisType()  : self
setMinAxisType()  : self
setRightToLeft()  : self
setSparklines()  : self
setType()  : self

Constants

Methods

createSparkline()

Convenience helper: create and add a sparkline from a location cell and data range, returning this group for chaining.

public createSparkline(CellAddress|string $location, string $dataRange) : self
Parameters
$location : CellAddress|string
$dataRange : string
Return values
self

getColorAxis()

public getColorAxis() : string|null
Return values
string|null

getColorFirst()

public getColorFirst() : string|null
Return values
string|null

getColorHigh()

public getColorHigh() : string|null
Return values
string|null

getColorLast()

public getColorLast() : string|null
Return values
string|null

getColorLow()

public getColorLow() : string|null
Return values
string|null

getColorMarkers()

public getColorMarkers() : string|null
Return values
string|null

getColorNegative()

public getColorNegative() : string|null
Return values
string|null

getColorSeries()

public getColorSeries() : string|null
Return values
string|null

getDisplayEmptyCellsAs()

public getDisplayEmptyCellsAs() : string
Return values
string

getDisplayFirst()

public getDisplayFirst() : bool
Return values
bool

getDisplayHidden()

public getDisplayHidden() : bool
Return values
bool

getDisplayHigh()

public getDisplayHigh() : bool
Return values
bool

getDisplayLast()

public getDisplayLast() : bool
Return values
bool

getDisplayLow()

public getDisplayLow() : bool
Return values
bool

getDisplayMarkers()

public getDisplayMarkers() : bool
Return values
bool

getDisplayNegative()

public getDisplayNegative() : bool
Return values
bool

getDisplayXAxis()

public getDisplayXAxis() : bool
Return values
bool

getLineWeight()

public getLineWeight() : float
Return values
float

getManualMax()

public getManualMax() : float|null
Return values
float|null

getManualMin()

public getManualMin() : float|null
Return values
float|null

getMaxAxisType()

public getMaxAxisType() : string
Return values
string

getMinAxisType()

public getMinAxisType() : string
Return values
string

getRightToLeft()

public getRightToLeft() : bool
Return values
bool

setColorAxis()

public setColorAxis(string|null $colorAxis) : self
Parameters
$colorAxis : string|null
Return values
self

setColorFirst()

public setColorFirst(string|null $colorFirst) : self
Parameters
$colorFirst : string|null
Return values
self

setColorHigh()

public setColorHigh(string|null $colorHigh) : self
Parameters
$colorHigh : string|null
Return values
self

setColorLast()

public setColorLast(string|null $colorLast) : self
Parameters
$colorLast : string|null
Return values
self

setColorLow()

public setColorLow(string|null $colorLow) : self
Parameters
$colorLow : string|null
Return values
self

setColorMarkers()

public setColorMarkers(string|null $colorMarkers) : self
Parameters
$colorMarkers : string|null
Return values
self

setColorNegative()

public setColorNegative(string|null $colorNegative) : self
Parameters
$colorNegative : string|null
Return values
self

setColorSeries()

public setColorSeries(string|null $colorSeries) : self
Parameters
$colorSeries : string|null
Return values
self

setDisplayEmptyCellsAs()

public setDisplayEmptyCellsAs(string $displayEmptyCellsAs) : self
Parameters
$displayEmptyCellsAs : string
Return values
self

setDisplayFirst()

public setDisplayFirst(bool $displayFirst) : self
Parameters
$displayFirst : bool
Return values
self

setDisplayHidden()

public setDisplayHidden(bool $displayHidden) : self
Parameters
$displayHidden : bool
Return values
self

setDisplayHigh()

public setDisplayHigh(bool $displayHigh) : self
Parameters
$displayHigh : bool
Return values
self

setDisplayLast()

public setDisplayLast(bool $displayLast) : self
Parameters
$displayLast : bool
Return values
self

setDisplayLow()

public setDisplayLow(bool $displayLow) : self
Parameters
$displayLow : bool
Return values
self

setDisplayMarkers()

public setDisplayMarkers(bool $displayMarkers) : self
Parameters
$displayMarkers : bool
Return values
self

setDisplayNegative()

public setDisplayNegative(bool $displayNegative) : self
Parameters
$displayNegative : bool
Return values
self

setDisplayXAxis()

public setDisplayXAxis(bool $displayXAxis) : self
Parameters
$displayXAxis : bool
Return values
self

setLineWeight()

public setLineWeight(float $lineWeight) : self
Parameters
$lineWeight : float
Return values
self

setManualMax()

public setManualMax(float|null $manualMax) : self
Parameters
$manualMax : float|null
Return values
self

setManualMin()

public setManualMin(float|null $manualMin) : self
Parameters
$manualMin : float|null
Return values
self

setMaxAxisType()

public setMaxAxisType(string $maxAxisType) : self
Parameters
$maxAxisType : string
Return values
self

setMinAxisType()

public setMinAxisType(string $minAxisType) : self
Parameters
$minAxisType : string
Return values
self

setRightToLeft()

public setRightToLeft(bool $rightToLeft) : self
Parameters
$rightToLeft : bool
Return values
self

setSparklines()

public setSparklines(array<string|int, Sparkline> $sparklines) : self
Parameters
$sparklines : array<string|int, Sparkline>
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results