Skip to content

Latest commit

 

History

History
676 lines (419 loc) · 9.95 KB

96-api-class-conditional.md

File metadata and controls

676 lines (419 loc) · 9.95 KB

Class \avadim\FastExcelWriter\Conditional\Conditional

__construct()

public function __construct(string $type, string $operator, $options, $style)

Create a new Conditional

Parameters

  • $type
  • $operator
  • $options
  • $style

aboveAverage()

public static function aboveAverage(array $style): Conditional

Parameters

  • array $style

beginsWith()

public static function beginsWith(string $text, 
                                  ?array $style = null): Conditional

Applies a style if the cell value starts with the specified text

Parameters

  • string $text
  • array|null $style

belowAverage()

public static function belowAverage(array $style): Conditional

Parameters

  • array $style

between()

public static function between(array $values, 
                               ?array $style = null): Conditional

The cell value is between two given values

Parameters

  • int[]|float[] $values
  • array|null $style

colorScale()

public static function colorScale(string $color1, string $color2, 
                                  ?string $color3 = null): Conditional

Parameters

  • string $color1
  • string $color2
  • string|null $color3

colorScaleMax()

public static function colorScaleMax(string $color): Conditional

Parameters

  • string $color

colorScaleMin()

public static function colorScaleMin(string $color): Conditional

Parameters

  • string $color

colorScaleNum()

public static function colorScaleNum(array $values, string $color1, 
                                     string $color2, 
                                     ?string $color3 = null): Conditional

Parameters

  • array $values
  • string $color1
  • string $color2
  • string|null $color3

contains()

public static function contains(string $text, 
                                ?array $style = null): Conditional

Applies a style if the cell value contains the specified text.

Parameters

  • string $text
  • array|null $style

dataBar()

public static function dataBar(string $color): Conditional

Colored data bar inside a cell

Parameters

  • string $color

duplicateValues()

public static function duplicateValues(array $style): Conditional

Parameters

  • array $style

isEmpty()

public static function isEmpty(?string $cell = null, 
                               ?array $style = null): Conditional

Applies a style if the cell is empty

Parameters

  • string|null $cell
  • array|null $style

endsWith()

public static function endsWith(string $text, 
                                ?array $style = null): Conditional

Applies a style if the cell value ends with the specified text

Parameters

  • string $text
  • array|null $style

equals()

public static function equals($value, ?array $style = null): Conditional

The cell value is equal to the given value

Parameters

  • int|float|string $value
  • array|null $style

expression()

public static function expression(string $formula, 
                                  ?array $style = null): Conditional

Applies the style if the expression evaluates to TRUE

Parameters

  • string $formula
  • array|null $style

greaterThan()

public static function greaterThan($value, ?array $style = null): Conditional

The cell value is greater than the specified value

Parameters

  • int|float|string $value
  • array|null $style

greaterThanOrEqual()

public static function greaterThanOrEqual($value, 
                                          ?array $style = null): Conditional

The cell value is greater than or equal to the specified value

Parameters

  • int|float|string $value
  • array|null $style

lessThan()

public static function lessThan($value, ?array $style = null): Conditional

The cell value is less than the specified value

Parameters

  • int|float|string $value
  • array|null $style

lessThanOrEqual()

public static function lessThanOrEqual($value, 
                                       ?array $style = null): Conditional

The cell value is less than or equal to the specified value

Parameters

  • int|float|string $value
  • array|null $style

low()

public static function low(int $rank, array $style): Conditional

Parameters

  • int $rank
  • array $style

lowPercent()

public static function lowPercent(int $rank, array $style): Conditional

Parameters

  • int $rank
  • array $style

make()

public static function make(string $operator, $formula, 
                            ?array $style = null): Conditional

Cell value is compared to a specified value or formula

Parameters

  • string $operator
  • int|float|string|array $formula
  • array|null $style

notBetween()

public static function notBetween(array $values, 
                                  ?array $style = null): Conditional

The cell value is between two given values

Parameters

  • int[]|float[] $values
  • array|null $style

notContains()

public static function notContains(string $text, 
                                   ?array $style = null): Conditional

Applies a style if the cell value does not contain the specified text.

Parameters

  • string $text
  • array|null $style

notEquals()

public static function notEquals($value, ?array $style = null): Conditional

The cell value is not equal to the specified value

Parameters

  • int|float|string $value
  • array|null $style

top()

public static function top(int $rank, array $style): Conditional

Parameters

  • int $rank
  • array $style

topPercent()

public static function topPercent(int $rank, array $style): Conditional

Parameters

  • int $rank
  • array $style

uniqueValues()

public static function uniqueValues(array $style): Conditional

Parameters

  • array $style

setDirectionRtl()

public function setDirectionRtl(bool $value): Conditional

Determines the direction of the bars

Parameters

  • bool $value

setDxfId()

public function setDxfId(int $dxfId): Conditional

Parameters

  • int $dxfId

setFillColor()

public function setFillColor($color): Conditional

Parameters

  • $color

setFontColor()

public function setFontColor($color): Conditional

Parameters

  • $color

setGradient()

public function setGradient(bool $value): Conditional

Enables or disables the gradient style of the bars

Parameters

  • bool $value

setShowValue()

public function setShowValue(bool $value): Conditional

Controls the display of the value in a cell

Parameters

  • bool $value

setSqref()

public function setSqref(avadim\FastExcelWriter\Sheet $sheet, 
                         string $sqref): Conditional

Parameters

  • Sheet $sheet
  • string $sqref

getStyle()

public function getStyle(): ?array

Parameters

None

setStyle()

public function setStyle($style): Conditional

Parameters

  • string|array $style

toXml()

public function toXml(int $priority, $formulaConverter): string

Parameters

  • int $priority
  • $formulaConverter