featureOverrideProvider

Accessor

An object which can customize the appearance of Viewport.Features within a viewport. If defined, the provider will be invoked whenever the overrides are determined to need updating. The overrides can be explicitly marked as needing a refresh by calling Viewport.setFeatureOverrideProviderChanged. This is typically called when the internal state of the provider changes such that the computed overrides must also change.

featureOverrideProvider: undefined | FeatureOverrideProvider

see FeatureSymbology.Overrides

see Viewport.findFeatureOverrideProvider as a replacement for the deprecated getter.

see Viewport.addFeatureOverrideProvider as the replacement for the deprecated setter.

note A viewport can now have any number of FeatureOverrideProviders, therefore this property is deprecated. The getter will return undefined unless exactly one provider is registered; the setter will remove any other providers and register only the new provider.

Returns - undefined | FeatureOverrideProvider


Setter

An object which can customize the appearance of Viewport.Features within a viewport. If defined, the provider will be invoked whenever the overrides are determined to need updating. The overrides can be explicitly marked as needing a refresh by calling Viewport.setFeatureOverrideProviderChanged. This is typically called when the internal state of the provider changes such that the computed overrides must also change.

featureOverrideProvider(provider: undefined | FeatureOverrideProvider): void

see FeatureSymbology.Overrides

see Viewport.findFeatureOverrideProvider as a replacement for the deprecated getter.

see Viewport.addFeatureOverrideProvider as the replacement for the deprecated setter.

note A viewport can now have any number of FeatureOverrideProviders, therefore this property is deprecated. The getter will return undefined unless exactly one provider is registered; the setter will remove any other providers and register only the new provider.

Parameter Type Description
provider undefined | FeatureOverrideProvider  

Returns - void

Defined in

Last Updated: 12 June, 2024