Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DynamicFacetGenerator

Hierarchy

  • Component
    • DynamicFacetGenerator

Implements

  • IComponentBindings

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • Creates a new Fleetpride component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: IDynamicFacetGeneratorOptions

      The options for the ResultList component.

    • bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    Returns DynamicFacetGenerator

Properties

bind

bind: ComponentEvents

Allows the component to bind events and execute them only when it is enabled.

bindings

bindings: IComponentBindings

The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for different components. Mainly used by {@link ResultLink}.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to {@link ComponentEvents}.

element

element: HTMLElement

The HTMLElement on which to instantiate the component.

ensureDom

ensureDom: Function

logger

logger: Logger

Allows component to log in the dev console.

options

options: IDynamicFacetGeneratorOptions

The options for the ResultList component.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the {@link SearchInterface}).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the {@link SearchInterface}.

type

type: string

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the {@link Analytics.client}.

Static ComponentEventClass

ComponentEventClass: typeof ComponentEvents

Static ID

ID: string = "DynamicFacetGenerator"

Methods

clearGeneratedFacet

  • clearGeneratedFacet(): void

createDom

  • createDom(): void

debugInfo

  • debugInfo(): any

  • Return the debug info about this component.

    Returns any

disable

  • disable(): void

  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Component are enabled by default on creation.

    Returns void

enable

  • enable(): void

  • Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

getBindings

  • getBindings(): IComponentBindings

  • Return the bindings, or environment, for the current component.

    Returns IComponentBindings

resolveComponentOptionsModel

  • resolveComponentOptionsModel(): ComponentOptionsModel

resolveComponentStateModel

  • resolveComponentStateModel(): ComponentStateModel

resolveQueryController

  • resolveQueryController(): QueryController

resolveQueryStateModel

  • resolveQueryStateModel(): QueryStateModel

resolveResult

  • resolveResult(): IQueryResult

resolveSearchInterface

  • resolveSearchInterface(): SearchInterface

resolveUA

  • resolveUA(): IAnalyticsClient

updateDictionary

Static bindComponentToElement

  • bindComponentToElement(element: HTMLElement, component: BaseComponent): void

Static bindResultToElement

  • bindResultToElement(element: HTMLElement, result: IQueryResult): void

Static computeCssClassName

  • computeCssClassName(componentClass: any): string

Static computeCssClassNameForType

  • computeCssClassNameForType(type: string): string

Static computeSelectorForType

  • computeSelectorForType(type: string): string

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

  • Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
    If there is multiple component bound to the current HTMLElement, you must specify the component class.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Static getBoundComponentsForElement

  • getBoundComponentsForElement(element: IComponentHtmlElement): BaseComponent[]

Static getComponentRef

  • getComponentRef(component: string): any

Static getResult

  • getResult(element: HTMLElement, noThrow?: boolean): IQueryResult

  • Parameters

    • element: HTMLElement
    • Optional noThrow: boolean

    Returns IQueryResult

Static pointElementsToDummyForm

  • pointElementsToDummyForm(element: HTMLElement): void

Static resolveBinding

  • resolveBinding(element: HTMLElement, componentClass: any): BaseComponent

  • Parameters

    • element: HTMLElement
    • componentClass: any

    Returns BaseComponent

Static resolveRoot

  • resolveRoot(element: HTMLElement): HTMLElement

  • Parameters

    • element: HTMLElement

    Returns HTMLElement

Object literals

Static options

options: object

allowedFields

allowedFields: string[] = ComponentOptions.buildListOption<string>()

dependsOn

dependsOn: string = ComponentOptions.buildStringOption<string>()

Specifies whether this facet only appears when a value is selected in its "parent" facet. To specify the parent facet, use its id.

dictionary

dictionary: IFacetDictionary = ComponentOptions.buildJsonOption()

Specifies a dictionary with To specify the parent facet, use its id.

getDictionaryPromise

getDictionaryPromise: () => Promise<IFacetDictionary> = ComponentOptions.buildCustomOption<() => Promise<IFacetDictionary>>(() => {return null;})

Type declaration

transformer

transformer: (value: string) => IFacetTransformArgs = ComponentOptions.buildCustomOption<(value: string) => IFacetTransformArgs>(() => null)

Type declaration

useCache

useCache: boolean = ComponentOptions.buildBooleanOption({ defaultValue: false })

Generated using TypeDoc