Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchProviderBase

Hierarchy

  • SearchProviderBase

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create a new instance of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.search.SearchProviderBase} class.

    class

    The base class for all search provider.

    constructs
    memberof

    geocortex.essentialsHtmlViewer.mapping.infrastructure.search

    Parameters

    • app: ViewerApplication

      The {@link geocortex.framework.application.Application} that this base class belongs to.

    • libraryId: string

    Returns SearchProviderBase

Properties

app

app: ViewerApplication

The {@link geocortex.framework.application.Application} that this view belongs to.

description

description: string

The description of the provider.

type

String

id

id: string

The ID of the provider.

type

String

isEnabled

isEnabled: boolean

Indicates whether the provider is enabled or not.

type

Boolean

libraryId

libraryId: string

name

name: string

The name of the provider - may be displayed in the viewer.

type

String

status

status: string

Current search status.

type

geocortex.essentialsHtmlViewer.mapping.infrastructure.search.Status

supportsHints

supportsHints: boolean

Indicates whether or not this layer supports the search hints.

type

Boolean

supportsOffline

supportsOffline: boolean

Indicates that the provider can support offline searching.

type

Boolean

Methods

cancelSearch

  • cancelSearch(): void

  • Cancel a search.

    Returns void

getResource

  • getResource(resourceKey: string, locale?: string): string

  • Gets a language resource from the Application's resource dictionary, given a key, and optional locale. Returns null if the resource does not exist.

    Parameters

    • resourceKey: string
    • Optional locale: string

      The locale of the resource to fetch. Defaults to the current application locale.

    Returns string

initialize

  • initialize(config: any): void

  • Initialize the provider.

    Parameters

    • config: any

      The configuration object.

    Returns void

search

  • Performs the search.

    Parameters

    • targetFsc: FeatureSetCollection

      Where search results are to go.

    • searchText: string

      What to search for.

    Returns void