Skip to content

FeatureLayerProps

FeatureLayerProps = LayerProps & object

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

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

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.

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.

optional featureReduction?: FeatureReduction

Aggregates dense features into clusters (feature reduction).

optional labels?: LabelDefinition[]

Label rules applied to the layer’s features.

optional labelsEnabled?: boolean

Whether the layer’s labels are drawn.

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.

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.

optional renderer?: Renderer

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

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.

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

optional source?: FeatureTableSource

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

optional url?: string

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