# Interface: PolylineOptions
# Hierarchy
-
↳ PolylineOptions
# Table of contents
# Properties
- data
- filter
- isHoverFeatureState
- isHoverPointer
- layerId
- lineBlur
- lineCap
- lineColor
- lineDasharray
- lineGapWidth
- lineGradient
- lineJoin
- lineMiterMimit
- lineOffset
- lineOpacity
- linePattern
- lineRoundLimit
- lineSortKey
- lineTranslate
- lineTranslateAnchor
- lineWidth
- maxzoom
- minzoom
- sourceId
- sourceLayer
- visibility
# Properties
# data
• data: any
# filter
• Optional
filter: any
Inherited from: OverlayLayerBaseOptions.filter
# isHoverFeatureState
• Optional
isHoverFeatureState: boolean
Inherited from: OverlayLayerBaseOptions.isHoverFeatureState
# isHoverPointer
• Optional
isHoverPointer: boolean
Inherited from: OverlayLayerBaseOptions.isHoverPointer
# layerId
• Optional
layerId: string
Inherited from: OverlayLayerBaseOptions.layerId
# lineBlur
• Optional
lineBlur: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [string | number | boolean, number][] ; type
: "categorical"
} | { default?
: number ; property
: string ; type
: "identity"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, number][] ; type
: "categorical"
}
# lineCap
• Optional
lineCap: ExpressionSpecificationEx | "butt"
| "round"
| "square"
| { stops
: [number, "butt"
| "round"
| "square"
][] ; type
: "exponential"
} | { stops
: [number, "butt"
| "round"
| "square"
][] ; type
: "interval"
} | { default?
: "butt"
| "round"
| "square"
; property
: string ; stops
: [number, "butt"
| "round"
| "square"
][] ; type
: "exponential"
} | { default?
: "butt"
| "round"
| "square"
; property
: string ; stops
: [number, "butt"
| "round"
| "square"
][] ; type
: "interval"
} | { default?
: "butt"
| "round"
| "square"
; property
: string ; stops
: [string | number | boolean, "butt"
| "round"
| "square"
][] ; type
: "categorical"
} | { default?
: "butt"
| "round"
| "square"
; property
: string ; type
: "identity"
} | { default?
: "butt"
| "round"
| "square"
; property
: string ; stops
: [{ value
: number ; zoom
: number }, "butt"
| "round"
| "square"
][] ; type
: "exponential"
} | { default?
: "butt"
| "round"
| "square"
; property
: string ; stops
: [{ value
: number ; zoom
: number }, "butt"
| "round"
| "square"
][] ; type
: "interval"
} | { default?
: "butt"
| "round"
| "square"
; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, "butt"
| "round"
| "square"
][] ; type
: "categorical"
}
# lineColor
• Optional
lineColor: string | ExpressionSpecificationEx | { stops
: [number, string][] ; type
: "exponential"
} | { stops
: [number, string][] ; type
: "interval"
} | { default?
: string ; property
: string ; stops
: [number, string][] ; type
: "exponential"
} | { default?
: string ; property
: string ; stops
: [number, string][] ; type
: "interval"
} | { default?
: string ; property
: string ; stops
: [string | number | boolean, string][] ; type
: "categorical"
} | { default?
: string ; property
: string ; type
: "identity"
} | { default?
: string ; property
: string ; stops
: [{ value
: number ; zoom
: number }, string][] ; type
: "exponential"
} | { default?
: string ; property
: string ; stops
: [{ value
: number ; zoom
: number }, string][] ; type
: "interval"
} | { default?
: string ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, string][] ; type
: "categorical"
}
# lineDasharray
• Optional
lineDasharray: number[] | ExpressionSpecificationEx | { stops
: [number, number[]][] ; type
: "exponential"
} | { stops
: [number, number[]][] ; type
: "interval"
} | { default?
: number[] ; property
: string ; stops
: [number, number[]][] ; type
: "exponential"
} | { default?
: number[] ; property
: string ; stops
: [number, number[]][] ; type
: "interval"
} | { default?
: number[] ; property
: string ; stops
: [string | number | boolean, number[]][] ; type
: "categorical"
} | { default?
: number[] ; property
: string ; type
: "identity"
} | { default?
: number[] ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number[]][] ; type
: "exponential"
} | { default?
: number[] ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number[]][] ; type
: "interval"
} | { default?
: number[] ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, number[]][] ; type
: "categorical"
}
# lineGapWidth
• Optional
lineGapWidth: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [string | number | boolean, number][] ; type
: "categorical"
} | { default?
: number ; property
: string ; type
: "identity"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, number][] ; type
: "categorical"
}
# lineGradient
• Optional
lineGradient: ExpressionSpecificationEx
# lineJoin
• Optional
lineJoin: ExpressionSpecificationEx | "round"
| "bevel"
| "miter"
| { stops
: [number, "round"
| "bevel"
| "miter"
][] ; type
: "exponential"
} | { stops
: [number, "round"
| "bevel"
| "miter"
][] ; type
: "interval"
} | { default?
: "round"
| "bevel"
| "miter"
; property
: string ; stops
: [number, "round"
| "bevel"
| "miter"
][] ; type
: "exponential"
} | { default?
: "round"
| "bevel"
| "miter"
; property
: string ; stops
: [number, "round"
| "bevel"
| "miter"
][] ; type
: "interval"
} | { default?
: "round"
| "bevel"
| "miter"
; property
: string ; stops
: [string | number | boolean, "round"
| "bevel"
| "miter"
][] ; type
: "categorical"
} | { default?
: "round"
| "bevel"
| "miter"
; property
: string ; type
: "identity"
} | { default?
: "round"
| "bevel"
| "miter"
; property
: string ; stops
: [{ value
: number ; zoom
: number }, "round"
| "bevel"
| "miter"
][] ; type
: "exponential"
} | { default?
: "round"
| "bevel"
| "miter"
; property
: string ; stops
: [{ value
: number ; zoom
: number }, "round"
| "bevel"
| "miter"
][] ; type
: "interval"
} | { default?
: "round"
| "bevel"
| "miter"
; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, "round"
| "bevel"
| "miter"
][] ; type
: "categorical"
}
# lineMiterMimit
• Optional
lineMiterMimit: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
}
# lineOffset
• Optional
lineOffset: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [string | number | boolean, number][] ; type
: "categorical"
} | { default?
: number ; property
: string ; type
: "identity"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, number][] ; type
: "categorical"
}
# lineOpacity
• Optional
lineOpacity: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [string | number | boolean, number][] ; type
: "categorical"
} | { default?
: number ; property
: string ; type
: "identity"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, number][] ; type
: "categorical"
}
# linePattern
• Optional
linePattern: string | ExpressionSpecificationEx | { stops
: [number, string][] ; type
: "exponential"
} | { stops
: [number, string][] ; type
: "interval"
} | { default?
: string ; property
: string ; stops
: [number, string][] ; type
: "exponential"
} | { default?
: string ; property
: string ; stops
: [number, string][] ; type
: "interval"
} | { default?
: string ; property
: string ; stops
: [string | number | boolean, string][] ; type
: "categorical"
} | { default?
: string ; property
: string ; type
: "identity"
} | { default?
: string ; property
: string ; stops
: [{ value
: number ; zoom
: number }, string][] ; type
: "exponential"
} | { default?
: string ; property
: string ; stops
: [{ value
: number ; zoom
: number }, string][] ; type
: "interval"
} | { default?
: string ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, string][] ; type
: "categorical"
}
# lineRoundLimit
• Optional
lineRoundLimit: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
}
# lineSortKey
• Optional
lineSortKey: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [string | number | boolean, number][] ; type
: "categorical"
} | { default?
: number ; property
: string ; type
: "identity"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, number][] ; type
: "categorical"
}
# lineTranslate
• Optional
lineTranslate: [number, number] | ExpressionSpecificationEx | { stops
: [number, [number, number]][] ; type
: "exponential"
} | { stops
: [number, [number, number]][] ; type
: "interval"
}
# lineTranslateAnchor
• Optional
lineTranslateAnchor: "map"
| ExpressionSpecificationEx | "viewport"
| { stops
: [number, "map"
| "viewport"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
][] ; type
: "interval"
}
# lineWidth
• Optional
lineWidth: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [number, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [string | number | boolean, number][] ; type
: "categorical"
} | { default?
: number ; property
: string ; type
: "identity"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "exponential"
} | { default?
: number ; property
: string ; stops
: [{ value
: number ; zoom
: number }, number][] ; type
: "interval"
} | { default?
: number ; property
: string ; stops
: [{ value
: string | number | boolean ; zoom
: number }, number][] ; type
: "categorical"
}
# maxzoom
• Optional
maxzoom: number
Inherited from: OverlayLayerBaseOptions.maxzoom
# minzoom
• Optional
minzoom: number
Inherited from: OverlayLayerBaseOptions.minzoom
# sourceId
• Optional
sourceId: string
Inherited from: OverlayLayerBaseOptions.sourceId
# sourceLayer
• Optional
sourceLayer: string
Inherited from: OverlayLayerBaseOptions.sourceLayer
# visibility
• Optional
visibility: "visible"
| "none"
Inherited from: OverlayLayerBaseOptions.visibility