Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISearchCommand

Describes a search command

export
interface

ISearchCommand

Hierarchy

Index

Properties

Optional filter

filter: undefined | string

The search filter to apply based on user input

type

{string}

memberof

ISearchCommand

Optional icon

icon: undefined | string

The icon for this command

type

{string}

memberof

ISearchCommand

Optional iconClass

iconClass: undefined | string

layer

layer: string

The name of the map layer this commmand applies to

type

{string}

memberof

ISearchCommand

matchLimit

matchLimit: number

The maximum number of results to return

type

{number}

memberof

ISearchCommand

prompt

prompt: string

The prompt to display in the search command UI

type

{string}

memberof

ISearchCommand

resultColumns

resultColumns: ResultColumnSet

The set of feature properties to show in the search results

type

{ResultColumnSet}

memberof

ISearchCommand

target

Specifies the target which the URL should be invoked in

type

{CommandTarget}

memberof

IInvokeUrlCommand

Optional targetFrame

targetFrame: undefined | string

The name of the frame to run this command in. Only applies if the target is "SpecifiedFrame"

title

title: string

The title to display in the search command UI

type

{string}

memberof

ISearchCommand

Generated using TypeDoc