File

projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts

Description

The WvrMessageManifestComponent is used to express a potential remote data source. To be used with the wvr-data input.

Extends

WvrBaseComponent

Metadata

changeDetection	`ChangeDetectionStrategy.Default`
selector	`wvr-message-manifest-component`
template	`<ng-content></ng-content>`

Index

Constructor

constructor(injector: Injector)

Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:42

Parameters :

Name	Type	Optional
injector	`Injector`	No

Inputs

brokerUrl
Type : `string`
Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:29
The broker URL to be prepended to all paths expressed on MessageManifestEntries.

description
Type : `string`
Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:25
A human description of this manifes.

mappingStrategy
Type : `any`
Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:39
The strategy to be employed to unwrap response data.

name
Type : `string`
Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:21
The name by which this message manifest can be referenced.

options
Type : `any`
Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:35
Additional configuration options.

protocol
Type : `any`
Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:32
The protocol to use.

animate
Type : `string`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:68`
A setter which parses a json string describing animation instructions and stores the derived object in `_animationSettings`.

animateConfig
Type : `string`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:76`
A setter which parses a json string describing animation setting and stores the derived object in `_animationConfig`.

animateId
Type : `string`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:84`
An attribute input allowing for the designation of an animation identifier for the purpose of animation targeting.

animateTarget
Type : `string`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:87`
An attribute input allowing for the designation of an animation target for animation events.

hiddenInMobile
Type : `boolean`
Default value : `false`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:107`
An attribute input specifying if this component should be hidden in the mobile layout.

ngBindings
Type : `string`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:116`

themeVariant
Type : `ThemeVariantName`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:55`
Used to define the class type of an alert component.

wvrData
Type : `string`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:45`

