Class SchedulerResource

A schedulable resource (person, room, equipment, etc.) displayed as a row in the scheduler.

Index

Constructors

Properties

Accessors

avatarUrl color filtered id name type

Methods

addProperty getPropertyByName getPropertyValue removeProperty setPropertyValue toAny fromAny

Constructors

constructor

new SchedulerResource(id: string | null, name: string): SchedulerResource
Parameters
- id: string | null
- name: string
Returns SchedulerResource
- Defined in resourcescheduler/model/scheduler-resource.ts:88

Properties

changed$

changed$: Subject<SchedulerResourceEventArgs> = ...

Emitted when any property of this resource changes.

Accessors

avatarUrl

get avatarUrl(): string | null
URL to an avatar image displayed in the sheet row.

Returns string | null
- Defined in resourcescheduler/model/scheduler-resource.ts:52
set avatarUrl(value: string | null): void
Parameters
- value: string | null
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:55

color

get color(): ColorValue | null
Color index into the theme's taskColors array, or a custom color definition. When set, all events for this resource inherit this color unless overridden by event.color.

Returns ColorValue | null
- Defined in resourcescheduler/model/scheduler-resource.ts:40
set color(value: ColorValue | null): void
Parameters
- value: ColorValue | null
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:43

filtered

get filtered(): boolean
Whether this resource is excluded by the active filter.

Returns boolean
- Defined in resourcescheduler/model/scheduler-resource.ts:76
set filtered(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:79

id

get id(): string
Unique identifier (read-only). Auto-generated if not provided in constructor.

Returns string
- Defined in resourcescheduler/model/scheduler-resource.ts:22

name

get name(): string
Display name of the resource.

Returns string
- Defined in resourcescheduler/model/scheduler-resource.ts:28
set name(value: string): void
Parameters
- value: string
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:31

type

get type(): string | null
Resource type (e.g. 'person', 'room', 'equipment', 'vehicle', or a custom string).

Returns string | null
- Defined in resourcescheduler/model/scheduler-resource.ts:64
set type(value: string | null): void
Parameters
- value: string | null
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:67

Methods

addProperty

addProperty(property: CustomProperty): void
Add a custom property to this resource.
Parameters
- property: CustomProperty
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:101

getPropertyByName

getPropertyByName(name: string): CustomProperty | null
Get a custom property by name, or null if not found.
Parameters
- name: string
Returns CustomProperty | null
- Defined in resourcescheduler/model/scheduler-resource.ts:105

getPropertyValue

getPropertyValue(name: string): any
Get the value of a custom property by name.
Parameters
- name: string
Returns any
- Defined in resourcescheduler/model/scheduler-resource.ts:107

removeProperty

removeProperty(property: CustomProperty): void
Remove a custom property from this resource.
Parameters
- property: CustomProperty
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:103

setPropertyValue

setPropertyValue(name: string, value: any): void
Set the value of a custom property by name.
Parameters
- name: string
- value: any
Returns void
- Defined in resourcescheduler/model/scheduler-resource.ts:109

toAny

toAny(): any
Serialize this resource to a plain object.

Returns any
- Defined in resourcescheduler/model/scheduler-resource.ts:114

`Static`fromAny

fromAny(obj: any): SchedulerResource
Create a SchedulerResource from a plain object (e.g. parsed JSON).
Parameters
- obj: any
Returns SchedulerResource
- Defined in resourcescheduler/model/scheduler-resource.ts:126