Options
All
  • Public
  • Public/Protected
  • All
Menu

Holds configuration information about a view.

Hierarchy

  • ViewConfig

Implements

Index

Constructors

constructor

  • new ViewConfig(viewId: string, moduleName: string, typeName: string): ViewConfig
  • Initializes a new instance of the {@link geocortex.framework.config.ViewConfig} class.

    Parameters

    • viewId: string

      The configured ID of this view.

    • moduleName: string

      The name of the module that this view belongs to.

    • typeName: string

      The type name of the instance for this view.

    Returns ViewConfig

Properties

configuration

configuration: any

Configuration materials to pass this view upon initialization.

description

description: string

A description of this view.

iconUri

iconUri: string

An image URI to use an icon when displaying or managing this view.

isManaged

isManaged: boolean

Whether or not this view allows itself to be "managed" by a component such as a toolbar.

isVisible

isVisible: boolean

Whether or not this view is initially visible. Views that are initially visible will typically get activated when hosted.

libraryId

libraryId: string

The ID of the library that this view belongs to.

markupResource

markupResource: string

resource key into the {@link geocortex.framework.application.ResourceManager} that will be used to load the view UI.

moduleName

moduleName: string

The name of the module that this view belongs to.

regionName

regionName: string

The name of the region to host this view into once activated.

require

require: string

Require path to the view class.

requireMarkup

requireMarkup: string

Require path to the view markup.

title

title: string

The title to give the view upon creation.

typeName

typeName: string

The type name of the view instance.

viewId

viewId: string

The ID of the view represented by this {@link geocortex.framework.config.ViewConfig} object.

viewModel

viewModel: ViewModelBase

An instance of a view model to bind this view to.

viewModelId

viewModelId: string

An ID of a view model to bind this view to.