wvrTheme
Type : `string`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:50`
Allows for the override of theme for the particular component.

Outputs

animationEventTrigger
Type : `EventEmitter`
Inherited from `WvrBaseComponent`
Defined in `WvrBaseComponent:110`
An Output biding used for triggering animations.

HostBindings

class.wvr-bootstrap

Type : boolean

Default value : true

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:58

A host binding used to ensure the presense of the wvr-bootstrap class.

class.wvr-hidden

Type : boolean

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:102

A host bound accessor which applies the wvr-hidden class if both isMobileLayout and hiddenInMobile evaluate to true.

style

Type : any

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:60

Methods

addEntry

addEntry(entry: WvrMessageManifestEntryComponent)

Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:49

Parameters :

Name	Type	Optional
entry	`WvrMessageManifestEntryComponent`	No

Returns : void

Private buildEntries

buildEntries()

Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:60

Converts this message manifests WvrMessageManifestEntryComponents into MessageManifestEntries.

Returns : void

applyThemeOverride

applyThemeOverride(customProperty: string, value: string)

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:237

Parameters :

Name	Type	Optional
customProperty	`string`	No
value	`string`	No

Returns : void

bootstrapNgBindings

bootstrapNgBindings()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:175

Returns : void

getWvrData

getWvrData()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:262

Returns : string

hasWvrData

hasWvrData()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:258

Returns : boolean

initializeAnimationElement

initializeAnimationElement()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:267

Returns : void

initializeAnimationRegistration

initializeAnimationRegistration()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:273

Returns : void

ngAfterContentInit

ngAfterContentInit()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:160

Used for post content initialization animation setup.

Returns : void

ngOnDestroy

ngOnDestroy()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:166

Handles the the unregistering of this component with the component registry.

Returns : void

ngOnInit

ngOnInit()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:145

Used to setup this component for animating.

Returns : void

onAnimationEvent

onAnimationEvent($event: Event)

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:290

Trigger's the animation specified by the incoming event.

Parameters :

Name	Type	Optional
$event	`Event`	No

Returns : void

Private processData

processData()

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:295

Returns : void

triggerAnimations

triggerAnimations(animationTriggerType: string)

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:244

Plays the animation specified by the incoming animation trigger.

Parameters :

Name	Type	Optional
animationTriggerType	`string`	No

Returns : void

Properties

Private Readonly messageManifestEntries

Default value : new Array<WvrMessageManifestEntryComponent>()

Defined in projects/wvr-elements/src/lib/wvr-message-manifest/wvr-message-manifest.component.ts:42

A collection of the child WvrMessageManifestEntryComponent.

Private _animationConfig

Type : any

Default value : {}

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:73

An object representation of the settings specifying the specific behavior of the animation for this component.

Private Readonly _animationService

Type : AnimationService<WvrBaseComponent>

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:93

A reference to the AnimationService

Private _animationSettings

Type : any

Default value : {}

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:65

An object representation of the animation instructions for this component.

Private _ngBindings

Type : literal type

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:114

animationRootElem

Type : ElementRef

Decorators :


                            @ViewChild('animationRoot')

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:90

A view child of the template element containing the #animationRoot identifier.

Private animationStateId

Type : number

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:81

An identifier used to access the animation state for this component.

Readonly appConfig

Type : AppConfig

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:37

A reference to the AppConfig

Readonly cdRef

Type : ChangeDetectorRef

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:34

A reference to the ChangeDetectorRef

Readonly componentRegistry

Type : ComponentRegistryService<WvrBaseComponent>

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:25

A reference to the ComponentRegistryService

data

Type : literal type

Default value : {}

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:42

Readonly eRef

Type : ElementRef

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:31

A reference to the ElementRef

Readonly id

Type : number

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:28

A generated unique identifier for this comonent.

isMobile

Type : Observable<boolean>

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:120

isMobileLayout

Type : boolean

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:112

Private Readonly kebabize

Default value : () => {...}

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:321

Private Readonly ngBindingsService

Type : NgBindingsService

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:99

A reference to the NgBindingsService

Readonly store

Type : Store<RootState>

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:40

A reference to the Store

style

Decorators :


                            @HostBinding('style')

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:60

Protected subscriptions

Type : Array<Subscription>

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:122

themeOverrides

Type : object

Default value : {}

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:47

Private Readonly themeService

Type : ThemeService

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:96

A reference to the ThemeService

variantTypes

Type : []

Default value : []

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:62

wvrBootstrap

Default value : true

Decorators :


                            @HostBinding('class.wvr-bootstrap')

Inherited from WvrBaseComponent

Defined in WvrBaseComponent:58

A host binding used to ensure the presense of the wvr-bootstrap class.

import { ChangeDetectionStrategy, Component, Injector, Input } from '@angular/core';
import * as JSON5 from 'json5';
import { MessageClientOptions, MessageClientProtocol, MessageManifest, MessageManifestActions, MessageManifestEntry, MessageManifestReducers, MessageMappingStrategy } from '../core/message-manifest';
import { wvrTimeout } from '../shared/utility';
import { WvrBaseComponent } from '../shared/wvr-base.component';
import { WvrMessageManifestEntryComponent } from './wvr-message-manifest-entry/wvr-message-manifest-entry.component';

/**
 * The WvrMessageManifestComponent is used to express a potential remote data source. To be used
 * with the `wvr-data` input.
 */
@Component({
  selector: 'wvr-message-manifest-component',
  template: '<ng-content></ng-content>',
  changeDetection: ChangeDetectionStrategy.Default
})
export class WvrMessageManifestComponent extends WvrBaseComponent {

  /** The name by which this message manifest can be referenced. */
  // tslint:disable-next-line: prefer-readonly
  @Input() name: string;

  /** A human description of this manifes. */
  // tslint:disable-next-line: prefer-readonly
  @Input() description: string;

  /** The broker URL to be prepended to all paths expressed on MessageManifestEntries. */
  // tslint:disable-next-line: prefer-readonly
  @Input() brokerUrl: string;

  /** The protocol to use. */
  @Input() protocol;

  /** Additional configuration options. */
  @Input() options;

  /** The strategy to be employed to unwrap response data. */
  // tslint:disable-next-line: prefer-readonly
  @Input() mappingStrategy;

  /** A collection of the child WvrMessageManifestEntryComponent. */
  private readonly messageManifestEntries = new Array<WvrMessageManifestEntryComponent>();

  // tslint:disable-next-line:no-empty
  constructor(injector: Injector) {
    super(injector);
  }

  addEntry(entry: WvrMessageManifestEntryComponent): void {
    this.messageManifestEntries.push(entry);

    wvrTimeout(() => {
      this.buildEntries();
    });
  }

  /**
   * Converts this message manifests WvrMessageManifestEntryComponents into MessageManifestEntries.
   */
  private buildEntries(): void {
    const ms = this.mappingStrategy ? this.mappingStrategy.toUpperCase() : 'NONE';

    const entries: Array<MessageManifestEntry> = this.messageManifestEntries.map(e => ({
      name: e.name,
      description: e.description,
      destination: e.destination,
      mappingStrategy: e.mappingStrategy ? e.mappingStrategy.toUpperCase() : ms
    }));

    const manifest: MessageManifest = {
      name: this.name,
      description: this.description,
      brokerUrl: this.brokerUrl,
      entries,
      connection: {
        status: MessageManifestReducers.ConnectionStatus.DISCONNECTED
      },
      protocol: this.protocol ? this.protocol.toUpperCase() : undefined,
      options: this.options ? JSON5.parse(this.options) : undefined
    };

    this.store.dispatch(MessageManifestActions.addManifest({
      manifest
    }));
  }

}

Legend

Html element

Component

Html element with directive

File

Description

Extends

Metadata

Index

Properties

Methods

Inputs

Outputs

HostBindings

Constructor

Inputs

Outputs

HostBindings

Methods

Properties

results matching ""

No results matching ""