FeatureLayerProps

FeatureLayerProps = LayerProps & object

Defined in: src/ExpoArcgis.types.ts:298

Props for a <FeatureLayer> — mirror the native FeatureLayer. Provide either url (feature-service shorthand) or an explicit source.

Type Declaration

dictionaryRenderer?

optional dictionaryRenderer?: DictionaryRendererProp

Styles the layer with a DictionarySymbolStyle for military / emergency symbology (MIL-STD-2525, APP-6, etc.). Loaded asynchronously; the renderer updates once ready. Mutually exclusive with renderer — set one or the other.

displayFilter?

optional displayFilter?: { name?: string; whereClause: string; } | null

Hides features not matching a where-clause on the client — no server round-trip. Set to null or omit to clear the filter and show all features.

featureReduction?

optional featureReduction?: FeatureReduction

Aggregates dense features into clusters (feature reduction).

labels?

optional labels?: LabelDefinition[]

Label rules applied to the layer’s features.

labelsEnabled?

optional labelsEnabled?: boolean

Whether the layer’s labels are drawn.

layer?

optional layer?: FeatureLayerHandle

Display a pre-built layer handle instead of constructing one from url / source — e.g. a table from ServiceGeodatabaseHandle.getFeatureLayer (branch versioning) or GeodatabaseHandle.getFeatureLayer (local geodatabase transactions). When set, url / source are ignored; other props (renderer, visible, …) still apply.

layerId?

optional layerId?: number

Which sublayer of a feature service item to display. Ignored unless portalItem is set, and unnecessary for an item that already refers to a single feature layer.

portalItem?

optional portalItem?: PortalItem

Build the layer from an ArcGIS portal item rather than a service URL. The item’s own layer definition comes with it — renderer, definition expression, popups — so symbology authored in ArcGIS Online is applied without restating it here. A service URL only ever carries the symbology the service was published with.

Takes precedence over url / source. Construction-only (set once; remount to change). The layer’s feature table does not exist until the layer loads, so the query and edit methods on the ref load it on first use.

refreshInterval?

optional refreshInterval?: number

How often (in seconds) the layer automatically re-fetches its features from the service. 0 or omitted disables auto-refresh. Maps to refreshInterval (milliseconds) on Android and refreshInterval: TimeInterval? (seconds) on iOS.

renderer?

optional renderer?: Renderer

Overrides the layer’s symbology (simple / unique-value / class-breaks).

scaleDisplayFilter?

optional scaleDisplayFilter?: object[] | null

Activates different where-clause filters at different map scales — client-side, no server round-trip. Each entry covers a [minScale, maxScale] range; 0 means unbounded. Maps to ScaleDisplayFilterDefinition on both platforms. Set to null or omit to show all features.

Example

scaleDisplayFilter={[
  { minScale: 0, maxScale: 100000, whereClause: "TYPE = 'major'" },  // zoomed out
  { minScale: 100000, maxScale: 0,  whereClause: "1=1" },            // zoomed in
]}

sceneProperties?

optional sceneProperties?: SceneProperties

How the layer’s features sit against a 3D scene’s surface. Ignored in a <MapView>.

source?

optional source?: FeatureTableSource

Explicit feature-table source (service or local shapefile).

url?

optional url?: string

Feature service URL — shorthand for source: { type: 'service', url }.