Options
All
  • Public
  • Public/Protected
  • All
Menu

The symbology settings widget view.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _isDestroyed

_isDestroyed: boolean

app

Private bindingSetupDelegates

bindingSetupDelegates: function[]

bindingTree

bindingTree: BindingNode

The tree of binding nodes represented in the markup.

bound

bound: boolean

Whether or not this view has been bound.

childRegions

childRegions: RegionAdapterBase[]

Regions belonging to (hosted in) this view.

configuration

configuration: any

Configuration materials.

container

container: HTMLDivElement

Container element that wraps around all symbology settings.

description

description: Observable<string>

The Observable description of the view.

displayName

displayName: string

Display name for binding to a selector

Private disposableBindings

disposableBindings: DisposableBinding[]

hostView

hostView: ViewBase

A reference to the view that hosts the region that contains this view (if any)

iconUri

iconUri: Observable<string>

The Observable icon URI of the view.

id

id: string

initiallyBound

initiallyBound: boolean

Indicates whether this view has been initialized and bound for the first time.

isActive

isActive: boolean

Whether or not this view is active.

isBusy

isBusy: Observable<boolean>

The Observable isBusy flag of the view.

isManaged

isManaged: boolean

Whether or not this view is allowed to be managed by some sort of view management component.

libraryId

libraryId: string

markupResource

markupResource: string

Resource name of the markup for this view (if any).

parentView

parentView: ViewBase

The parent view of this view, if this view is the result of a collection binding.

pictureSymbologyWidget

pictureSymbologyWidget: PictureSymbolWidget

Widget for picture symbology settings.

regionName

regionName: string

The name of the region that this view is hosted in.

root

root: HTMLElement

The root DOM element of this view.

symbologyWidget

symbologyWidget: SimpleSymbolWidget

Widget for symbology settings.

title

title: Observable<string>

The Observable title of the view.

typeName

typeName: string

The type name of this view.

viewModel

View-model of the symbology settings widget.

Methods

activated

  • activated(): void

addDisposableBinding

  • addDisposableBinding(observable: Observable<any>, token: string): void

added

applyBinding

  • Applies a binding expression to a DOM node based on the type name of the binding.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    • bindingNode: BindingNode

      The binding node to apply.

    Returns boolean

applySettings

  • applySettings(updateSubWidgets?: boolean): void
  • Apply the current settings of this widget to create the resulting symbol

    Parameters

    • Optional updateSubWidgets: boolean

    Returns void

attach

auto

  • auto(arg0: any, arg1: any, arg2: any): void
  • Binds a handler to an Observable or to a dojo.connect. Binding to an Observable:

    ``` this.auto(someObservable, function (newValue) { });

    with explicit scope:

    this.auto(someObservable, this, function (newValue) { });

    Alternately, pass an event name as a string to use dojo.connect:

    this.auto(window, "onclick", function () { }); ```

    Parameters

    • arg0: any

      Either an Observable (for observable bindings) or a regular object (if arg1 is a string)

    • arg1: any

      If arg0 is an Observable, a function or scope object. Otherwise, an event name (to use with dojo.connect).

    • arg2: any

      If arg0 is an Observable, a function handler.

    Returns void

buildAttributeBinding

  • buildAttributeBinding(el: HTMLElement, binding: BindingExpression, currentContext: any, directAttach?: boolean): boolean
  • Builds a DOM attribute binding, binding a DOM attribute to a view model property or attaching directly to the DOM object.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    • Optional directAttach: boolean

      Whether or not to directly modify the actual DOM element's own properties. Defaults to false.

    Returns boolean

buildClassBinding

  • buildClassBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

buildDisabledBinding

  • buildDisabledBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

buildDomBinding

  • buildDomBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds a one-time DOM binding, binding to a DOM element in the view codebehind.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildEventBinding

  • buildEventBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

buildSourceBinding

  • Builds a complex binding between a source and template element. Allows binding to collections of complex objects or singular complex objects.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    • bindingNode: BindingNode

      The current binding node in the binding tree.

    Returns boolean

buildStyleBinding

  • buildStyleBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

buildTextBinding

  • buildTextBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds a sanitized text binding. Strips out unsafe characters, and allows direct referencing of language keys.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildTree

  • buildTree(): any
  • Builds a tree of all binding expressions in this view and hooks up binding events as it goes. This method will recursively descend the DOM structure of its visual root and resolve binding expressions.

    Returns any

buildValueBinding

  • buildValueBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

buildVarBinding

  • buildVarBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): void
  • Builds a var binding, creating a variable in the view that references a DOM element.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns void

buildVisibilityBinding

  • buildVisibilityBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

buildWidgetBinding

  • buildWidgetBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

deactivated

  • deactivated(): void

destroy

  • destroy(): void

destroyBindings

  • destroyBindings(): void

getBindingTarget

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

getSymbol

  • getSymbol(): string
  • Get the symbol currently configured by this widget as a JSON string

    Returns string

isDestroyed

  • isDestroyed(): boolean

onDestroy

  • onDestroy(): void

pulseAll

  • pulseAll(): void

removed

  • removed(): void

reset

  • reset(): void
  • Calling 'reset' on this widget reverts to the default state

    Returns void

resolveBindingTemplate

resolveWidget

  • resolveWidget(widgetId: string, context: any, binding: any): any
  • The PictureMarker symbology widget is optional. We'll resolve it (or not) here to avoid loading it unneccessarily

    Parameters

    • widgetId: string
    • context: any
    • binding: any

    Returns any

setBindingTargetValue

setFeatureType

  • setFeatureType(type: string): void
  • Set the feature type currently configured by this widget

    Parameters

    • type: string

      One of "point", "polyline" or "polygon"

    Returns void

setFromRenderer

  • setFromRenderer(renderer: Renderer): void
  • Sets the configuration of this widget from the symbol contained in the supplied esri.renderer.Renderer

    Parameters

    • renderer: Renderer

    Returns void

setFromSymbol

  • setFromSymbol(symbol: Symbol): void
  • Sets the configuration of this widget from a supplied esri.symbol.Symbol

    Parameters

    • symbol: Symbol

      Must be of a type supported by this widget: Simple***Symbol or PictureMarkerSymbol

    Returns void

trackCommandHandler

  • trackCommandHandler(command: any, token: any): void

trackSubscription

  • trackSubscription(event: any, token: any): void