Class HistogramData

constructor

• new HistogramData(): HistogramData

  Returns HistogramData

allocationAdded$

allocationChanged$

allocationRemoved$

complexOperationFinished$

filterChanged$

resourceAdded$

resourceChanged$

resourceRemoved$

aggregateMaxCapacity

• get aggregateMaxCapacity(): number

  Get aggregate max capacity across all visible resources.

  Returns number

allocationsLength

• get allocationsLength(): number

  Total number of allocations.

  Returns number

filter

• get filter(): HistogramResourceFilterFn | null

  Active resource filter function. Set to null to show all resources.

  Returns HistogramResourceFilterFn | null

• set filter(value: HistogramResourceFilterFn | null): void

  Parameters

  • value: HistogramResourceFilterFn | null

  Returns void

maxEndTime

• get maxEndTime(): Date | null

  Latest end time across all allocations, or null if none.

  Returns Date | null

minStartTime

• get minStartTime(): Date | null

  Earliest start time across all allocations, or null if none.

  Returns Date | null

orderedResources

• get orderedResources(): HistogramResource[]

  Returns visible resources in order. Filtered resources are excluded.

  Returns HistogramResource[]

resourcesLength

• get resourcesLength(): number

  Total number of resources.

  Returns number

addAllocation

• addAllocation(allocation: HistogramAllocation): void

  Add an allocation. The allocation's resource must already exist.

  Parameters

  • allocation: HistogramAllocation

  Returns void

addResource

• addResource(resource: HistogramResource): void

  Add a resource.

  Parameters

  • resource: HistogramResource

  Returns void

assignAllocations

• assignAllocations(allocations: HistogramAllocation[]): void

  Replace all allocations with a new set.

  Parameters

  • allocations: HistogramAllocation[]

  Returns void

assignResources

• assignResources(resources: HistogramResource[]): void

  Replace all resources with a new set.

  Parameters

  • resources: HistogramResource[]

  Returns void

clearAll

• clearAll(): void

  Remove all resources and allocations.

  Returns void

createAllocation

• createAllocation(
      resourceId: string,
      startTime: Date,
      endTime: Date,
      id?: string,
  ): HistogramAllocation

  Create a new allocation instance (not yet added to the data store).

  Parameters

  • resourceId: string
  • startTime: Date
  • endTime: Date
  • Optionalid: string

  Returns HistogramAllocation

createResource

• createResource(id?: string): HistogramResource

  Create a new resource instance (not yet added to the data store).

  Parameters

  • Optionalid: string

  Returns HistogramResource

getAggregateUtilization

• getAggregateUtilization(bucketStart: Date, bucketEnd: Date): number

  Compute the aggregate utilization across all visible resources in a time bucket. Returns the sum of each resource's utilization in the bucket.

  Parameters

  • bucketStart: Date
  • bucketEnd: Date

  Returns number

getAllocation

• getAllocation(index: number): HistogramAllocation

  Get an allocation by index.

  Parameters

  • index: number

  Returns HistogramAllocation

getAllocationById

• getAllocationById(id: string): HistogramAllocation | null

  Find an allocation by ID, or null if not found.

  Parameters

  • id: string

  Returns HistogramAllocation | null

getAllocationsForResource

• getAllocationsForResource(resourceId: string): HistogramAllocation[]

  Get all allocations for a resource.

  Parameters

  • resourceId: string

  Returns HistogramAllocation[]

getPeakUtilization

• getPeakUtilization(resourceId: string): number

  Get peak utilization across all time for a resource.

  Parameters

  • resourceId: string

  Returns number

getResource

• getResource(index: number): HistogramResource

  Get a resource by index.

  Parameters

  • index: number

  Returns HistogramResource

getResourceById

• getResourceById(id: string): HistogramResource | null

  Find a resource by ID, or null if not found.

  Parameters

  • id: string

  Returns HistogramResource | null

getUtilization

• getUtilization(resourceId: string, bucketStart: Date, bucketEnd: Date): number

  Compute the total utilization for a resource in a time bucket. Returns a percentage value — 100 means 100% allocated. Partial overlap is weighted proportionally.

  Parameters

  • resourceId: string
  • bucketStart: Date
  • bucketEnd: Date

  Returns number

orderedIndexOf

• orderedIndexOf(resource: HistogramResource): number

  Returns the display index of a resource (in ordered view).

  Parameters

  • resource: HistogramResource

  Returns number

removeAllocation

• removeAllocation(allocation: HistogramAllocation): void

  Remove an allocation.

  Parameters

  • allocation: HistogramAllocation

  Returns void

removeAllocationById

• removeAllocationById(id: string): boolean

  Remove an allocation by ID. Returns true if found and removed.

  Parameters

  • id: string

  Returns boolean

removeResource

• removeResource(resource: HistogramResource): void

  Remove a resource and all its allocations.

  Parameters

  • resource: HistogramResource

  Returns void

removeResourceById

• removeResourceById(id: string): boolean

  Remove a resource by ID. Returns true if found and removed.

  Parameters

  • id: string

  Returns boolean