Documentation

Google_Service_Sheets_ChartSpec extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$altText  : mixed
$fontName  : mixed
$hiddenDimensionStrategy  : mixed
$maximized  : mixed
$subtitle  : mixed
$title  : mixed
$backgroundColorDataType  : mixed
$backgroundColorStyleDataType  : mixed
$backgroundColorStyleType  : mixed
$backgroundColorType  : mixed
$basicChartDataType  : mixed
$basicChartType  : mixed
$bubbleChartDataType  : mixed
$bubbleChartType  : mixed
$candlestickChartDataType  : mixed
$candlestickChartType  : mixed
$collection_key  : mixed
$dataSourceChartPropertiesDataType  : mixed
$dataSourceChartPropertiesType  : mixed
$filterSpecsDataType  : mixed
$filterSpecsType  : mixed
$histogramChartDataType  : mixed
$histogramChartType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$orgChartDataType  : mixed
$orgChartType  : mixed
$pieChartDataType  : mixed
$pieChartType  : mixed
$processed  : mixed
$scorecardChartDataType  : mixed
$scorecardChartType  : mixed
$sortSpecsDataType  : mixed
$sortSpecsType  : mixed
$subtitleTextFormatDataType  : mixed
$subtitleTextFormatType  : mixed
$subtitleTextPositionDataType  : mixed
$subtitleTextPositionType  : mixed
$titleTextFormatDataType  : mixed
$titleTextFormatType  : mixed
$titleTextPositionDataType  : mixed
$titleTextPositionType  : mixed
$treemapChartDataType  : mixed
$treemapChartType  : mixed
$waterfallChartDataType  : mixed
$waterfallChartType  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getAltText()  : mixed
getBackgroundColor()  : Google_Service_Sheets_Color
getBackgroundColorStyle()  : Google_Service_Sheets_ColorStyle
getBasicChart()  : Google_Service_Sheets_BasicChartSpec
getBubbleChart()  : Google_Service_Sheets_BubbleChartSpec
getCandlestickChart()  : Google_Service_Sheets_CandlestickChartSpec
getDataSourceChartProperties()  : Google_Service_Sheets_DataSourceChartProperties
getFilterSpecs()  : Google_Service_Sheets_FilterSpec
getFontName()  : mixed
getHiddenDimensionStrategy()  : mixed
getHistogramChart()  : Google_Service_Sheets_HistogramChartSpec
getMaximized()  : mixed
getOrgChart()  : Google_Service_Sheets_OrgChartSpec
getPieChart()  : Google_Service_Sheets_PieChartSpec
getScorecardChart()  : Google_Service_Sheets_ScorecardChartSpec
getSortSpecs()  : Google_Service_Sheets_SortSpec
getSubtitle()  : mixed
getSubtitleTextFormat()  : Google_Service_Sheets_TextFormat
getSubtitleTextPosition()  : Google_Service_Sheets_TextPosition
getTitle()  : mixed
getTitleTextFormat()  : Google_Service_Sheets_TextFormat
getTitleTextPosition()  : Google_Service_Sheets_TextPosition
getTreemapChart()  : Google_Service_Sheets_TreemapChartSpec
getWaterfallChart()  : Google_Service_Sheets_WaterfallChartSpec
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAltText()  : mixed
setBackgroundColor()  : mixed
setBackgroundColorStyle()  : mixed
setBasicChart()  : mixed
setBubbleChart()  : mixed
setCandlestickChart()  : mixed
setDataSourceChartProperties()  : mixed
setFilterSpecs()  : mixed
setFontName()  : mixed
setHiddenDimensionStrategy()  : mixed
setHistogramChart()  : mixed
setMaximized()  : mixed
setOrgChart()  : mixed
setPieChart()  : mixed
setScorecardChart()  : mixed
setSortSpecs()  : mixed
setSubtitle()  : mixed
setSubtitleTextFormat()  : mixed
setSubtitleTextPosition()  : mixed
setTitle()  : mixed
setTitleTextFormat()  : mixed
setTitleTextPosition()  : mixed
setTreemapChart()  : mixed
setWaterfallChart()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$hiddenDimensionStrategy

public mixed $hiddenDimensionStrategy

$backgroundColorDataType

protected mixed $backgroundColorDataType = ''

$backgroundColorStyleDataType

protected mixed $backgroundColorStyleDataType = ''

$backgroundColorStyleType

protected mixed $backgroundColorStyleType = 'Google_Service_Sheets_ColorStyle'

$backgroundColorType

protected mixed $backgroundColorType = 'Google_Service_Sheets_Color'

$basicChartDataType

protected mixed $basicChartDataType = ''

$basicChartType

