LimeSurvey API - Master branch
Back to top  

pChart

package

Default

Methods

__construct

__construct( $XSize, $YSize)

Arguments

$XSize

$YSize

addBorder

addBorder( $Size = 3, $R, $G, $B)

Arguments

$Size

$R

$G

$B

addToImageMap

addToImageMap( $X1, $Y1, $X2, $Y2, $SerieName, $Value, $CallerFunction)

Arguments

$X1

$Y1

$X2

$Y2

$SerieName

$Value

$CallerFunction

AllocateColor

AllocateColor( $Picture, $R, $G, $B, $Factor)

Arguments

$Picture

$R

$G

$B

$Factor

clearScale

clearScale()

clearShadow

clearShadow()

createColorGradientPalette

createColorGradientPalette( $R1, $G1, $B1, $R2, $G2, $B2, $Shades)

Arguments

$R1

$G1

$B1

$R2

$G2

$B2

$Shades

drawAlphaPixel

drawAlphaPixel( $X, $Y, $Alpha, $R, $G, $B)

Arguments

$X

$Y

$Alpha

$R

$G

$B

drawAntialiasPixel

drawAntialiasPixel( $X, $Y, $R, $G, $B, $Alpha = 100, $NoFallBack = FALSE)

Arguments

$X

$Y

$R

$G

$B

$Alpha

$NoFallBack

drawArea

drawArea( $Data, $Serie1, $Serie2, $R, $G, $B, $Alpha = 50)

Arguments

$Data

$Serie1

$Serie2

$R

$G

$B

$Alpha

drawBackground

drawBackground( $R, $G, $B)

Arguments

$R

$G

$B

drawBarGraph

drawBarGraph( $Data, $DataDescription, $Shadow = FALSE, $Alpha = 100)

Arguments

$Data

$DataDescription

$Shadow

$Alpha

drawBasicPieGraph

drawBasicPieGraph( $Data, $DataDescription, $XPos, $YPos, $Radius = 100, $DrawLabels = PIE_NOLABEL, $R = 255, $G = 255, $B = 255, $Decimals)

Arguments

$Data

$DataDescription

$XPos

$YPos

$Radius

$DrawLabels

$R

$G

$B

$Decimals

drawCircle

drawCircle( $Xc, $Yc, $Height, $R, $G, $B, $Width)

Arguments

$Xc

$Yc

$Height

$R

$G

$B

$Width

drawCubicCurve

drawCubicCurve( $Data, $DataDescription, $Accuracy = 0.1, $SerieName = "")

Arguments

$Data

$DataDescription

$Accuracy

$SerieName

drawDottedLine

drawDottedLine( $X1, $Y1, $X2, $Y2, $DotSize, $R, $G, $B, $GraphFunction = FALSE)

Arguments

$X1

$Y1

$X2

$Y2

$DotSize

$R

$G

$B

$GraphFunction

drawEllipse

drawEllipse( $Xc, $Yc, $Height, $Width, $R, $G, $B)

Arguments

$Xc

$Yc

$Height

$Width

$R

$G

$B

drawFilledCircle

drawFilledCircle( $Xc, $Yc, $Height, $R, $G, $B, $Width)

Arguments

$Xc

$Yc

$Height

$R

$G

$B

$Width

drawFilledCubicCurve

drawFilledCubicCurve( $Data, $DataDescription, $Accuracy = 0.1, $Alpha = 100, $AroundZero = FALSE)

Arguments

$Data

$DataDescription

$Accuracy

$Alpha

$AroundZero

drawFilledEllipse

drawFilledEllipse( $Xc, $Yc, $Height, $Width, $R, $G, $B)

Arguments

$Xc

$Yc

$Height

$Width

$R

$G

$B

drawFilledLineGraph

drawFilledLineGraph( $Data, $DataDescription, $Alpha = 100, $AroundZero = FALSE)

Arguments

$Data

$DataDescription

$Alpha

$AroundZero

drawFilledRadar

drawFilledRadar( $Data, $DataDescription, $Alpha = 50, $BorderOffset = 10, $MaxValue = -1)

Arguments

$Data

$DataDescription

$Alpha

$BorderOffset

$MaxValue

drawFilledRectangle

drawFilledRectangle( $X1, $Y1, $X2, $Y2, $R, $G, $B, $DrawBorder = TRUE, $Alpha = 100, $NoFallBack = FALSE)

Arguments

$X1

$Y1

$X2

$Y2

$R

$G

$B

$DrawBorder

$Alpha

$NoFallBack

drawFilledRoundedRectangle

