class FileApi

package api.backend

implements SwitchContext

@:directlyUsed@:build(api.macro.PHPInterface.build())@:autoBuild(api.macro.PHPInterface.build())@:build(safety.macro.SafeAst.build())@:keep

Constructor

@:keepnew (file:File)

Variables

@:keepread onlyfocus_x:Float

If the file is an image, a focus point can be set for cropping, this contains the x value percentage point

@:keepread onlyfocus_y:Float

Focus point y value

@:keepread onlyheight:Null<Int>

If the file is an image, height is set

@:keepread onlylocal_path:String

A relative path to the file

@:keepread onlymime_type:String

The file's mime type

@:keepread onlyname:String

The file name, includes extension

@:keepread onlysize:Int

Filesize in bytes

@:keepread onlytags:Array<String>

Get all tags associated with this file

@:keepread onlywidth:Null<Int>

If the file is an image, width is set

Methods

@:keepgetLinkData ():FileLinkData

Get link data which can be used to link in components

@:keepsetFocusPoint (x:Float, y:Float):FileApi

Set focus point for an image. The x and y values must be percentage points (0-1).

@:keepsetTags (tags:Array<String>):FileApi

Set tags associated with this file