Skip to content

highimpact.js / advantage/high-impact-js

Module: advantage/high-impact-js ​

Variables ​

cmd ​

• Const cmd: Object

Command queue handler for asynchronous execution

Type declaration ​

NameType
push(command: () => void) => void

Defined in ​

src/advantage/high-impact-js/index.ts:876

Functions ​

defineSlot ​

▸ defineSlot(slotConfig): void

Defines a new ad slot with the specified configuration

Parameters ​

NameType
slotConfigSlotConfig

Returns ​

void

Defined in ​

src/advantage/high-impact-js/index.ts:852


getConfig ​

▸ getConfig(): GlobalConfig

Gets the global configuration

Returns ​

GlobalConfig

Defined in ​

src/advantage/high-impact-js/index.ts:996


getFormatOptionsForFormat ​

▸ getFormatOptionsForFormat(format): undefined | AdvantageFormatOptions

Format options for an Advantage format, derived from the template config set with setTemplateConfig. Used by the wrapper when a creative requests the format itself, so peekAmount etc. apply on that path too.

Parameters ​

NameType
formatstring

Returns ​

undefined | AdvantageFormatOptions

Defined in ​

src/advantage/high-impact-js/index.ts:1267


getSlotConfig ​

▸ getSlotConfig(elementId): undefined | SlotConfig

Gets the configuration for a specific slot

Parameters ​

NameType
elementIdstring

Returns ​

undefined | SlotConfig

Defined in ​

src/advantage/high-impact-js/index.ts:900


getTemplateConfig ​

▸ getTemplateConfig(template): TemplateConfig

Gets the configuration for a specific template

Parameters ​

NameType
templatestring

Returns ​

TemplateConfig

Defined in ​

src/advantage/high-impact-js/index.ts:981


initializeHighImpactJs ​

▸ initializeHighImpactJs(«destructured»?): Promise<void>

Initialize the High Impact JS compatibility layer

Parameters ​

NameTypeDefault value
«destructured»Object{}
› deferQueuedCommands?booleanfalse

Returns ​

Promise<void>

Defined in ​

src/advantage/high-impact-js/index.ts:1200


resetState ​

▸ resetState(): void

Returns ​

void

Defined in ​

src/advantage/high-impact-js/index.ts:1311


setConfig ​

▸ setConfig(config): void

Sets the global configuration

Parameters ​

NameType
configGlobalConfig

Returns ​

void

Defined in ​

src/advantage/high-impact-js/index.ts:988


setTemplateConfig ​

▸ setTemplateConfig(template, config): void

Sets the configuration for a specific template

Parameters ​

NameType
templatestring
configTemplateConfig

Returns ​

void

Defined in ​

src/advantage/high-impact-js/index.ts:908


setTopBarVisibility ​

▸ setTopBarVisibility(isVisible): void

Sets the visibility of the top bar

Parameters ​

NameType
isVisibleboolean

Returns ​

void

Defined in ​

src/advantage/high-impact-js/index.ts:887