protected mixed $basicChartType = 'Google_Service_Sheets_BasicChartSpec'

$bubbleChartDataType

protected mixed $bubbleChartDataType = ''

$bubbleChartType

protected mixed $bubbleChartType = 'Google_Service_Sheets_BubbleChartSpec'

$candlestickChartDataType

protected mixed $candlestickChartDataType = ''

$candlestickChartType

protected mixed $candlestickChartType = 'Google_Service_Sheets_CandlestickChartSpec'

$collection_key

protected mixed $collection_key = 'sortSpecs'

$dataSourceChartPropertiesDataType

protected mixed $dataSourceChartPropertiesDataType = ''

$dataSourceChartPropertiesType

protected mixed $dataSourceChartPropertiesType = 'Google_Service_Sheets_DataSourceChartProperties'

$filterSpecsDataType

protected mixed $filterSpecsDataType = 'array'

$filterSpecsType

protected mixed $filterSpecsType = 'Google_Service_Sheets_FilterSpec'

$histogramChartDataType

protected mixed $histogramChartDataType = ''

$histogramChartType

protected mixed $histogramChartType = 'Google_Service_Sheets_HistogramChartSpec'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$orgChartDataType

protected mixed $orgChartDataType = ''

$orgChartType

protected mixed $orgChartType = 'Google_Service_Sheets_OrgChartSpec'

$pieChartDataType

protected mixed $pieChartDataType = ''

$pieChartType

protected mixed $pieChartType = 'Google_Service_Sheets_PieChartSpec'

$processed

protected mixed $processed = array()

$scorecardChartDataType

protected mixed $scorecardChartDataType = ''

$scorecardChartType

protected mixed $scorecardChartType = 'Google_Service_Sheets_ScorecardChartSpec'

$sortSpecsDataType

protected mixed $sortSpecsDataType = 'array'

$sortSpecsType

protected mixed $sortSpecsType = 'Google_Service_Sheets_SortSpec'

$subtitleTextFormatDataType

protected mixed $subtitleTextFormatDataType = ''

$subtitleTextFormatType

protected mixed $subtitleTextFormatType = 'Google_Service_Sheets_TextFormat'

$subtitleTextPositionDataType

protected mixed $subtitleTextPositionDataType = ''

$subtitleTextPositionType

protected mixed $subtitleTextPositionType = 'Google_Service_Sheets_TextPosition'

$titleTextFormatDataType

protected mixed $titleTextFormatDataType = ''

$titleTextFormatType

protected mixed $titleTextFormatType = 'Google_Service_Sheets_TextFormat'

$titleTextPositionDataType

protected mixed $titleTextPositionDataType = ''

$titleTextPositionType

protected mixed $titleTextPositionType = 'Google_Service_Sheets_TextPosition'

$treemapChartDataType

protected mixed $treemapChartDataType = ''

$treemapChartType

protected mixed $treemapChartType = 'Google_Service_Sheets_TreemapChartSpec'

$waterfallChartDataType

protected mixed $waterfallChartDataType = ''

$waterfallChartType

protected mixed $waterfallChartType = 'Google_Service_Sheets_WaterfallChartSpec'

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed —

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getAltText()

public getAltText() : mixed
Return values
mixed —

getFontName()

public getFontName() : mixed
Return values
mixed —

getHiddenDimensionStrategy()

public getHiddenDimensionStrategy() : mixed
Return values
mixed —

getMaximized()

public getMaximized() : mixed
Return values
mixed —

getSubtitle()

public getSubtitle() : mixed
Return values
mixed —

getTitle()

public getTitle() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

rewind()

public rewind() : mixed
Return values
mixed —

setAltText()

public setAltText(mixed $altText) : mixed
Parameters
$altText : mixed
Return values
mixed —

setFilterSpecs()

public setFilterSpecs(mixed $filterSpecs) : mixed
Parameters
$filterSpecs : mixed
Return values
mixed —

setFontName()

public setFontName(mixed $fontName) : mixed
Parameters
$fontName : mixed
Return values
mixed —

setHiddenDimensionStrategy()

public setHiddenDimensionStrategy(mixed $hiddenDimensionStrategy) : mixed
Parameters
$hiddenDimensionStrategy : mixed
Return values
mixed —

setMaximized()

public setMaximized(mixed $maximized) : mixed
Parameters
$maximized : mixed
Return values
mixed —

setSortSpecs()

public setSortSpecs(mixed $sortSpecs) : mixed
Parameters
$sortSpecs : mixed
Return values
mixed —

setSubtitle()

public setSubtitle(mixed $subtitle) : mixed
Parameters
$subtitle : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : mixed
Return values
mixed —

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed —

valid()

public valid() : mixed
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed —

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void —

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results