drawFilledRoundedRectangle( $X1, $Y1, $X2, $Y2, $Radius, $R, $G, $B)

Arguments

$X1

$Y1

$X2

$Y2

$Radius

$R

$G

$B

drawFlatPieGraph

drawFlatPieGraph( $Data, $DataDescription, $XPos, $YPos, $Radius = 100, $DrawLabels = PIE_NOLABEL, $SpliceDistance, $Decimals, $AllBlack = FALSE)

Arguments

$Data

$DataDescription

$XPos

$YPos

$Radius

$DrawLabels

$SpliceDistance

$Decimals

$AllBlack

drawFlatPieGraphWithShadow

drawFlatPieGraphWithShadow( $Data, $DataDescription, $XPos, $YPos, $Radius = 100, $DrawLabels = PIE_NOLABEL, $SpliceDistance, $Decimals)

Arguments

$Data

$DataDescription

$XPos

$YPos

$Radius

$DrawLabels

$SpliceDistance

$Decimals

drawFromGIF

drawFromGIF( $FileName, $X, $Y, $Alpha = 100)

Arguments

$FileName

$X

$Y

$Alpha

drawFromJPG

drawFromJPG( $FileName, $X, $Y, $Alpha = 100)

Arguments

$FileName

$X

$Y

$Alpha

drawFromPicture

drawFromPicture( $PicType, $FileName, $X, $Y, $Alpha = 100)

Arguments

$PicType

$FileName

$X

$Y

$Alpha

drawFromPNG

drawFromPNG( $FileName, $X, $Y, $Alpha = 100)

Arguments

$FileName

$X

$Y

$Alpha

drawGraphArea

drawGraphArea( $R, $G, $B, $Stripe = FALSE)

Arguments

$R

$G

$B

$Stripe

drawGraphAreaGradient

drawGraphAreaGradient( $R, $G, $B, $Decay, $Target = TARGET_GRAPHAREA)

Arguments

$R

$G

$B

$Decay

$Target

drawGrid

drawGrid( $LineWidth, $Mosaic = TRUE, $R = 220, $G = 220, $B = 220, $Alpha = 100)

Arguments

$LineWidth

$Mosaic

$R

$G

$B

$Alpha

drawLegend

drawLegend( $XPos, $YPos, $DataDescription, $R, $G, $B, $Rs = -1, $Gs = -1, $Bs = -1, $Rt, $Gt, $Bt, $Border = TRUE)

Arguments

$XPos

$YPos

$DataDescription

$R

$G

$B

$Rs

$Gs

$Bs

$Rt

$Gt

$Bt

$Border

drawLimitsGraph

drawLimitsGraph( $Data, $DataDescription, $R, $G, $B)

Arguments

$Data

$DataDescription

$R

$G

$B

drawLine

drawLine( $X1, $Y1, $X2, $Y2, $R, $G, $B, $GraphFunction = FALSE)

Arguments

$X1

$Y1

$X2

$Y2

$R

$G

$B

$GraphFunction

drawLineGraph

drawLineGraph( $Data, $DataDescription, $SerieName = "")

Arguments

$Data

$DataDescription

$SerieName

drawOverlayBarGraph

drawOverlayBarGraph( $Data, $DataDescription, $Alpha = 50)

Arguments

$Data

$DataDescription

$Alpha

drawPieGraph

drawPieGraph( $Data, $DataDescription, $XPos, $YPos, $Radius = 100, $DrawLabels = PIE_NOLABEL, $EnhanceColors = TRUE, $Skew = 60, $SpliceHeight = 20, $SpliceDistance, $Decimals)

Arguments

$Data

$DataDescription

$XPos

$YPos

$Radius

$DrawLabels

$EnhanceColors

$Skew

$SpliceHeight

$SpliceDistance

$Decimals

drawPieLegend

drawPieLegend( $XPos, $YPos, $Data, $DataDescription, $R, $G, $B)

Arguments

$XPos

$YPos

$Data

$DataDescription

$R

$G

$B

drawPlotGraph

drawPlotGraph( $Data, $DataDescription, $BigRadius = 5, $SmallRadius = 2, $R2 = -1, $G2 = -1, $B2 = -1, $Shadow = FALSE)

Arguments

$Data

$DataDescription

$BigRadius

$SmallRadius

$R2

$G2

$B2

$Shadow

drawRadar

drawRadar( $Data, $DataDescription, $BorderOffset = 10, $MaxValue = -1)

Arguments

$Data

$DataDescription

$BorderOffset

$MaxValue

drawRadarAxis

