12.19. The OpenCReport\Image class #

12.19.1. Set or get the file name of the image
12.19.2. Set or get the suppression flag for the image
12.19.3. Set or get the image type
12.19.4. Set or get the image width
12.19.5. Set or get the image height
12.19.6. Set or get the image alignment
12.19.7. Set or get the image background color
12.19.8. Set or get the image "text width"

class OpenCReport\Image {
    public final set_value(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_value():
                     ?OpenCReport\Expr;

    public final set_suppress(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_suppress():
                     ?OpenCReport\Expr;

    public final set_type(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_type():
                     ?OpenCReport\Expr;

    public final set_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_width():
                     ?OpenCReport\Expr;

    public final set_height(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_height():
                     ?OpenCReport\Expr;

    public final set_alignment(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_alignment():
                     ?OpenCReport\Expr;

    public final set_bgcolor(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_bgcolor():
                     ?OpenCReport\Expr;

    public final set_text_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_text_width():
                     ?OpenCReport\Expr;
}

12.19.1. Set or get the file name of the image #

Set the file name of the image. The file name may be and absolute path, relative to the work directory of the application, or relative to any of the paths added with OpenCReport::add_search_path(). (See Section 12.4.10.1.)

public final
OpenCReport\Image::set_value(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_value():
                     ?OpenCReport\Expr;

12.19.2. Set or get the suppression flag for the image #

Set the suppression flag for the image. The expression must evaluate to a numeric value that is treated as a boolean, i.e. 0 or non-0. Default is false.

public final
OpenCReport\Image::set_suppress(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_suppress():
                     ?OpenCReport\Expr;

12.19.3. Set or get the image type #

Set the image file type. Usually it's auto-detected and not needed.

public final
OpenCReport\Image::set_type(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_type():
                     ?OpenCReport\Expr;

12.19.4. Set or get the image width #

Set the image width. This setting is used when the image element is a direct child of an output section. See Section 8.19.1.4.

public final
OpenCReport\Image::set_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_width():
                     ?OpenCReport\Expr;

12.19.5. Set or get the image height #

Set the image height. This setting is used when the image element is a direct child of an output section. See Section 8.19.1.4.

public final
OpenCReport\Image::set_height(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_height():
                     ?OpenCReport\Expr;

12.19.6. Set or get the image alignment #

Set the image alignment. This setting is used when the image element is a child of a text line. See Section 8.19.1.8.

public final
OpenCReport\Image::set_alignment(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_alignment():
                     ?OpenCReport\Expr;

12.19.7. Set or get the image background color #

Set the image background color. This setting is used when the image element is a child of a text line. See Section 8.19.1.7.

public final
OpenCReport\Image::set_bgcolor(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_bgcolor():
                     ?OpenCReport\Expr;

12.19.8. Set or get the image "text width" #

Set the image "text width". This setting is used when the image element is a child of a text line. See Section 8.19.1.6.

public final
OpenCReport\Image::set_text_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Image::get_text_width():
                     ?OpenCReport\Expr;