highimpact.js / advantage/advantage / Advantage

Class: Advantage

advantage/advantage.Advantage

The main class for the Advantage library. This class is a singleton and is used to configure the library, register wrappers, and register custom elements.

Constructors

constructor

• new Advantage(): Advantage

Returns

Advantage

Defined in

src/advantage/advantage.ts:28

Properties

#customWrappers

• Private #customWrappers: HTMLElement[] = []

Defined in

src/advantage/advantage.ts:23

---

config

• config: null | AdvantageConfig = null

Defined in

src/advantage/advantage.ts:20

---

defaultFormats

• defaultFormats: AdvantageFormat[] = defaultFormats

Defined in

src/advantage/advantage.ts:21

---

formatIntegrations

• formatIntegrations: Map<string, AdvantageFormatIntegration>

Defined in

src/advantage/advantage.ts:25

---

formats

• formats: Map<string, AdvantageFormat>

Defined in

src/advantage/advantage.ts:24

---

wrappers

• wrappers: IAdvantageWrapper[] = []

Defined in

src/advantage/advantage.ts:22

---

id

▪ Static id: number = 0

Defined in

src/advantage/advantage.ts:26

---

instance

▪ Static Private instance: null | Advantage = null

Defined in

src/advantage/advantage.ts:19

Methods

applyConfig

▸ applyConfig(config): void

Parameters

Name	Type
config	AdvantageConfig

Returns

void

Defined in

src/advantage/advantage.ts:99

---

configure

▸ configure(config): void

Parameters

Name	Type
config	AdvantageConfig

Returns

void

Defined in

src/advantage/advantage.ts:33

---

loadConfig

▸ loadConfig(configUrl): void

Parameters

Name	Type
configUrl	string

Returns

void

Defined in

src/advantage/advantage.ts:87

---

mergeUniqueFormats

▸ mergeUniqueFormats(localFormats, userFormats): AdvantageFormat[]

Parameters

Name	Type
localFormats	AdvantageFormat[]
userFormats	AdvantageFormat[]

Returns

AdvantageFormat[]

Defined in

src/advantage/advantage.ts:137

---

registerCustomWrapper

▸ registerCustomWrapper(wrapper): void

Parameters

Name	Type
wrapper	HTMLElement

Returns

void

Defined in

src/advantage/advantage.ts:61

---

registerWrapper

▸ registerWrapper(wrapper): void

Parameters

Name	Type
wrapper	IAdvantageWrapper

Returns

void

Defined in

src/advantage/advantage.ts:46

---

reportSlotRendered

▸ reportSlotRendered(report): boolean

Reports the size selected by an ad server for a wrapped slot. This is paired with a format-agnostic creative's AD_RENDERED signal before a format is activated.

The format-agnostic creative API may change before release.

Parameters

Name	Type
report	AdvantageSlotRenderReport

Returns

boolean

Defined in

src/advantage/advantage.ts:73

---

unregisterWrapper

▸ unregisterWrapper(wrapper): void

Parameters

Name	Type
wrapper	IAdvantageWrapper

Returns

void

Defined in

src/advantage/advantage.ts:52

---

getInstance

▸ getInstance(): Advantage

Returns

Advantage

Defined in

src/advantage/advantage.ts:78