drawRadarAxis( $Data, $DataDescription, $Mosaic = TRUE, $BorderOffset = 10, $A_R = 60, $A_G = 60, $A_B = 60, $S_R = 200, $S_G = 200, $S_B = 200, $MaxValue = -1)

Arguments

$Data

$DataDescription

$Mosaic

$BorderOffset

$A_R

$A_G

$A_B

$S_R

$S_G

$S_B

$MaxValue

drawRectangle

drawRectangle( $X1, $Y1, $X2, $Y2, $R, $G, $B)

Arguments

$X1

$Y1

$X2

$Y2

$R

$G

$B

drawRightScale

drawRightScale( $Data, $DataDescription, $ScaleMode, $R, $G, $B, $DrawTicks = TRUE, $Angle, $Decimals = 1, $WithMargin = FALSE, $SkipLabels = 1)

Arguments

$Data

$DataDescription

$ScaleMode

$R

$G

$B

$DrawTicks

$Angle

$Decimals

$WithMargin

$SkipLabels

drawRoundedRectangle

drawRoundedRectangle( $X1, $Y1, $X2, $Y2, $Radius, $R, $G, $B)

Arguments

$X1

$Y1

$X2

$Y2

$Radius

$R

$G

$B

drawScale

drawScale( $Data, $DataDescription, $ScaleMode, $R, $G, $B, $DrawTicks = TRUE, $Angle, $Decimals = 1, $WithMargin = FALSE, $SkipLabels = 1, $RightScale = FALSE)

Arguments

$Data

$DataDescription

$ScaleMode

$R

$G

$B

$DrawTicks

$Angle

$Decimals

$WithMargin

$SkipLabels

$RightScale

drawStackedBarGraph

drawStackedBarGraph( $Data, $DataDescription, $Alpha = 50, $Contiguous = FALSE)

Arguments

$Data

$DataDescription

$Alpha

$Contiguous

drawTextBox

drawTextBox( $X1, $Y1, $X2, $Y2, $Text, $Angle, $R = 255, $G = 255, $B = 255, $Align = ALIGN_LEFT, $Shadow = TRUE, $BgR = -1, $BgG = -1, $BgB = -1, $Alpha = 100)

Arguments

$X1

$Y1

$X2

$Y2

$Text

$Angle

$R

$G

$B

$Align

$Shadow

$BgR

$BgG

$BgB

$Alpha

drawTitle

drawTitle( $XPos, $YPos, $Value, $R, $G, $B, $XPos2 = -1, $YPos2 = -1, $Shadow = FALSE)

Arguments

$XPos

$YPos

$Value

$R

$G

$B

$XPos2

$YPos2

$Shadow

drawTreshold

drawTreshold( $Value, $R, $G, $B, $ShowLabel = FALSE, $ShowOnRight = FALSE, $TickWidth = 4, $FreeText = NULL)

Arguments

$Value

$R

$G

$B

$ShowLabel

$ShowOnRight

$TickWidth

$FreeText

drawXYGraph

drawXYGraph( $Data, $DataDescription, $YSerieName, $XSerieName, $PaletteID)

Arguments

$Data

$DataDescription

$YSerieName

$XSerieName

$PaletteID

drawXYPlotGraph

drawXYPlotGraph( $Data, $DataDescription, $YSerieName, $XSerieName, $PaletteID, $BigRadius = 5, $SmallRadius = 2, $R2 = -1, $G2 = -1, $B2 = -1, $Shadow = TRUE)

Arguments

$Data

$DataDescription

$YSerieName

$XSerieName

$PaletteID

$BigRadius

$SmallRadius

$R2

$G2

$B2

$Shadow

drawXYScale

drawXYScale( $Data, $DataDescription, $YSerieName, $XSerieName, $R, $G, $B, $WithMargin, $Angle, $Decimals = 1)

Arguments

$Data

$DataDescription

$YSerieName

$XSerieName

$R

$G

$B

$WithMargin

$Angle

$Decimals

getImageMap

getImageMap( $MapName, $Flush = TRUE)

Arguments

$MapName

$Flush

getLegendBoxSize

getLegendBoxSize( $DataDescription)

Arguments

$DataDescription

isRealInt

isRealInt( $Value)

Arguments

$Value

loadColorPalette

loadColorPalette( $FileName, $Delimiter = ",")

Arguments

$FileName

$Delimiter

printErrors

printErrors( $Mode = "CLI")

Arguments

$Mode

Render

Render( $FileName)

Arguments

$FileName

reportWarnings

reportWarnings( $Interface = "CLI")

Arguments

$Interface

SaveImageMap

SaveImageMap()

setColorPalette

setColorPalette( $ID, $R, $G, $B)

Arguments

