Interface ParentRect
fillPaint:
| {
"fill-antialias"?: PropertyValueSpecification<boolean>;
"fill-color"?: DataDrivenPropertyValueSpecification<string>;
"fill-color-transition"?: TransitionSpecification;
"fill-layer-opacity"?: PropertyValueSpecification<number>;
"fill-layer-opacity-transition"?: TransitionSpecification;
"fill-opacity"?: DataDrivenPropertyValueSpecification<number>;
"fill-opacity-transition"?: TransitionSpecification;
"fill-outline-color"?: DataDrivenPropertyValueSpecification<string>;
"fill-outline-color-transition"?: TransitionSpecification;
"fill-pattern"?: DataDrivenPropertyValueSpecification<string>;
"fill-pattern-transition"?: TransitionSpecification;
"fill-translate"?: PropertyValueSpecification<[number, number]>;
"fill-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"fill-translate-transition"?: TransitionSpecification;
}
| undefined;
lineLayout: | {
"line-cap"?: DataDrivenPropertyValueSpecification<
"round"
| "butt"
| "square",
>;
"line-join"?: DataDrivenPropertyValueSpecification<
"round"
| "bevel"
| "miter",
>;
"line-miter-limit"?: DataDrivenPropertyValueSpecification<number>;
"line-round-limit"?: DataDrivenPropertyValueSpecification<number>;
"line-sort-key"?: DataDrivenPropertyValueSpecification<number>;
visibility?: VisibilitySpecification;
}
| undefined;
linePaint: | {
"line-blur"?: DataDrivenPropertyValueSpecification<number>;
"line-blur-transition"?: TransitionSpecification;
"line-color"?: DataDrivenPropertyValueSpecification<string>;
"line-color-transition"?: TransitionSpecification;
"line-dasharray"?: DataDrivenPropertyValueSpecification<number[]>;
"line-dasharray-transition"?: TransitionSpecification;
"line-gap-width"?: DataDrivenPropertyValueSpecification<number>;
"line-gap-width-transition"?: TransitionSpecification;
"line-gradient"?: ExpressionSpecification;
"line-layer-opacity"?: PropertyValueSpecification<number>;
"line-layer-opacity-transition"?: TransitionSpecification;
"line-offset"?: DataDrivenPropertyValueSpecification<number>;
"line-offset-transition"?: TransitionSpecification;
"line-opacity"?: DataDrivenPropertyValueSpecification<number>;
"line-opacity-transition"?: TransitionSpecification;
"line-pattern"?: DataDrivenPropertyValueSpecification<string>;
"line-pattern-transition"?: TransitionSpecification;
"line-translate"?: PropertyValueSpecification<[number, number]>;
"line-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"line-translate-transition"?: TransitionSpecification;
"line-width"?: DataDrivenPropertyValueSpecification<number>;
"line-width-transition"?: TransitionSpecification;
}
| undefined;
}
Index
Properties
Properties
fillPaint
| {
"fill-antialias"?: PropertyValueSpecification<boolean>;
"fill-color"?: DataDrivenPropertyValueSpecification<string>;
"fill-color-transition"?: TransitionSpecification;
"fill-layer-opacity"?: PropertyValueSpecification<number>;
"fill-layer-opacity-transition"?: TransitionSpecification;
"fill-opacity"?: DataDrivenPropertyValueSpecification<number>;
"fill-opacity-transition"?: TransitionSpecification;
"fill-outline-color"?: DataDrivenPropertyValueSpecification<string>;
"fill-outline-color-transition"?: TransitionSpecification;
"fill-pattern"?: DataDrivenPropertyValueSpecification<string>;
"fill-pattern-transition"?: TransitionSpecification;
"fill-translate"?: PropertyValueSpecification<[number, number]>;
"fill-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"fill-translate-transition"?: TransitionSpecification;
}
| undefined
Type Declaration
- {
"fill-antialias"?: PropertyValueSpecification<boolean>;
"fill-color"?: DataDrivenPropertyValueSpecification<string>;
"fill-color-transition"?: TransitionSpecification;
"fill-layer-opacity"?: PropertyValueSpecification<number>;
"fill-layer-opacity-transition"?: TransitionSpecification;
"fill-opacity"?: DataDrivenPropertyValueSpecification<number>;
"fill-opacity-transition"?: TransitionSpecification;
"fill-outline-color"?: DataDrivenPropertyValueSpecification<string>;
"fill-outline-color-transition"?: TransitionSpecification;
"fill-pattern"?: DataDrivenPropertyValueSpecification<string>;
"fill-pattern-transition"?: TransitionSpecification;
"fill-translate"?: PropertyValueSpecification<[number, number]>;
"fill-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"fill-translate-transition"?: TransitionSpecification;
}Optionalfill-antialias?: PropertyValueSpecification<boolean>Optionalfill-color?: DataDrivenPropertyValueSpecification<string>The color of the filled part of this layer. This color can be specified as
rgbawith an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used. When used with an SDF fill pattern, this serves as the foreground color of the pattern.Optionalfill-color-transition?: TransitionSpecificationOptionalfill-layer-opacity?: PropertyValueSpecification<number>Opacity applied to the layer as a whole. Unlike
fill-opacityand alpha values infill-color, which are applied per feature and accumulate where fills overlap,fill-layer-opacityis applied once so overlapping fills appear as a single surface at the given opacity. When bothfill-opacityandfill-layer-opacityare set, the per-feature, overlap accumulation is preserved, thenfill-layer-opacitycomposites the result. This property affects only the layer it is set on and cannot be used to composite multiple layers together or control how this layer blends with layers above or below it.Optionalfill-layer-opacity-transition?: TransitionSpecificationOptionalfill-opacity?: DataDrivenPropertyValueSpecification<number>The opacity of the entire fill layer. In contrast to the
fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used.Optionalfill-opacity-transition?: TransitionSpecificationOptionalfill-outline-color?: DataDrivenPropertyValueSpecification<string>The outline color of the fill. Matches the value of
fill-colorif unspecified.Optionalfill-outline-color-transition?: TransitionSpecificationOptionalfill-pattern?: DataDrivenPropertyValueSpecification<string>Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Optionalfill-pattern-transition?: TransitionSpecificationOptionalfill-translate?: PropertyValueSpecification<[number, number]>The geometry's offset. Values are
[x, y]where negatives indicate left and up, respectively.Optionalfill-translate-anchor?: PropertyValueSpecification<"map" | "viewport">Controls the frame of reference for
fill-translate.Optionalfill-translate-transition?: TransitionSpecification
- undefined
lineLayout
| {
"line-cap"?: DataDrivenPropertyValueSpecification<
"round"
| "butt"
| "square",
>;
"line-join"?: DataDrivenPropertyValueSpecification<
"round"
| "bevel"
| "miter",
>;
"line-miter-limit"?: DataDrivenPropertyValueSpecification<number>;
"line-round-limit"?: DataDrivenPropertyValueSpecification<number>;
"line-sort-key"?: DataDrivenPropertyValueSpecification<number>;
visibility?: VisibilitySpecification;
}
| undefined
Type Declaration
- {
"line-cap"?: DataDrivenPropertyValueSpecification<
"round"
| "butt"
| "square",
>;
"line-join"?: DataDrivenPropertyValueSpecification<
"round"
| "bevel"
| "miter",
>;
"line-miter-limit"?: DataDrivenPropertyValueSpecification<number>;
"line-round-limit"?: DataDrivenPropertyValueSpecification<number>;
"line-sort-key"?: DataDrivenPropertyValueSpecification<number>;
visibility?: VisibilitySpecification;
}Optionalline-cap?: DataDrivenPropertyValueSpecification<"round" | "butt" | "square">The display of line endings.
Optionalline-join?: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">The display of lines when joining.
Optionalline-miter-limit?: DataDrivenPropertyValueSpecification<number>Used to automatically convert miter joins to bevel joins for sharp angles.
Optionalline-round-limit?: DataDrivenPropertyValueSpecification<number>Used to automatically convert round joins to miter joins for shallow angles.
Optionalline-sort-key?: DataDrivenPropertyValueSpecification<number>Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
Optionalvisibility?: VisibilitySpecificationWhether this layer is displayed.
- undefined
linePaint
| {
"line-blur"?: DataDrivenPropertyValueSpecification<number>;
"line-blur-transition"?: TransitionSpecification;
"line-color"?: DataDrivenPropertyValueSpecification<string>;
"line-color-transition"?: TransitionSpecification;
"line-dasharray"?: DataDrivenPropertyValueSpecification<number[]>;
"line-dasharray-transition"?: TransitionSpecification;
"line-gap-width"?: DataDrivenPropertyValueSpecification<number>;
"line-gap-width-transition"?: TransitionSpecification;
"line-gradient"?: ExpressionSpecification;
"line-layer-opacity"?: PropertyValueSpecification<number>;
"line-layer-opacity-transition"?: TransitionSpecification;
"line-offset"?: DataDrivenPropertyValueSpecification<number>;
"line-offset-transition"?: TransitionSpecification;
"line-opacity"?: DataDrivenPropertyValueSpecification<number>;
"line-opacity-transition"?: TransitionSpecification;
"line-pattern"?: DataDrivenPropertyValueSpecification<string>;
"line-pattern-transition"?: TransitionSpecification;
"line-translate"?: PropertyValueSpecification<[number, number]>;
"line-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"line-translate-transition"?: TransitionSpecification;
"line-width"?: DataDrivenPropertyValueSpecification<number>;
"line-width-transition"?: TransitionSpecification;
}
| undefined
Type Declaration
- {
"line-blur"?: DataDrivenPropertyValueSpecification<number>;
"line-blur-transition"?: TransitionSpecification;
"line-color"?: DataDrivenPropertyValueSpecification<string>;
"line-color-transition"?: TransitionSpecification;
"line-dasharray"?: DataDrivenPropertyValueSpecification<number[]>;
"line-dasharray-transition"?: TransitionSpecification;
"line-gap-width"?: DataDrivenPropertyValueSpecification<number>;
"line-gap-width-transition"?: TransitionSpecification;
"line-gradient"?: ExpressionSpecification;
"line-layer-opacity"?: PropertyValueSpecification<number>;
"line-layer-opacity-transition"?: TransitionSpecification;
"line-offset"?: DataDrivenPropertyValueSpecification<number>;
"line-offset-transition"?: TransitionSpecification;
"line-opacity"?: DataDrivenPropertyValueSpecification<number>;
"line-opacity-transition"?: TransitionSpecification;
"line-pattern"?: DataDrivenPropertyValueSpecification<string>;
"line-pattern-transition"?: TransitionSpecification;
"line-translate"?: PropertyValueSpecification<[number, number]>;
"line-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"line-translate-transition"?: TransitionSpecification;
"line-width"?: DataDrivenPropertyValueSpecification<number>;
"line-width-transition"?: TransitionSpecification;
}Optionalline-blur?: DataDrivenPropertyValueSpecification<number>Blur applied to the line, in pixels.
Optionalline-blur-transition?: TransitionSpecificationOptionalline-color?: DataDrivenPropertyValueSpecification<string>The color with which the line will be drawn.
Optionalline-color-transition?: TransitionSpecificationOptionalline-dasharray?: DataDrivenPropertyValueSpecification<number[]>Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. GeoJSON sources with
lineMetrics: truespecified won't render dashed lines to the expected scale. Zoom-dependent expressions will be evaluated only at integer zoom levels. The only way to create an array value is using["literal", [...]]; arrays cannot be read from or derived from feature properties.Optionalline-dasharray-transition?: TransitionSpecificationOptionalline-gap-width?: DataDrivenPropertyValueSpecification<number>Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
Optionalline-gap-width-transition?: TransitionSpecificationOptionalline-gradient?: ExpressionSpecificationDefines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify
"lineMetrics": true.Optionalline-layer-opacity?: PropertyValueSpecification<number>Opacity applied to the layer as a whole. Unlike
line-opacityand alpha values inline-color, which are applied per feature and accumulate where lines overlap,line-layer-opacityis applied once so overlapping lines appear as a single surface at the given opacity. When bothline-opacityandline-layer-opacityare set, the per-feature, overlap accumulation is preserved, then layer-opacity composites the result. This property affects only the layer it is set on and cannot be used to composite multiple layers together or control how this layer blends with layers above or below it.Optionalline-layer-opacity-transition?: TransitionSpecificationOptionalline-offset?: DataDrivenPropertyValueSpecification<number>The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
Optionalline-offset-transition?: TransitionSpecificationOptionalline-opacity?: DataDrivenPropertyValueSpecification<number>The opacity at which the line will be drawn.
Optionalline-opacity-transition?: TransitionSpecificationOptionalline-pattern?: DataDrivenPropertyValueSpecification<string>Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Optionalline-pattern-transition?: TransitionSpecificationOptionalline-translate?: PropertyValueSpecification<[number, number]>The geometry's offset. Values are
[x, y]where negatives indicate left and up, respectively.Optionalline-translate-anchor?: PropertyValueSpecification<"map" | "viewport">Controls the frame of reference for
line-translate.Optionalline-translate-transition?: TransitionSpecificationOptionalline-width?: DataDrivenPropertyValueSpecification<number>Stroke thickness.
Optionalline-width-transition?: TransitionSpecification
- undefined
Whether or not the fill should be antialiased.