Axis.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Component\Chart\Bar;

abstract class Axis
{
    protected string $type = "linear";
    protected bool $displayed = true;
    protected float $step_size = 1.0;
    protected bool $begin_at_zero = true;
    protected ?int $min = null;
    protected ?int $max = null;


    abstract public function getAbbreviation(): string;

    public function getType(): string
    {
        return $this->type;
    }

    public function withDisplayed(bool $displayed): self
    {
        $clone = clone $this;
        $clone->displayed = $displayed;
        return $clone;
    }

    public function isDisplayed(): bool
    {
        return $this->displayed;
    }

    abstract public function withPosition(string $position): self;

    abstract public function getPosition(): string;

    public function withStepSize(float $step_size): self
    {
        $clone = clone $this;
        $clone->step_size = $step_size;
        return $clone;
    }

    public function getStepSize(): float
    {
        return $this->step_size;
    }

    public function withBeginAtZero(bool $begin_at_zero): self
    {
        $clone = clone $this;
        $clone->begin_at_zero = $begin_at_zero;
        return $clone;
    }

    public function isBeginAtZero(): bool
    {
        return $this->begin_at_zero;
    }

    public function withMinValue(int $min): self
    {
        $clone = clone $this;
        $clone->min = $min;
        return $clone;
    }

    public function getMinValue(): ?int
    {
        return $this->min;
    }

    public function withMaxValue(int $max): self
    {
        $clone = clone $this;
        $clone->max = $max;
        return $clone;
    }

    public function getMaxValue(): ?int
    {
        return $this->max;
    }
}