$ID

$R

$G

$B

setCurrency

setCurrency( $Currency)

Arguments

$Currency

setDateFormat

setDateFormat( $Format)

Arguments

$Format

setFixedScale

setFixedScale( $VMin, $VMax, $Divisions = 5, $VXMin, $VXMax, $XDivisions = 5)

Arguments

$VMin

$VMax

$Divisions

$VXMin

$VXMax

$XDivisions

setFontProperties

setFontProperties( $FontName, $FontSize)

Arguments

$FontName

$FontSize

setGraphArea

setGraphArea( $X1, $Y1, $X2, $Y2)

Arguments

$X1

$Y1

$X2

$Y2

setImageMap

setImageMap( $Mode = TRUE, $GraphID = "MyGraph")

Arguments

$Mode

$GraphID

setLabel

setLabel( $Data, $DataDescription, $SerieName, $ValueName, $Caption, $R = 210, $G = 210, $B = 210)

Arguments

$Data

$DataDescription

$SerieName

$ValueName

$Caption

$R

$G

$B

setLineStyle

setLineStyle( $Width = 1, $DotSize)

Arguments

$Width

$DotSize

setShadowProperties

setShadowProperties( $XDistance = 1, $YDistance = 1, $R = 60, $G = 60, $B = 60, $Alpha = 50, $Blur)

Arguments

$XDistance

$YDistance

$R

$G

$B

$Alpha

$Blur

Stroke

Stroke()

ToCurrency

ToCurrency( $Value)

Arguments

$Value

ToDate

ToDate( $Value)

Arguments

$Value

ToMetric

ToMetric( $Value)

Arguments

$Value

ToTime

ToTime( $Value)

Arguments

$Value

validateData

validateData( $FunctionName, &$Data)

Arguments

$FunctionName

$Data

validateDataDescription

validateDataDescription( $FunctionName, &$DataDescription, $DescriptionRequired = TRUE)

Arguments

$FunctionName

$DataDescription

$DescriptionRequired

writeValues

writeValues( $Data, $DataDescription, $Series)

Arguments

$Data

$DataDescription

$Series

Properties

Palette

Palette :

Type(s)

XSize

XSize :

Type(s)

YSize

YSize :

Type(s)

Picture

Picture :

Type(s)

ImageMap

ImageMap :

Type(s)

ErrorReporting

ErrorReporting :

Type(s)

ErrorInterface

ErrorInterface :

Type(s)

Errors

Errors :

Type(s)

ErrorFontName

ErrorFontName :

Type(s)

ErrorFontSize

ErrorFontSize :

Type(s)

GArea_X1

GArea_X1 :

Type(s)

GArea_Y1

GArea_Y1 :

Type(s)

GArea_X2

GArea_X2 :

Type(s)

GArea_Y2

GArea_Y2 :

Type(s)

GAreaXOffset

GAreaXOffset :

Type(s)

VMax

VMax :

Type(s)

VMin

VMin :

Type(s)

VXMax

VXMax :

Type(s)

VXMin

VXMin :

Type(s)

Divisions

Divisions :

Type(s)

XDivisions

XDivisions :

Type(s)

DivisionHeight

DivisionHeight :

Type(s)

XDivisionHeight

XDivisionHeight :

Type(s)

DivisionCount

DivisionCount :

Type(s)

XDivisionCount

XDivisionCount :

Type(s)

DivisionRatio

DivisionRatio :

Type(s)

XDivisionRatio

XDivisionRatio :

Type(s)

DivisionWidth

DivisionWidth :

Type(s)

DataCount

DataCount :

Type(s)

Currency

Currency :

Type(s)

FontName

FontName :

Type(s)

FontSize

FontSize :

Type(s)

DateFormat

DateFormat :

Type(s)

LineWidth

LineWidth :

Type(s)

LineDotSize

LineDotSize :

Type(s)

Layers

Layers :

Type(s)

AntialiasQuality

AntialiasQuality :

Type(s)

ShadowActive

ShadowActive :

Type(s)

ShadowXDistance

ShadowXDistance :

Type(s)

ShadowYDistance

ShadowYDistance :

Type(s)

ShadowRColor

ShadowRColor :

Type(s)

ShadowGColor

ShadowGColor :

Type(s)

ShadowBColor

ShadowBColor :

Type(s)

ShadowAlpha

ShadowAlpha :

Type(s)

ShadowBlur

ShadowBlur :

Type(s)

BuildMap

BuildMap :

Type(s)

MapFunction

MapFunction :

Type(s)

tmpFolder

tmpFolder :

Type(s)

MapID

MapID :

Type(s)