import Metric from 'pvbid-sdk/src/domain/Metric.js'

public class | source

Metric

eventemitter3~EventEmitter → AdvanceEventEmitter → BidEntity → Metric

Metric Class

Constructor Summary

Public Constructor
public	constructor(metricData: object, bid: Bid) Creates an instance of Metric.

Public Members
public get	actualValue: number
public set	actualValue: number
public	bid: Bid Reference to the bid that the metric belongs to.
public get	config: object
public get	definitionId: number this get was deprecated. Definition ids will become obsolete in planned data structure upgrade. Gets the metrics's definition id.
public get	value: number
public set	value: number

Public Methods
public	assess() Assess metric for changes.
public	bind() Binds the "updated" event for all dependant bid entities.
public	dependants(): BidEntity[] Gets an array of bid entities that rely on the metric
public	dependencies(): BidEntity[] Gets an array of bid entities that the metric relies on.
public	dirty() Flags the metric and corresponding bid as dirty and to be saved.
public	exportData(alwaysIncludeConfig: boolean): object Exports intermal metric data.
public	getAssembly(): Assembly \| undefined Get the metric assembly if it has one
public	hasNullDependency(): * Determines if the metric has any null dependencies
public	isDirty(): boolean Determines if metric instance is dirty.
public	reset() Resets the metric, removing any override value.
public	setAssembly(assembly: Assembly \| string): Assembly Adds the metric to an assembly.
public	unsetAssembly(): void Removes any assembly reference from the metric.

From class AdvanceEventEmitter
public	maxEvents: number Maximum number of events fired for the requester before events stop.
public	on(eventName: string, requesterId: string, callback: function)
public	onDelay(eventName: string, ms: number, requesterId: string, callback: function)
public	removeListenerByRequester(eventName: string, requesterId: string) Removes event listeners by event and requesterId.

From class BidEntity
public get	hasAssembly: boolean Determine if the entity is in an assembly
public get	id: number \| string Gets the id of the bid entity.
public get	title: string Gets the bid entity title.
public set	title: string Sets the bid entity title.
public get	type: string Gets the bid entity type.
public abstract	assess(dependency: BidEntity) Assesses bid entity.
public	dependants(): BidEntity[] Gets an array of depndants that rely on the bid entity.
public	dependencies(): BidEntity[] Gets all the dependencies that the bid entity relies on.
public	dirty() Flags the bid entity as dirty and to be saved.
public	exportData(): object Exports the internal data for the bid entity.
public	hasNullDependency(field: string): boolean Determines if bid entity relies on a null or undefined dependency value
public	async initSaveChangeLog(originalValue: , newValue: , valueType: , entityProperty: , metaData: ):
public	isDirty(): boolean Determines of bid entity is dirty.
public	pristine() Marks the bid entity as clean.