Class: QgsSymbolLayerUtils¶
- class qgis.core.QgsSymbolLayerUtils¶
- class qgis.core.QgsSymbolLayerUtils(QgsSymbolLayerUtils) None
Bases:
sip.wrapper
Methods
Appends a polyline
line
to an existingtarget
polyline.Checks if the properties contain scaleMinDenom and scaleMaxDenom, if available, they are added into the SE Rule element
Blurs an image in place, e.g.
- param symbols
Attempts to parse mime data as a color
Attempts to parse mime data as a list of named colors
Creates mime data from a list of named colors
Returns an icon preview for a color ramp.
Returns a pixmap preview for a color ramp.
Saves a color ramp to a QVariantMap, wrapped in a QVariant.
Creates mime data from a color.
Returns a friendly display name for a color
- param element
Creates a SE 1.1 anchor point element as a child of the specified element
- param doc
Creates a OGC Expression element based on the provided function expression
- param element
- param doc
- param doc
- param element
- param element
- param doc
- param doc
- param doc
- param doc
- param element
- param doc
Decodes a
value
representing an arrow head type.Decodes a
value
representing an arrow type.- param s
- param str
- param str
- param str
- param str
- param str
- param str
Decodes a QSizeF from a string.
- param s
- param str
Decodes a QSizeF from a string.
- param str
- param str
- param str
- param str
- param str
- param str
- param s
Decodes a SLD unit of measure string to a render unit.
- param element
- param painter
Draws a vertex symbol at (painter) coordinates x, y.
- param style
- param color
- param mapUnitScale
- param style
- param style
- param style
Encodes a QPointF to a string.
- param v
- param scaleMethod
Encodes a QSizeF to a string.
- param alpha
- param style
- param style
- param weight
- param style
- param style
- param v
Encodes a render unit into an SLD unit of measure string.
Returns the maximum estimated bleed for the symbol
- param element
- param doc
- param element
- param doc
Returns a field name if the whole expression is just a name of the field .
Returns a new valid expression instance for given field or expression string.
- param element
- param doc
- param element
- param element
- param element
Encodes a reference to a parametric SVG into a path with parameters according to the SVG Parameters spec
- param element
- param element
- param element
Imports colors from a gpl GIMP palette file
Returns
True
if the angle formed by the linep1
-p2
-p3
forms a "sharp" corner.- param doc
- param element
Returns a list of all available svg files
Returns a list of svg files at the specified directory
Creates a color ramp from the settings encoded in an XML element
Attempts to load a symbol from a DOM element
Reads and returns symbol layer from XML.
Reads a collection of symbols from XML and returns them in a map.
Merges the local scale limits, if any, with the ones already in the map, if any
Multiplies opacity of image pixel values with a (global) transparency value.
- param element
- param element
- param element
- param element
- param element
- param element
- param element
Create ogr feature style string for brush
Create ogr feature style string for pen
- param element
- param element
Encodes a reference to a parametric SVG into SLD, as a succession of parametric SVG using URL parameters, a fallback SVG without parameters, and a final fallback as a mark with the right colors and stroke for systems that cannot do SVG at all
Attempts to parse a string as a color using a variety of common formats, including hex codes, rgb and rgba strings.
Attempts to parse a string as a list of colors using a variety of common formats, including hex codes, rgb and rgba strings.
Attempts to parse a string as a color using a variety of common formats, including hex codes, rgb and rgba, hsl and hsla strings.
- param element
Calculate whether a point is within of a QPolygonF
Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point
Calculate the centroid point of a QPolygonF
Calculate a point on the surface of a QPolygonF
Returns the substring of a
polyline
which starts atstartOffset
from the beginning of the line and ends atendOffset
from the start of the line.Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value
Computes a sequence of about 'classes' equally spaced round values which cover the range of values from 'minimum' to 'maximum'.
Rescales the given array based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point
Rescales the given point based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point
Rescales the given size based on the uomScale found in the props, if any is found, otherwise returns the value un-modified
Creates a new symbol with size restricted to min/max size if original size is out of min/max range
- param element
Encodes a color ramp's settings to an XML element
Exports colors to a gpl GIMP palette file
- param props
Writes a symbol definition to XML
Writes a collection of symbols to XML with specified tagName for the top-level element
Returns the size scaled in pixels according to the uom attribute.
Sorts the passed list in requested order
Determines an SVG symbol's path from its
name
.Determines an SVG symbol's name from its
path
.Attempts to parse
mime
data as a symbol.Draws a symbol layer preview to an icon.
Draws a symbol layer preview to a QPicture
Returns an icon preview for a color ramp.
Returns a pixmap preview for a color ramp.
Returns a string representing the symbol.
Creates new mime data from a
symbol
.Converts a
value
to a point.Converts a
value
to a size.Converts a set of symbol layer id to a set of pointers to actual symbol layers carried by the feature renderer.
- param doc
Attributes
- Cross = 1¶
- NoMarker = 2¶
- SemiTransparentCircle = 0¶
- class VertexMarkerType¶
Bases:
int
- appendPolyline(target: QPolygonF, line: QPolygonF)¶
Appends a polyline
line
to an existingtarget
polyline.Any duplicate points at the start
line
which match the end point fromtarget
will be skipped.New in version 3.16.
- Parameters
target (QPolygonF) –
line (QPolygonF) –
- applyScaleDependency(doc: QDomDocument, ruleElem: QDomElement, props: Dict[str, str])¶
Checks if the properties contain scaleMinDenom and scaleMaxDenom, if available, they are added into the SE Rule element
New in version 3.0.
- Parameters
doc (QDomDocument) –
ruleElem (QDomElement) –
props (Dict[str) –
- blurImageInPlace(image: QImage, rect: QRect, radius: int, alphaOnly: bool)¶
Blurs an image in place, e.g. creating Qt-independent drop shadows
- Parameters
image (QImage) –
rect (QRect) –
radius (int) –
alphaOnly (bool) –
- clearSymbolMap(symbols: object)¶
- Parameters
symbols (object) –
- colorFromMimeData(data: QMimeData) Tuple[QColor, bool] ¶
Attempts to parse mime data as a color
- Parameters
data (QMimeData) – mime data to parse
- Return type
Tuple[QColor, bool]
- Returns
valid color if mimedata could be interpreted as a color, otherwise an invalid color
hasAlpha: will be set to
True
if mime data was interpreted as a color containing an explicit alpha value
New in version 2.5.
- colorListFromMimeData(data: QMimeData) List[Tuple[QColor, str]] ¶
Attempts to parse mime data as a list of named colors
- Parameters
data (QMimeData) – mime data to parse
- Return type
List[Tuple[QColor, str]]
- Returns
list of parsed colors
New in version 2.5.
- colorListToMimeData(colorList: Iterable[Tuple[Union[QColor, Qt.GlobalColor], str]], allFormats: bool = True) QMimeData ¶
Creates mime data from a list of named colors
- Parameters
colorList (Iterable[Tuple[Union[QColor) – list of named colors
allFormats (bool = True) – set to
True
to include additional mime formats, include text/plain and application/x-color
- Return type
QMimeData
- Returns
mime data containing encoded colors
New in version 2.5.
- colorRampPreviewIcon(ramp: QgsColorRamp, size: QSize, padding: int = 0) QIcon ¶
Returns an icon preview for a color ramp.
- Parameters
ramp (QgsColorRamp) – color ramp
size (QSize) – target icon size
padding (int = 0) – space between icon edge and color ramp
See also
- Return type
QIcon
- colorRampPreviewPixmap(ramp: QgsColorRamp, size: QSize, padding: int = 0) QPixmap ¶
Returns a pixmap preview for a color ramp.
- Parameters
ramp (QgsColorRamp) – color ramp
size (QSize) – target pixmap size
padding (int = 0) – space between icon edge and color ramp
See also
- Return type
QPixmap
- colorRampToVariant(name: str, ramp: QgsColorRamp) Any ¶
Saves a color ramp to a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.writeVariant to save it to an XML document.
See also
- Parameters
name (str) –
ramp (QgsColorRamp) –
- Return type
Any
- colorToMimeData(color: Union[QColor, Qt.GlobalColor]) QMimeData ¶
Creates mime data from a color. Sets both the mime data’s color data, and the mime data’s text with the color’s hex code.
- Parameters
color (Union[QColor) – color to encode as mime data
See also
New in version 2.5.
- Return type
QMimeData
- colorToName(color: Union[QColor, Qt.GlobalColor]) str ¶
Returns a friendly display name for a color
- Parameters
color (Union[QColor) – source color
- Return type
str
- Returns
display name for color
New in version 2.5.
- convertPolygonSymbolizerToPointMarker(element: QDomElement, layerList: Iterable[QgsSymbolLayer]) bool ¶
- Parameters
element (QDomElement) –
layerList (Iterable[QgsSymbolLayer]) –
- Return type
bool
- createAnchorPointElement(doc: QDomDocument, element: QDomElement, anchor: Union[QPointF, QPoint])¶
Creates a SE 1.1 anchor point element as a child of the specified element
- Parameters
doc (QDomDocument) – The document
element (QDomElement) – The parent element
anchor (Union[QPointF) – An anchor specification, with values between 0 and 1
- createDisplacementElement(doc: QDomDocument, element: QDomElement, offset: Union[QPointF, QPoint])¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
offset (Union[QPointF) –
- createExpressionElement(doc: QDomDocument, element: QDomElement, function: str) bool ¶
Creates a OGC Expression element based on the provided function expression
- Parameters
doc (QDomDocument) – The document owning the element
element (QDomElement) – The element parent
function (str) – The expression to be encoded
- Return type
bool
- createFillLayerFromSld(element: QDomElement) QgsSymbolLayer ¶
- Parameters
element (QDomElement) –
- Return type
- createFunctionElement(doc: QDomDocument, element: QDomElement, function: str) bool ¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
function (str) –
- Return type
bool
- createGeometryElement(doc: QDomDocument, element: QDomElement, geomFunc: str)¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
geomFunc (str) –
- createLineLayerFromSld(element: QDomElement) QgsSymbolLayer ¶
- Parameters
element (QDomElement) –
- Return type
- createMarkerLayerFromSld(element: QDomElement) QgsSymbolLayer ¶
- Parameters
element (QDomElement) –
- Return type
- createOnlineResourceElement(doc: QDomDocument, element: QDomElement, path: str, format: str)¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
path (str) –
format (str) –
- createOpacityElement(doc: QDomDocument, element: QDomElement, alphaFunc: str)¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
alphaFunc (str) –
- createRotationElement(doc: QDomDocument, element: QDomElement, rotationFunc: str)¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
rotationFunc (str) –
- createSvgParameterElement(doc: QDomDocument, name: str, value: str) QDomElement ¶
- Parameters
doc (QDomDocument) –
name (str) –
value (str) –
- Return type
QDomElement
- createSymbolLayerListFromSld(element: QDomElement, geomType: QgsWkbTypes.GeometryType, layers: Iterable[QgsSymbolLayer]) bool ¶
- Parameters
element (QDomElement) –
geomType (QgsWkbTypes.GeometryType) –
layers (Iterable[QgsSymbolLayer]) –
- Return type
bool
- createVendorOptionElement(doc: QDomDocument, name: str, value: str) QDomElement ¶
- Parameters
doc (QDomDocument) –
name (str) –
value (str) –
- Return type
QDomElement
- decodeArrowHeadType(value: Any) Tuple[QgsArrowSymbolLayer.HeadType, bool] ¶
Decodes a
value
representing an arrow head type.New in version 3.2.
- Parameters
value (Any) –
- Return type
Tuple[QgsArrowSymbolLayer.HeadType, bool]
- decodeArrowType(value: Any) Tuple[QgsArrowSymbolLayer.ArrowType, bool] ¶
Decodes a
value
representing an arrow type.New in version 3.2.
- Parameters
value (Any) –
- Return type
Tuple[QgsArrowSymbolLayer.ArrowType, bool]
- decodeBlendMode(s: str) QPainter.CompositionMode ¶
- Parameters
s (str) –
- Return type
QPainter.CompositionMode
- decodeBrushStyle(str: str) Qt.BrushStyle ¶
- Parameters
str (str) –
- Return type
Qt.BrushStyle
- decodeColor(str: str) QColor ¶
- Parameters
str (str) –
- Return type
QColor
- decodeMapUnitScale(str: str) QgsMapUnitScale ¶
- Parameters
str (str) –
- Return type
- decodePenCapStyle(str: str) Qt.PenCapStyle ¶
- Parameters
str (str) –
- Return type
Qt.PenCapStyle
- decodePenJoinStyle(str: str) Qt.PenJoinStyle ¶
- Parameters
str (str) –
- Return type
Qt.PenJoinStyle
- decodePenStyle(str: str) Qt.PenStyle ¶
- Parameters
str (str) –
- Return type
Qt.PenStyle
- decodePoint(string: str) QPointF ¶
Decodes a QSizeF from a string.
See also
See also
- Parameters
string (str) –
- Return type
QPointF
- decodeRealVector(s: str) List[float] ¶
- Parameters
s (str) –
- Return type
List[float]
- decodeScaleMethod(str: str) QgsSymbol.ScaleMethod ¶
- Parameters
str (str) –
- Return type
- decodeSize(string: str) QSizeF ¶
Decodes a QSizeF from a string.
See also
See also
New in version 3.0.
- Parameters
string (str) –
- Return type
QSizeF
- decodeSldAlpha(str: str) int ¶
- Parameters
str (str) –
- Return type
int
- decodeSldBrushStyle(str: str) Qt.BrushStyle ¶
- Parameters
str (str) –
- Return type
Qt.BrushStyle
- decodeSldFontStyle(str: str) QFont.Style ¶
- Parameters
str (str) –
- Return type
QFont.Style
- decodeSldFontWeight(str: str) int ¶
- Parameters
str (str) –
- Return type
int
- decodeSldLineCapStyle(str: str) Qt.PenCapStyle ¶
- Parameters
str (str) –
- Return type
Qt.PenCapStyle
- decodeSldLineJoinStyle(str: str) Qt.PenJoinStyle ¶
- Parameters
str (str) –
- Return type
Qt.PenJoinStyle
- decodeSldRealVector(s: str) List[float] ¶
- Parameters
s (str) –
- Return type
List[float]
- decodeSldUom(str: str) Tuple[QgsUnitTypes.RenderUnit, float] ¶
Decodes a SLD unit of measure string to a render unit.
- Parameters
str (str) – string to decode
scaleFactor – if specified, will be set to scale factor for unit of measure
- Return type
Tuple[QgsUnitTypes.RenderUnit, float]
- Returns
matching render unit
See also
- displacementFromSldElement(element: QDomElement, offset: Union[QPointF, QPoint]) bool ¶
- Parameters
element (QDomElement) –
offset (Union[QPointF) –
- Return type
bool
- drawStippledBackground(painter: QPainter, rect: QRect)¶
- Parameters
painter (QPainter) –
rect (QRect) –
- drawVertexMarker(x: float, y: float, p: QPainter, type: QgsSymbolLayerUtils.VertexMarkerType, markerSize: int)¶
Draws a vertex symbol at (painter) coordinates x, y. (Useful to assist vertex editing.)
New in version 3.4.5.
- Parameters
x (float) –
y (float) –
p (QPainter) –
type (QgsSymbolLayerUtils.VertexMarkerType) –
markerSize (int) –
- encodeBrushStyle(style: Qt.BrushStyle) str ¶
- Parameters
style (Qt.BrushStyle) –
- Return type
str
- encodeColor(color: Union[QColor, Qt.GlobalColor]) str ¶
- Parameters
color (Union[QColor) –
- Return type
str
- encodeMapUnitScale(mapUnitScale: QgsMapUnitScale) str ¶
- Parameters
mapUnitScale (QgsMapUnitScale) –
- Return type
str
- encodePenCapStyle(style: Qt.PenCapStyle) str ¶
- Parameters
style (Qt.PenCapStyle) –
- Return type
str
- encodePenJoinStyle(style: Qt.PenJoinStyle) str ¶
- Parameters
style (Qt.PenJoinStyle) –
- Return type
str
- encodePenStyle(style: Qt.PenStyle) str ¶
- Parameters
style (Qt.PenStyle) –
- Return type
str
- encodePoint(point: Union[QPointF, QPoint]) str ¶
Encodes a QPointF to a string.
See also
See also
- Parameters
point (Union[QPointF) –
- Return type
str
- encodeRealVector(v: Iterable[float]) str ¶
- Parameters
v (Iterable[float]) –
- Return type
str
- encodeScaleMethod(scaleMethod: QgsSymbol.ScaleMethod) str ¶
- Parameters
scaleMethod (QgsSymbol.ScaleMethod) –
- Return type
str
- encodeSize(size: QSizeF) str ¶
Encodes a QSizeF to a string.
See also
See also
New in version 3.0.
- Parameters
size (QSizeF) –
- Return type
str
- encodeSldAlpha(alpha: int) str ¶
- Parameters
alpha (int) –
- Return type
str
- encodeSldBrushStyle(style: Qt.BrushStyle) str ¶
- Parameters
style (Qt.BrushStyle) –
- Return type
str
- encodeSldFontStyle(style: QFont.Style) str ¶
- Parameters
style (QFont.Style) –
- Return type
str
- encodeSldFontWeight(weight: int) str ¶
- Parameters
weight (int) –
- Return type
str
- encodeSldLineCapStyle(style: Qt.PenCapStyle) str ¶
- Parameters
style (Qt.PenCapStyle) –
- Return type
str
- encodeSldLineJoinStyle(style: Qt.PenJoinStyle) str ¶
- Parameters
style (Qt.PenJoinStyle) –
- Return type
str
- encodeSldRealVector(v: Iterable[float]) str ¶
- Parameters
v (Iterable[float]) –
- Return type
str
- encodeSldUom(unit: QgsUnitTypes.RenderUnit) Tuple[str, float] ¶
Encodes a render unit into an SLD unit of measure string.
- Parameters
unit (QgsUnitTypes.RenderUnit) – unit to encode
scaleFactor – if specified, will be set to scale factor for unit of measure
- Return type
Tuple[str, float]
- Returns
encoded string
See also
- estimateMaxSymbolBleed(symbol: QgsSymbol, context: QgsRenderContext) float ¶
Returns the maximum estimated bleed for the symbol
- Parameters
symbol (QgsSymbol) –
context (QgsRenderContext) –
- Return type
float
- externalGraphicFromSld(element: QDomElement, path: str, mime: str, color: Union[QColor, Qt.GlobalColor]) Tuple[bool, float] ¶
- Parameters
element (QDomElement) –
path (str) –
mime (str) –
color (Union[QColor) –
- Return type
Tuple[bool, float]
- externalGraphicToSld(doc: QDomDocument, element: QDomElement, path: str, mime: str, color: Union[QColor, Qt.GlobalColor], size: float = - 1)¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
path (str) –
mime (str) –
color (Union[QColor) –
size (float = -1) –
- externalMarkerFromSld(element: QDomElement, path: str, format: str, color: Union[QColor, Qt.GlobalColor]) Tuple[bool, int, float] ¶
- Parameters
element (QDomElement) –
path (str) –
format (str) –
color (Union[QColor) –
- Return type
Tuple[bool, int, float]
- externalMarkerToSld(doc: QDomDocument, element: QDomElement, path: str, format: str, color: Union[QColor, Qt.GlobalColor] = QColor(), size: float = - 1) int ¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
path (str) –
format (str) –
color (Union[QColor) –
size (float = -1) –
- Return type
int
- fieldOrExpressionFromExpression(expression: QgsExpression) str ¶
Returns a field name if the whole expression is just a name of the field . Returns full expression string if the expression is more complex than just one field. Using just expression->:py:func:~QgsSymbolLayerUtils.expression method may return quoted field name, but that is not wanted for saving (due to backward compatibility) or display in GUI.
New in version 2.2.
- Parameters
expression (QgsExpression) –
- Return type
str
- fieldOrExpressionToExpression(fieldOrExpression: str) QgsExpression ¶
Returns a new valid expression instance for given field or expression string. If the input is not a valid expression, it is assumed that it is a field name and gets properly quoted. If the string is empty, returns
None
. This is useful when accepting input which could be either a non-quoted field name or expression.New in version 2.2.
- Parameters
fieldOrExpression (str) –
- Return type
- fillFromSld(element: QDomElement, color: Union[QColor, Qt.GlobalColor]) Tuple[bool, Qt.BrushStyle] ¶
- Parameters
element (QDomElement) –
color (Union[QColor) –
- Return type
Tuple[bool, Qt.BrushStyle]
- fillToSld(doc: QDomDocument, element: QDomElement, brushStyle: Qt.BrushStyle, color: Union[QColor, Qt.GlobalColor] = QColor())¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
brushStyle (Qt.BrushStyle) –
color (Union[QColor) –
- functionFromSldElement(element: QDomElement, function: str) bool ¶
- Parameters
element (QDomElement) –
function (str) –
- Return type
bool
- geometryFromSldElement(element: QDomElement, geomFunc: str) bool ¶
- Parameters
element (QDomElement) –
geomFunc (str) –
- Return type
bool
- getSvgParameterList(element: QDomElement) Dict[str, str] ¶
- Parameters
element (QDomElement) –
- Return type
Dict[str, str]
- getSvgParametricPath(basePath: str, fillColor: Union[QColor, Qt.GlobalColor], strokeColor: Union[QColor, Qt.GlobalColor], strokeWidth: float) str ¶
Encodes a reference to a parametric SVG into a path with parameters according to the SVG Parameters spec
New in version 3.0.
- Parameters
basePath (str) –
fillColor (Union[QColor) –
strokeColor (Union[QColor) –
strokeWidth (float) –
- Return type
str
- getVendorOptionList(element: QDomElement) Dict[str, str] ¶
- Parameters
element (QDomElement) –
- Return type
Dict[str, str]
- hasExternalGraphic(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- hasWellKnownMark(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- importColorsFromGpl(file: QFile, name: str) Tuple[List[Tuple[QColor, str]], bool] ¶
Imports colors from a gpl GIMP palette file
- Parameters
file (QFile) – source gpl file
ok – will be
True
if file was successfully readname (str) – will be set to palette name from gpl file, if present
- Return type
Tuple[List[Tuple[QColor, str]], bool]
- Returns
list of imported colors
See also
- isSharpCorner(p1: Union[QPointF, QPoint], p2: Union[QPointF, QPoint], p3: Union[QPointF, QPoint]) bool ¶
Returns
True
if the angle formed by the linep1
-p2
-p3
forms a “sharp” corner.Sharp corners form an angle which exceeds a 45 degree threshold.
New in version 3.16.
- Parameters
p1 (Union[QPointF) –
p2 (Union[QPointF) –
p3 (Union[QPointF) –
- Return type
bool
- labelTextToSld(doc: QDomDocument, element: QDomElement, label: str, font: QFont, color: Union[QColor, Qt.GlobalColor] = QColor(), size: float = - 1)¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
label (str) –
font (QFont) –
color (Union[QColor) –
size (float = -1) –
- lineFromSld(element: QDomElement, color: Union[QColor, Qt.GlobalColor], customDashPattern: Iterable[float] = []) Tuple[bool, Qt.PenStyle, float, Qt.PenJoinStyle, Qt.PenCapStyle, float] ¶
- Parameters
element (QDomElement) –
color (Union[QColor) –
customDashPattern (Iterable[float] = []) –
- Return type
Tuple[bool, Qt.PenStyle, float, Qt.PenJoinStyle, Qt.PenCapStyle, float]
- listSvgFiles() List[str] ¶
Returns a list of all available svg files
- Return type
List[str]
- listSvgFilesAt(directory: str) List[str] ¶
Returns a list of svg files at the specified directory
- Parameters
directory (str) –
- Return type
List[str]
- loadColorRamp(element: QDomElement) QgsColorRamp ¶
Creates a color ramp from the settings encoded in an XML element
- Parameters
element (QDomElement) – DOM element
- Return type
- Returns
new color ramp. Caller takes responsibility for deleting the returned value.
See also
loadColorRamp(value: Any) -> QgsColorRamp Load a color ramp from a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.readVariant to load it from an XML document.
See also
- loadSymbol(element: QDomElement, context: QgsReadWriteContext) QgsSymbol ¶
Attempts to load a symbol from a DOM element
- Parameters
element (QDomElement) – DOM element representing symbol
context (QgsReadWriteContext) – object to transform relative to absolute paths
- Return type
- Returns
decoded symbol, if possible
- loadSymbolLayer(element: QDomElement, context: QgsReadWriteContext) QgsSymbolLayer ¶
Reads and returns symbol layer from XML. Caller is responsible for deleting the returned object
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type
- loadSymbols(element: QDomElement, context: QgsReadWriteContext) object ¶
Reads a collection of symbols from XML and returns them in a map. Caller is responsible for deleting returned symbols.
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type
object
- mergeScaleDependencies(mScaleMinDenom: float, mScaleMaxDenom: float, props: Dict[str, str])¶
Merges the local scale limits, if any, with the ones already in the map, if any
New in version 3.0.
- Parameters
mScaleMinDenom (float) –
mScaleMaxDenom (float) –
props (Dict[str) –
- multiplyImageOpacity(image: QImage, opacity: float)¶
Multiplies opacity of image pixel values with a (global) transparency value.
- Parameters
image (QImage) –
opacity (float) –
- needEllipseMarker(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- needFontMarker(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- needLinePatternFill(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- needMarkerLine(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- needPointPatternFill(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- needSvgFill(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- needSvgMarker(element: QDomElement) bool ¶
- Parameters
element (QDomElement) –
- Return type
bool
- ogrFeatureStyleBrush(fillColr: Union[QColor, Qt.GlobalColor]) str ¶
Create ogr feature style string for brush
- Parameters
fillColr (Union[QColor) – fill color
- Return type
str
- ogrFeatureStylePen(width: float, mmScaleFactor: float, mapUnitsScaleFactor: float, c: Union[QColor, Qt.GlobalColor], joinStyle: Qt.PenJoinStyle = Qt.MiterJoin, capStyle: Qt.PenCapStyle = Qt.FlatCap, offset: float = 0, dashPattern: Iterable[float] = []) str ¶
Create ogr feature style string for pen
- Parameters
width (float) –
mmScaleFactor (float) –
mapUnitsScaleFactor (float) –
c (Union[QColor) –
joinStyle (Qt.PenJoinStyle = Qt.MiterJoin) –
capStyle (Qt.PenCapStyle = Qt.FlatCap) –
offset (float = 0) –
dashPattern (Iterable[float] = []) –
- Return type
str
- onlineResourceFromSldElement(element: QDomElement, path: str, format: str) bool ¶
- Parameters
element (QDomElement) –
path (str) –
format (str) –
- Return type
bool
- opacityFromSldElement(element: QDomElement, alphaFunc: str) bool ¶
- Parameters
element (QDomElement) –
alphaFunc (str) –
- Return type
bool
- parametricSvgToSld(doc: QDomDocument, graphicElem: QDomElement, path: str, fillColor: Union[QColor, Qt.GlobalColor], size: float, strokeColor: Union[QColor, Qt.GlobalColor], strokeWidth: float)¶
Encodes a reference to a parametric SVG into SLD, as a succession of parametric SVG using URL parameters, a fallback SVG without parameters, and a final fallback as a mark with the right colors and stroke for systems that cannot do SVG at all
New in version 3.0.
- Parameters
doc (QDomDocument) –
graphicElem (QDomElement) –
path (str) –
fillColor (Union[QColor) –
size (float) –
strokeColor (Union[QColor) –
strokeWidth (float) –
- parseColor(colorStr: str, strictEval: bool = False) QColor ¶
Attempts to parse a string as a color using a variety of common formats, including hex codes, rgb and rgba strings.
- Parameters
colorStr (str) – string representing the color
strictEval (bool = False) – set to
True
for stricter color parsing rules
- Return type
QColor
- Returns
parsed color
New in version 2.3.
- parseColorList(colorStr: str) List[QColor] ¶
Attempts to parse a string as a list of colors using a variety of common formats, including hex codes, rgb and rgba strings.
- Parameters
colorStr (str) – string representing the color list
- Return type
List[QColor]
- Returns
list of parsed colors
New in version 2.5.
- parseColorWithAlpha(colorStr: str, strictEval: bool = False) Tuple[QColor, bool] ¶
Attempts to parse a string as a color using a variety of common formats, including hex codes, rgb and rgba, hsl and hsla strings.
- Parameters
colorStr (str) – string representing the color
containsAlpha – if colorStr contains an explicit alpha value then containsAlpha will be set to
True
strictEval (bool = False) – set to
True
for stricter color parsing rules
- Return type
Tuple[QColor, bool]
- Returns
parsed color
New in version 2.3.
- parseProperties(element: QDomElement) Dict[str, str] ¶
- Parameters
element (QDomElement) –
- Return type
Dict[str, str]
- pointInPolygon(points: QPolygonF, point: Union[QPointF, QPoint]) bool ¶
Calculate whether a point is within of a QPolygonF
- Parameters
points (QPolygonF) –
point (Union[QPointF) –
- Return type
bool
- pointOnLineWithDistance(startPoint: Union[QPointF, QPoint], directionPoint: Union[QPointF, QPoint], distance: float) QPointF ¶
Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point
- Parameters
startPoint (Union[QPointF) –
directionPoint (Union[QPointF) –
distance (float) –
- Return type
QPointF
- polygonCentroid(points: QPolygonF) QPointF ¶
Calculate the centroid point of a QPolygonF
- Parameters
points (QPolygonF) –
- Return type
QPointF
- polygonPointOnSurface(points: QPolygonF, rings: Iterable[QPolygonF] = []) QPointF ¶
Calculate a point on the surface of a QPolygonF
- Parameters
points (QPolygonF) –
rings (Iterable[QPolygonF] = []) –
- Return type
QPointF
- polylineSubstring(polyline: QPolygonF, startOffset: float, endOffset: float) QPolygonF ¶
Returns the substring of a
polyline
which starts atstartOffset
from the beginning of the line and ends atendOffset
from the start of the line.If
startOffset
is less than 0, then the start point will be calculated by subtracting that distance from the end of the line. Similarly, ifendOffset
is less than zero then the end point will be subtracted from the end of the line.May return an empty linestring if the substring is zero length.
New in version 3.16.
- Parameters
polyline (QPolygonF) –
startOffset (float) –
endOffset (float) –
- Return type
QPolygonF
- premultiplyColor(rgb: Union[QColor, Qt.GlobalColor], alpha: int)¶
Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value
New in version 2.3.
- Parameters
rgb (Union[QColor) –
alpha (int) –
- prettyBreaks(minimum: float, maximum: float, classes: int) List[float] ¶
Computes a sequence of about ‘classes’ equally spaced round values which cover the range of values from ‘minimum’ to ‘maximum’. The values are chosen so that they are 1, 2 or 5 times a power of 10.
New in version 2.10.
- Parameters
minimum (float) –
maximum (float) –
classes (int) –
- Return type
List[float]
- rescaleArrayUom(array: Iterable[float], unit: QgsUnitTypes.RenderUnit, props: Dict[str, str]) List[float] ¶
Rescales the given array based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point
New in version 3.0.
- Parameters
array (Iterable[float]) –
unit (QgsUnitTypes.RenderUnit) –
props (Dict[str) –
- Return type
List[float]
- rescalePointUom(point: Union[QPointF, QPoint], unit: QgsUnitTypes.RenderUnit, props: Dict[str, str]) QPointF ¶
Rescales the given point based on the uomScale found in the props, if any is found, otherwise returns a copy of the original point
New in version 3.0.
- Parameters
point (Union[QPointF) –
unit (QgsUnitTypes.RenderUnit) –
props (Dict[str) –
- Return type
QPointF
- rescaleUom(size: float, unit: QgsUnitTypes.RenderUnit, props: Dict[str, str]) float ¶
Rescales the given size based on the uomScale found in the props, if any is found, otherwise returns the value un-modified
New in version 3.0.
- Parameters
size (float) –
unit (QgsUnitTypes.RenderUnit) –
props (Dict[str) –
- Return type
float
- restrictedSizeSymbol(s: QgsSymbol, minSize: float, maxSize: float, context: QgsRenderContext) Tuple[QgsSymbol, float, float] ¶
Creates a new symbol with size restricted to min/max size if original size is out of min/max range
- Parameters
s (QgsSymbol) – the original symbol
minSize (float) – the minimum size in mm
maxSize (float) – the maximum size in mm
context (QgsRenderContext) – the render context
width – expected width, can be changed by the function
height – expected height, can be changed by this function
- Return type
Tuple[
QgsSymbol
, float, float]- Returns
0 if size is within minSize/maxSize range. New symbol if size was out of min/max range. Caller takes ownership
- rotationFromSldElement(element: QDomElement, rotationFunc: str) bool ¶
- Parameters
element (QDomElement) –
rotationFunc (str) –
- Return type
bool
- saveColorRamp(name: str, ramp: QgsColorRamp, doc: QDomDocument) QDomElement ¶
Encodes a color ramp’s settings to an XML element
- Parameters
name (str) – name of ramp
ramp (QgsColorRamp) – color ramp to save
doc (QDomDocument) – XML document
- Return type
QDomElement
- Returns
DOM element representing state of color ramp
See also
- saveColorsToGpl(file: QFile, paletteName: str, colors: Iterable[Tuple[Union[QColor, Qt.GlobalColor], str]]) bool ¶
Exports colors to a gpl GIMP palette file
- Parameters
file (QFile) – destination file
paletteName (str) – name of palette, which is stored in gpl file
colors (Iterable[Tuple[Union[QColor) – colors to export
- Return type
bool
- Returns
True
if export was successful
See also
- saveProperties(props: Dict[str, str], doc: QDomDocument, element: QDomElement)¶
- Parameters
props (Dict[str) –
doc (QDomDocument) –
element (QDomElement) –
- saveSymbol(symbolName: str, symbol: QgsSymbol, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Writes a symbol definition to XML
- Parameters
symbolName (str) –
symbol (QgsSymbol) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement
- saveSymbols(symbols: object, tagName: str, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Writes a collection of symbols to XML with specified tagName for the top-level element
- Parameters
symbols (object) –
tagName (str) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement
- sizeInPixelsFromSldUom(uom: str, size: float) float ¶
Returns the size scaled in pixels according to the uom attribute.
- Parameters
uom (str) – The uom attribute from SLD 1.1 version
size (float) – The original size
- Return type
float
- Returns
the size in pixels
New in version 3.0.
- sortVariantList(list: Iterable[Any], order: Qt.SortOrder)¶
Sorts the passed list in requested order
- Parameters
list (Iterable[Any]) –
order (Qt.SortOrder) –
- svgSymbolNameToPath(name: str, pathResolver: QgsPathResolver) str ¶
Determines an SVG symbol’s path from its
name
. Ifname
is not an absolute path the file is scanned for in the SVG paths specified in settings svg/searchPathsForSVG.See also
- Parameters
name (str) –
pathResolver (QgsPathResolver) –
- Return type
str
- svgSymbolPathToName(path: str, pathResolver: QgsPathResolver) str ¶
Determines an SVG symbol’s name from its
path
.See also
- Parameters
path (str) –
pathResolver (QgsPathResolver) –
- Return type
str
- symbolFromMimeData(data: QMimeData) QgsSymbol ¶
Attempts to parse
mime
data as a symbol. A new symbol instance will be returned if the data was successfully converted to a symbol.See also
New in version 3.0.
- Parameters
data (QMimeData) –
- Return type
- symbolLayerPreviewIcon(layer: QgsSymbolLayer, u: QgsUnitTypes.RenderUnit, size: QSize, scale: QgsMapUnitScale = QgsMapUnitScale()) QIcon ¶
Draws a symbol layer preview to an icon.
- Parameters
layer (QgsSymbolLayer) – symbol layer to draw
u (QgsUnitTypes.RenderUnit) – size units
size (QSize) – target size of preview icon
scale (
QgsMapUnitScale
= QgsMapUnitScale()) – map unit scale for preview
- Return type
QIcon
- Returns
icon containing symbol layer preview
See also
- symbolLayerPreviewPicture(layer: QgsSymbolLayer, units: QgsUnitTypes.RenderUnit, size: QSize, scale: QgsMapUnitScale = QgsMapUnitScale()) QPicture ¶
Draws a symbol layer preview to a QPicture
- Parameters
layer (QgsSymbolLayer) – symbol layer to draw
units (QgsUnitTypes.RenderUnit) – size units
size (QSize) – target size of preview picture
scale (
QgsMapUnitScale
= QgsMapUnitScale()) – map unit scale for preview
- Return type
QPicture
- Returns
QPicture containing symbol layer preview
See also
New in version 2.9.
- symbolPreviewIcon(symbol: QgsSymbol, size: QSize, padding: int = 0, shape: QgsLegendPatchShape = None) QIcon ¶
Returns an icon preview for a color ramp.
- Parameters
symbol (QgsSymbol) – symbol
size (QSize) – target pixmap size
padding (int = 0) – space between icon edge and symbol
shape (
QgsLegendPatchShape
= None) – optional legend patch shape to use for rendering the preview icon
See also
- Return type
QIcon
- symbolPreviewPixmap(symbol: QgsSymbol, size: QSize, padding: int = 0, customContext: QgsRenderContext = None, selected: bool = False, expressionContext: QgsExpressionContext = None, shape: QgsLegendPatchShape = None) QPixmap ¶
Returns a pixmap preview for a color ramp.
- Parameters
symbol (QgsSymbol) – symbol
size (QSize) – target pixmap size
padding (int = 0) – space between icon edge and symbol
customContext (
QgsRenderContext
= None) – render context to use when rendering symbolselected (bool = False) – set to
True
to render the symbol in a selected stateexpressionContext (
QgsExpressionContext
= None) – optional custom expression contextshape (
QgsLegendPatchShape
= None) – optional legend patch shape to use for rendering the preview icon
Note
Parameter customContext added in QGIS 2.6
Note
Parameter selected added in QGIS 3.10
Note
Parameter expressionContext added in QGIS 3.10
Note
Parameter shape added in QGIS 3.14
See also
- Return type
QPixmap
- symbolProperties(symbol: QgsSymbol) str ¶
Returns a string representing the symbol. Can be used to test for equality between symbols.
New in version 2.12.
- Parameters
symbol (QgsSymbol) –
- Return type
str
- symbolToMimeData(symbol: QgsSymbol) QMimeData ¶
Creates new mime data from a
symbol
. This also sets the mime color data to match the symbol’s color, so that copied symbols can be paste in places where a color is expected.See also
New in version 3.0.
- Parameters
symbol (QgsSymbol) –
- Return type
QMimeData
- toPoint(value: Any) Tuple[QPointF, bool] ¶
Converts a
value
to a point.- Parameters
value (Any) – value to convert
- Return type
Tuple[QPointF, bool]
- Returns
converted point
ok: will be set to
True
if value was successfully converted
See also
See also
New in version 3.10.
- toSize(value: Any) Tuple[QSizeF, bool] ¶
Converts a
value
to a size.- Parameters
value (Any) – value to convert
- Return type
Tuple[QSizeF, bool]
- Returns
converted size
ok: will be set to
True
if value was successfully converted
See also
See also
New in version 3.10.
- toSymbolLayerPointers(renderer: QgsFeatureRenderer, symbolLayerIds: Iterable[QgsSymbolLayerId]) Set[QgsSymbolLayer] ¶
Converts a set of symbol layer id to a set of pointers to actual symbol layers carried by the feature renderer.
New in version 3.12.
- Parameters
renderer (QgsFeatureRenderer) –
symbolLayerIds (Iterable[QgsSymbolLayerId]) –
- Return type
Set[QgsSymbolLayer]
- wellKnownMarkerFromSld2(element: QDomElement, name: str, color: Union[QColor, Qt.GlobalColor], strokeColor: Union[QColor, Qt.GlobalColor]) Tuple[bool, Qt.PenStyle, float, float] ¶
Note
available in Python as wellKnownMarkerFromSld2
- Parameters
element (QDomElement) –
name (str) –
color (Union[QColor) –
strokeColor (Union[QColor) –
- Return type
Tuple[bool, Qt.PenStyle, float, float]
- wellKnownMarkerToSld(doc: QDomDocument, element: QDomElement, name: str, color: Union[QColor, Qt.GlobalColor], strokeColor: Union[QColor, Qt.GlobalColor], strokeStyle: Qt.PenStyle, strokeWidth: float = - 1, size: float = - 1)¶
- Parameters
doc (QDomDocument) –
element (QDomElement) –
name (str) –
color (Union[QColor) –
strokeColor (Union[QColor) –
strokeStyle (Qt.PenStyle) –
strokeWidth (float = -1) –
size (float = -1) –