class Label extends Model

Annotations on an image can have multiple labels. A label is e.g. the type of the object visible in the region of the annotation. So if you put a circle annotation around a rock, you would label the annotation with rock.

Labels can be ordered in a tree-like structure.

Properties

protected array $hidden The attributes hidden from the model's JSON form.
protected array $casts The attributes that should be casted to native types.
bool $timestamps Don't maintain timestamps for this model.

Methods

BelongsTo
parent()

The parent label if the labels are ordered in a tree-like structure.

BelongsTo
tree()

The label tree this label belongs to.

HasMany
children()

The child labels of this label if they are ordered in a tree-like structue.

setColorAttribute(string $value)

Remove the optional '#' from a hexadecimal color.

bool
isUsed()

Determines if the label is used anywhere (e.g. attached to an annotation).

bool
canBeDeleted()

Determines if the label can be deleted.

Details

at line 49
BelongsTo parent()

The parent label if the labels are ordered in a tree-like structure.

Return Value

BelongsTo

at line 59
BelongsTo tree()

The label tree this label belongs to.

Return Value

BelongsTo

at line 70
HasMany children()

The child labels of this label if they are ordered in a tree-like structue.

Return Value

HasMany

at line 80
setColorAttribute(string $value)

Remove the optional '#' from a hexadecimal color.

Parameters

string $value The color

at line 90
bool isUsed()

Determines if the label is used anywhere (e.g. attached to an annotation).

Return Value

bool

at line 104
bool canBeDeleted()

Determines if the label can be deleted.

A label can be deleted if it doesn't have any child labels and if it is not used anywhere (e.g. attached to an annotation).

Return Value

bool