highimpact.js / advantage/high-impact-js
Module: advantage/high-impact-js
Variables
cmd
• Const cmd: Object
Command queue handler for asynchronous execution
Type declaration
| Name | Type |
|---|---|
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
| Name | Type |
|---|---|
slotConfig | SlotConfig |
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
| Name | Type |
|---|---|
format | string |
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
| Name | Type |
|---|---|
elementId | string |
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
| Name | Type |
|---|---|
template | string |
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
| Name | Type | Default value |
|---|---|---|
«destructured» | Object | {} |
› deferQueuedCommands? | boolean | false |
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
| Name | Type |
|---|---|
config | GlobalConfig |
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
| Name | Type |
|---|---|
template | string |
config | TemplateConfig |
Returns
void
Defined in
src/advantage/high-impact-js/index.ts:908
setTopBarVisibility
▸ setTopBarVisibility(isVisible): void
Sets the visibility of the top bar
Parameters
| Name | Type |
|---|---|
isVisible | boolean |
Returns
void