Class: QgsStyle¶
- class qgis.core.QgsStyle¶
Bases:
PyQt5.QtCore.QObject
Constructor for QgsStyle.
Methods
Adds a color ramp to the style.
Adds an
entity
to the style, with the specifiedname
.Adds the specified symbol to favorites
Adds label
settings
with the specifiedname
to the style.Adds a legend patch
shape
with the specifiedname
to the style.Adds a new smartgroup to the database and returns the id.
Adds a symbol to style and takes symbol’s ownership
Adds a 3d
symbol
with the specifiedname
to the style.Adds a new tag and returns the tag’s id
Adds a text
format
with the specifiedname
to the style.Returns a list of the names of all existing entities of the specified
type
.Removes all contents of the style
Returns a new copy of the specified color ramp.
Returns count of color ramps
Returns a list of names of color ramps
Returns a const pointer to a symbol (doesn’t create new instance)
Returns the id in the style database for the given colorramp name returns 0 if not found
Creates an on-disk database
Creates a temporary memory database
Creates tables structure for new database
Returns the default legend patch shape for the given symbol
type
.Returns the default patch geometry for the given symbol
type
andsize
as a set of QPolygonF objects (parts and rings).Returns default application-wide style
Detags the symbol with the given list
Returns the id in the style database for the given
name
of the specified entitytype
.Returns last error from load/save operation
Exports the style as a XML file
Returns current file name of the style
Returns the names of the symbols which have a matching ‘substring’ in its definition
Imports the symbols and colorramps into the default style database from the given XML file
Returns
True
if the symbol with matchingtype
andname
is marked as a favorite.Tests if the file at
path
is a QGIS style XML file.Returns the label settings with the specified
name
.Returns count of label settings in the style.
Returns the ID in the style database for the given label settings by
name
.Returns the layer geometry type corresponding to the label settings with the specified
name
, orQgsWkbTypes
.UnknownGeometry if matching label settings are not present.Returns a list of names of label settings in the style.
Returns the legend patch shape with the specified
name
.Returns a list of names of legend patch shapes in the style.
Returns the symbol type corresponding to the legend patch shape with the specified
name
, orQgsSymbol
.Hybrid if a matching legend patch shape is not present.Returns count of legend patch shapes in the style.
Loads a file into the style
Returns a symbol to use for rendering preview icons for a patch
shape
.Removes the specified entity from the database.
Removes color ramp from style (and delete it)
Removes the entry of the specified
type
with matchingname
from the database.Removes the specified symbol from favorites
Removes label settings from the style.
Removes symbol from style (and delete it)
Removes a text format from the style.
Renames the given entity with the specified id
Changes ramp’s name
Renames an entity of the specified
type
fromoldName
tonewName
.Changes a label setting’s name.
Changes a legend patch shape’s name.
Renames a symbol from
oldName
tonewName
.Changes a 3d symbol’s name.
Changes a text format’s name.
Saves style into a file (will use current filename if empty string is passed)
Adds the colorramp to the database.
Adds label
settings
to the database.Adds a legend patch
shape
to the database.Adds the symbol to the database with tags.
Adds a 3d
symbol
to the database.Adds a text
format
to the database.Returns the
QgsSmartConditionMap
for the given idReturns the database id for the given smartgroup name
Returns the smart groups list
Returns the operator for the smartgroup.
Returns the smart groups map with id as key and name as value
Returns a NEW copy of symbol
Returns a new copy of the 3D symbol with the specified
name
.Returns the list of the vector layer geometry types which are compatible with the 3D symbol with the specified
name
, or an empty list if a matching 3d symbol is not present.Returns count of 3D symbols in the style.
Returns a list of names of 3d symbols in the style.
Returns count of symbols in style
Returns whether a given tag is associated with the symbol
Returns the id in the style database for the given symbol name returns 0 if not found
Returns a list of names of symbols
Returns a const pointer to a symbol (doesn’t create new instance)
Returns the symbol names which are flagged as favorite
Returns the symbols for the smartgroup
Returns the symbol names with which have the given tag
Returns the tag name for the given id
Returns the database id for the given tag name
Tags the symbol with the tags in the list
Returns a list of all tags in the style database
Returns the tags associated with the symbol
Returns the text format with the specified
name
.Returns count of text formats in the style.
Returns the ID in the style database for the given text format by
name
.Returns a list of names of text formats in the style.
Signals
Emitted every time a new entity has been added to the database.
Emitted whenever an entity’s definition is changed.
Emitted whenever an entity of the specified type is removed from the style and the database has been updated as a result.
Emitted whenever a entity of the specified type has been renamed from
oldName
tonewName
Emitted whenever an
entity
’s tags are changed.Emitted whenever an
entity
is either favorited or un-favorited.Emitted every time a tag or smartgroup has been added, removed, or renamed [signal]
Emitted whenever label settings have been added to the style and the database has been updated as a result.
Emitted whenever a label setting’s definition is changed.
Emitted whenever label settings have been removed from the style and the database has been updated as a result.
Emitted whenever label settings have been renamed from
oldName
tonewName
Emitted whenever a color ramp has been added to the style and the database has been updated as a result.
Emitted whenever a color ramp’s definition is changed.
Emitted whenever a color ramp has been removed from the style and the database has been updated as a result.
Emitted whenever a color ramp has been renamed from
oldName
tonewName
Emitted whenever a symbol’s definition is changed.
Emitted whenever a symbol has been removed from the style and the database has been updated as a result.
Emitted whenever a symbol has been renamed from
oldName
tonewName
Emitted every time a new symbol has been added to the database.
Emitted whenever a text format has been added to the style and the database has been updated as a result.
Emitted whenever a text format’s definition is changed.
Emitted whenever a text format has been removed from the style and the database has been updated as a result.
Emitted whenever a text format has been renamed from
oldName
tonewName
Attributes
- ColorrampEntity = 2¶
- LabelSettingsEntity = 5¶
- LegendPatchShapeEntity = 6¶
- SmartgroupEntity = 3¶
- class StyleEntity¶
Bases:
int
- Symbol3DEntity = 7¶
- SymbolEntity = 0¶
- TagEntity = 1¶
- TextFormatEntity = 4¶
- addColorRamp(self, name: str, colorRamp: QgsColorRamp, update: bool = False) → bool¶
Adds a color ramp to the style. Calling this method takes the ramp’s ownership.
Note
Adding a color ramp with the name of existing one replaces it.
- Parameters
name (str) – is the name of the color ramp being added or updated
colorRamp (QgsColorRamp) – is the color ramp. Ownership is transferred.
update (bool = False) – set to
True
when the style database has to be updated, by default it isFalse
- Return type
bool
- Returns
success status of the operation
- addEntity(self, name: str, entity: QgsStyleEntityInterface, update: bool = False) → bool¶
Adds an
entity
to the style, with the specifiedname
. Ownership is not transferred.If
update
isTrue
then the style database is updated automatically as a result.Returns
True
if the add operation was successful.Note
Adding an entity with the name of existing one replaces the existing one automatically.
New in version 3.10.
- Parameters
name (str) –
entity (QgsStyleEntityInterface) –
update (bool = False) –
- Return type
bool
- addFavorite(self, type: QgsStyle.StyleEntity, name: str) → bool¶
Adds the specified symbol to favorites
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity of ColorrampEntity
name (str) – is the name of the symbol or coloramp whose is to be added to favorites
- Return type
bool
- Returns
returns the success state as bool
- addLabelSettings(self, name: str, settings: QgsPalLayerSettings, update: bool = False) → bool¶
Adds label
settings
with the specifiedname
to the style.If
update
is set toTrue
, the style database will be automatically updated with the new text format.Returns
True
if the operation was successful.Note
Adding label settings with the name of existing ones replaces them.
New in version 3.10.
- Parameters
name (str) –
settings (QgsPalLayerSettings) –
update (bool = False) –
- Return type
bool
- addLegendPatchShape(self, name: str, shape: QgsLegendPatchShape, update: bool = False) → bool¶
Adds a legend patch
shape
with the specifiedname
to the style.If
update
is set toTrue
, the style database will be automatically updated with the new legend patch shape.Returns
True
if the operation was successful.Note
Adding legend patch shapes with the name of existing ones replaces them.
New in version 3.14.
- Parameters
name (str) –
shape (QgsLegendPatchShape) –
update (bool = False) –
- Return type
bool
- addSmartgroup(self, name: str, op: str, matchTag: Iterable[str], noMatchTag: Iterable[str], matchName: Iterable[str], noMatchName: Iterable[str]) → int¶
Adds a new smartgroup to the database and returns the id.
- Parameters
name (str) – is the name of the new Smart Group to be added
op (str) – is the operator between the conditions; AND/OR as QString
matchTag (Iterable[str]) – list of strings to match within tags
noMatchTag (Iterable[str]) – list of strings to exclude matches from tags
matchName (Iterable[str]) – list of string to match within names
noMatchName (Iterable[str]) – list of strings to exclude matches from names
New in version 3.4.
- Return type
int
- addSymbol(self, name: str, symbol: QgsSymbol, update: bool = False) → bool¶
Adds a symbol to style and takes symbol’s ownership
Note
Adding a symbol with the name of existing one replaces it.
- Parameters
name (str) – is the name of the symbol being added or updated
symbol (QgsSymbol) – is the Vector symbol
update (bool = False) – set to
True
when the style database has to be updated, by default it isFalse
- Return type
bool
- Returns
success status of the operation
- addSymbol3D(self, name: str, symbol: QgsAbstract3DSymbol, update: bool = False) → bool¶
Adds a 3d
symbol
with the specifiedname
to the style. Ownership ofsymbol
is transferred.If
update
is set toTrue
, the style database will be automatically updated with the new legend patch shape.Returns
True
if the operation was successful.Note
Adding 3d symbols with the name of existing ones replaces them.
New in version 3.16.
- Parameters
name (str) –
symbol (QgsAbstract3DSymbol) –
update (bool = False) –
- Return type
bool
- addTag(self, tagName: str) → int¶
Adds a new tag and returns the tag’s id
- Parameters
tagName (str) – the name of the new tag to be created
- Return type
int
- Returns
returns an int, which is the database id of the new tag created, 0 if the tag couldn’t be created
- addTextFormat(self, name: str, format: QgsTextFormat, update: bool = False) → bool¶
Adds a text
format
with the specifiedname
to the style.If
update
is set toTrue
, the style database will be automatically updated with the new text format.Returns
True
if the operation was successful.Note
Adding a text format with the name of existing one replaces it.
New in version 3.10.
- Parameters
name (str) –
format (QgsTextFormat) –
update (bool = False) –
- Return type
bool
- allNames(self, type: QgsStyle.StyleEntity) → List[str]¶
Returns a list of the names of all existing entities of the specified
type
.New in version 3.10.
- Parameters
type (QgsStyle.StyleEntity) –
- Return type
List[str]
- childEvent(self, QChildEvent)¶
- clear(self)¶
Removes all contents of the style
- colorRamp(self, name: str) → QgsColorRamp¶
Returns a new copy of the specified color ramp. The caller takes responsibility for deleting the returned object.
- Parameters
name (str) –
- Return type
- colorRampCount(self) → int¶
Returns count of color ramps
- Return type
int
- colorRampNames(self) → List[str]¶
Returns a list of names of color ramps
- Return type
List[str]
- colorRampRef(self, name: str) → QgsColorRamp¶
Returns a const pointer to a symbol (doesn’t create new instance)
- Parameters
name (str) –
- Return type
- colorrampId(self, name: str) → int¶
Returns the id in the style database for the given colorramp name returns 0 if not found
- Parameters
name (str) –
- Return type
int
- connectNotify(self, QMetaMethod)¶
- createDatabase(self, filename: str) → bool¶
Creates an on-disk database
This function creates a new on-disk permanent style database.
- Return type
bool
- Returns
returns the success state of the database creation
See also
New in version 3.0.
- Parameters
filename (str) –
- createMemoryDatabase(self) → bool¶
Creates a temporary memory database
This function is used to create a temporary style database in case a permanent on-disk database is not needed.
- Return type
bool
- Returns
returns the success state of the temporary memory database creation
See also
New in version 3.0.
- createTables(self)¶
Creates tables structure for new database
This function is used to create the tables structure in a newly-created database.
- Returns
returns the success state of the temporary memory database creation
See also
See also
New in version 3.0.
- customEvent(self, QEvent)¶
- defaultPatch(self, type: QgsSymbol.SymbolType, size: QSizeF) → QgsLegendPatchShape¶
Returns the default legend patch shape for the given symbol
type
.See also
New in version 3.14.
- Parameters
type (QgsSymbol.SymbolType) –
size (QSizeF) –
- Return type
- defaultPatchAsQPolygonF(self, type: QgsSymbol.SymbolType, size: QSizeF) → object¶
Returns the default patch geometry for the given symbol
type
andsize
as a set of QPolygonF objects (parts and rings).See also
New in version 3.14.
- Parameters
type (QgsSymbol.SymbolType) –
size (QSizeF) –
- Return type
object
- detagSymbol(self, type: QgsStyle.StyleEntity, symbol: str, tags: Iterable[str]) → bool¶
Detags the symbol with the given list
Removes the given tags for the specified symbol or colorramp
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity or ColorrampEntity
symbol (str) – is the name of the symbol or colorramp
tags (Iterable[str]) – is the list of tags that are to be removed as QStringList
- Returns
returns the success state of the operation
detagSymbol(self, type: QgsStyle.StyleEntity, symbol: str) -> bool Clears the symbol from all attached tags
Removes all tags for the specified symbol or colorramp
- Parameters
type – is either SymbolEntity or ColorrampEntity
symbol – is the name of the symbol or colorramp
- Return type
bool
- Returns
returns the success state of the operation
- disconnectNotify(self, QMetaMethod)¶
- entityAdded¶
Emitted every time a new entity has been added to the database.
New in version 3.14: [signal]
- Parameters
entity (QgsStyle.StyleEntity) –
name (str) –
- entityChanged¶
Emitted whenever an entity’s definition is changed. This does not include name or tag changes.
New in version 3.14: [signal]
- Parameters
entity (QgsStyle.StyleEntity) –
name (str) –
- entityId(self, type: QgsStyle.StyleEntity, name: str) → int¶
Returns the id in the style database for the given
name
of the specified entitytype
. Returns 0 if not found.- Parameters
type (QgsStyle.StyleEntity) –
name (str) –
- Return type
int
- entityRemoved¶
Emitted whenever an entity of the specified type is removed from the style and the database has been updated as a result.
New in version 3.14: [signal]
- Parameters
entity (QgsStyle.StyleEntity) –
name (str) –
- entityRenamed¶
Emitted whenever a entity of the specified type has been renamed from
oldName
tonewName
New in version 3.14: [signal]
- Parameters
entity (QgsStyle.StyleEntity) –
oldName (str) –
newName (str) –
- entityTagsChanged¶
Emitted whenever an
entity
’s tags are changed.New in version 3.4: [signal]
- Parameters
entity (QgsStyle.StyleEntity) –
name (str) –
newTags (Iterable[str]) –
- errorString(self) → str¶
Returns last error from load/save operation
- Return type
str
- exportXml(self, filename: str) → bool¶
Exports the style as a XML file
- Parameters
filename (str) –
- Return type
bool
- favoritedChanged¶
Emitted whenever an
entity
is either favorited or un-favorited.New in version 3.4: [signal]
- Parameters
entity (QgsStyle.StyleEntity) –
name (str) –
isFavorite (bool) –
- fileName(self) → str¶
Returns current file name of the style
- Return type
str
- findSymbols(self, type: QgsStyle.StyleEntity, qword: str) → List[str]¶
Returns the names of the symbols which have a matching ‘substring’ in its definition
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity or ColorrampEntity
qword (str) – is the query string to search the symbols or colorramps.
- Return type
List[str]
- Returns
A QStringList of the matched symbols or colorramps
- groupsModified¶
Emitted every time a tag or smartgroup has been added, removed, or renamed [signal]
- importXml(self, filename: str) → bool¶
Imports the symbols and colorramps into the default style database from the given XML file
- Parameters
filename (str) –
- Return type
bool
- isFavorite(self, type: QgsStyle.StyleEntity, name: str) → bool¶
Returns
True
if the symbol with matchingtype
andname
is marked as a favorite.New in version 3.10.
- Parameters
type (QgsStyle.StyleEntity) –
name (str) –
- Return type
bool
- isSignalConnected(self, QMetaMethod) → bool¶
- isXmlStyleFile(path: str) → bool¶
Tests if the file at
path
is a QGIS style XML file.This method samples only the first line in the file, so is safe to call on large xml files.
New in version 3.6.
- Parameters
path (str) –
- Return type
bool
- labelSettings(self, name: str) → QgsPalLayerSettings¶
Returns the label settings with the specified
name
.New in version 3.10.
- Parameters
name (str) –
- Return type
- labelSettingsAdded¶
Emitted whenever label settings have been added to the style and the database has been updated as a result.
See also
See also
New in version 3.10: [signal]
- Parameters
name (str) –
- labelSettingsChanged¶
Emitted whenever a label setting’s definition is changed. This does not include name or tag changes.
See also
New in version 3.10: [signal]
- Parameters
name (str) –
- labelSettingsCount(self) → int¶
Returns count of label settings in the style.
New in version 3.10.
- Return type
int
- labelSettingsId(self, name: str) → int¶
Returns the ID in the style database for the given label settings by
name
. Returns 0 if the label settings were not found.New in version 3.10.
- Parameters
name (str) –
- Return type
int
- labelSettingsLayerType(self, name: str) → QgsWkbTypes.GeometryType¶
Returns the layer geometry type corresponding to the label settings with the specified
name
, orQgsWkbTypes
.UnknownGeometry if matching label settings are not present.New in version 3.10.
- Parameters
name (str) –
- Return type
- labelSettingsNames(self) → List[str]¶
Returns a list of names of label settings in the style.
New in version 3.10.
- Return type
List[str]
- labelSettingsRemoved¶
Emitted whenever label settings have been removed from the style and the database has been updated as a result.
See also
See also
New in version 3.10: [signal]
- Parameters
name (str) –
- labelSettingsRenamed¶
Emitted whenever label settings have been renamed from
oldName
tonewName
See also
New in version 3.10: [signal]
- Parameters
oldName (str) –
newName (str) –
- legendPatchShape(self, name: str) → QgsLegendPatchShape¶
Returns the legend patch shape with the specified
name
.New in version 3.14.
- Parameters
name (str) –
- Return type
- legendPatchShapeNames(self) → List[str]¶
Returns a list of names of legend patch shapes in the style.
New in version 3.14.
- Return type
List[str]
- legendPatchShapeSymbolType(self, name: str) → QgsSymbol.SymbolType¶
Returns the symbol type corresponding to the legend patch shape with the specified
name
, orQgsSymbol
.Hybrid if a matching legend patch shape is not present.New in version 3.14.
- Parameters
name (str) –
- Return type
- legendPatchShapesCount(self) → int¶
Returns count of legend patch shapes in the style.
New in version 3.14.
- Return type
int
- load(self, filename: str) → bool¶
Loads a file into the style
This function will load an on-disk database and populate styles.
- Parameters
filename (str) – location of the database to load styles from
- Return type
bool
- Returns
returns the success state of the database being loaded
- previewSymbolForPatchShape(self, shape: QgsLegendPatchShape) → QgsSymbol¶
Returns a symbol to use for rendering preview icons for a patch
shape
.Ownership of the symbol is not transferred.
New in version 3.14.
- Parameters
shape (QgsLegendPatchShape) –
- Return type
- rampAdded¶
Emitted whenever a color ramp has been added to the style and the database has been updated as a result.
See also
See also
New in version 3.4: [signal]
- Parameters
name (str) –
- rampChanged¶
Emitted whenever a color ramp’s definition is changed. This does not include name or tag changes.
See also
New in version 3.4: [signal]
- Parameters
name (str) –
- rampRemoved¶
Emitted whenever a color ramp has been removed from the style and the database has been updated as a result.
See also
See also
New in version 3.4: [signal]
- Parameters
name (str) –
- rampRenamed¶
Emitted whenever a color ramp has been renamed from
oldName
tonewName
See also
New in version 3.4: [signal]
- Parameters
oldName (str) –
newName (str) –
- receivers(self, PYQT_SIGNAL) → int¶
- remove(self, type: QgsStyle.StyleEntity, id: int) → bool¶
Removes the specified entity from the database.
- Parameters
type (QgsStyle.StyleEntity) – is any of the style entities. Refer enum StyleEntity.
id (int) – is the database id of the entity to be removed
See also
- Return type
bool
- removeColorRamp(self, name: str) → bool¶
Removes color ramp from style (and delete it)
- Parameters
name (str) –
- Return type
bool
- removeEntityByName(self, type: QgsStyle.StyleEntity, name: str) → bool¶
Removes the entry of the specified
type
with matchingname
from the database.See also
New in version 3.14.
- Parameters
type (QgsStyle.StyleEntity) –
name (str) –
- Return type
bool
- removeFavorite(self, type: QgsStyle.StyleEntity, name: str) → bool¶
Removes the specified symbol from favorites
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity of ColorrampEntity
name (str) – is the name of the symbol or coloramp whose is to be removed from favorites
- Return type
bool
- Returns
returns the success state as bool
- removeLabelSettings(self, name: str) → bool¶
Removes label settings from the style.
New in version 3.10.
- Parameters
name (str) –
- Return type
bool
- removeSymbol(self, name: str) → bool¶
Removes symbol from style (and delete it)
- Parameters
name (str) –
- Return type
bool
- removeTextFormat(self, name: str) → bool¶
Removes a text format from the style.
New in version 3.10.
- Parameters
name (str) –
- Return type
bool
- rename(self, type: QgsStyle.StyleEntity, id: int, newName: str) → bool¶
Renames the given entity with the specified id
- Parameters
type (QgsStyle.StyleEntity) – is any of the style entities. Refer enum StyleEntity.
id (int) – is the database id of the entity which is to be renamed
newName (str) – is the new name of the entity
- Return type
bool
- renameColorRamp(self, oldName: str, newName: str) → bool¶
Changes ramp’s name
- Parameters
oldName (str) –
newName (str) –
- Return type
bool
- renameEntity(self, type: QgsStyle.StyleEntity, oldName: str, newName: str) → bool¶
Renames an entity of the specified
type
fromoldName
tonewName
.Returns
True
if the entity was successfully renamed.New in version 3.14.
- Parameters
type (QgsStyle.StyleEntity) –
oldName (str) –
newName (str) –
- Return type
bool
- renameLabelSettings(self, oldName: str, newName: str) → bool¶
Changes a label setting’s name.
New in version 3.10.
- Parameters
oldName (str) –
newName (str) –
- Return type
bool
- renameLegendPatchShape(self, oldName: str, newName: str) → bool¶
Changes a legend patch shape’s name.
New in version 3.14.
- Parameters
oldName (str) –
newName (str) –
- Return type
bool
- renameSymbol(self, oldName: str, newName: str) → bool¶
Renames a symbol from
oldName
tonewName
.Returns
True
if symbol was successfully renamed.- Parameters
oldName (str) –
newName (str) –
- Return type
bool
- renameSymbol3D(self, oldName: str, newName: str) → bool¶
Changes a 3d symbol’s name.
New in version 3.16.
- Parameters
oldName (str) –
newName (str) –
- Return type
bool
- renameTextFormat(self, oldName: str, newName: str) → bool¶
Changes a text format’s name.
New in version 3.10.
- Parameters
oldName (str) –
newName (str) –
- Return type
bool
- save(self, filename: str = '') → bool¶
Saves style into a file (will use current filename if empty string is passed)
- Parameters
filename (str = '') –
- Return type
bool
- saveColorRamp(self, name: str, ramp: QgsColorRamp, favorite: bool, tags: Iterable[str]) → bool¶
Adds the colorramp to the database.
- Parameters
name (str) – is the name of the colorramp as QString
ramp (QgsColorRamp) – is the pointer to the new
QgsColorRamp
being savedfavorite (bool) – is a boolean value to specify whether the colorramp should be added to favorites
tags (Iterable[str]) – is a list of tags that are associated with the color ramp as a QStringList.
- Return type
bool
- Returns
returns the success state of the save operation
- saveLabelSettings(self, name: str, settings: QgsPalLayerSettings, favorite: bool, tags: Iterable[str]) → bool¶
Adds label
settings
to the database.- Parameters
name (str) – is the name of the label settings
settings (QgsPalLayerSettings) – label settings to save
favorite (bool) – is a boolean value to specify whether the label settings should be added to favorites
tags (Iterable[str]) – is a list of tags that are associated with the label settings
- Return type
bool
- Returns
returns the success state of the save operation
- saveLegendPatchShape(self, name: str, shape: QgsLegendPatchShape, favorite: bool, tags: Iterable[str]) → bool¶
Adds a legend patch
shape
to the database.- Parameters
name (str) – is the name of the legend patch shape
shape (QgsLegendPatchShape) – legend patch shape to save
favorite (bool) – is a boolean value to specify whether the legend patch shape should be added to favorites
tags (Iterable[str]) – is a list of tags that are associated with the legend patch shape
- Return type
bool
- Returns
returns the success state of the save operation
New in version 3.14.
- saveSymbol(self, name: str, symbol: QgsSymbol, favorite: bool, tags: Iterable[str]) → bool¶
Adds the symbol to the database with tags.
- Parameters
name (str) – is the name of the symbol as QString
symbol (QgsSymbol) – is the pointer to the new
QgsSymbol
being savedfavorite (bool) – is a boolean value to specify whether the symbol should be added to favorites
tags (Iterable[str]) – is a list of tags that are associated with the symbol as a QStringList.
- Return type
bool
- Returns
returns the success state of the save operation
- saveSymbol3D(self, name: str, symbol: QgsAbstract3DSymbol, favorite: bool, tags: Iterable[str]) → bool¶
Adds a 3d
symbol
to the database.- Parameters
name (str) – is the name of the 3d symbol
symbol (QgsAbstract3DSymbol) – 3d symbol to save. Ownership is transferred.
favorite (bool) – is a boolean value to specify whether the 3d symbol should be added to favorites
tags (Iterable[str]) – is a list of tags that are associated with the 3d symbol
- Return type
bool
- Returns
returns the success state of the save operation
New in version 3.16.
- saveTextFormat(self, name: str, format: QgsTextFormat, favorite: bool, tags: Iterable[str]) → bool¶
Adds a text
format
to the database.- Parameters
name (str) – is the name of the text format
format (QgsTextFormat) – text format to save
favorite (bool) – is a boolean value to specify whether the text format should be added to favorites
tags (Iterable[str]) – is a list of tags that are associated with the text format
- Return type
bool
- Returns
returns the success state of the save operation
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- smartgroup(self, id: int) → Dict[str, List[str]]¶
Returns the
QgsSmartConditionMap
for the given id- Parameters
id (int) –
- Return type
Dict[str, List[str]]
- smartgroupId(self, smartgroup: str) → int¶
Returns the database id for the given smartgroup name
- Parameters
smartgroup (str) –
- Return type
int
- smartgroupNames(self) → List[str]¶
Returns the smart groups list
- Return type
List[str]
- smartgroupOperator(self, id: int) → str¶
Returns the operator for the smartgroup.
- Parameters
id (int) –
- Return type
str
- smartgroupsListMap(self) → Dict[int, str]¶
Returns the smart groups map with id as key and name as value
- Return type
Dict[int, str]
- symbol(self, name: str) → QgsSymbol¶
Returns a NEW copy of symbol
- Parameters
name (str) –
- Return type
- symbol3D(self, name: str) → QgsAbstract3DSymbol¶
Returns a new copy of the 3D symbol with the specified
name
.New in version 3.16.
- Parameters
name (str) –
- Return type
- symbol3DCompatibleGeometryTypes(self, name: str) → object¶
Returns the list of the vector layer geometry types which are compatible with the 3D symbol with the specified
name
, or an empty list if a matching 3d symbol is not present.New in version 3.16.
- Parameters
name (str) –
- Return type
object
- symbol3DCount(self) → int¶
Returns count of 3D symbols in the style.
New in version 3.16.
- Return type
int
- symbol3DNames(self) → List[str]¶
Returns a list of names of 3d symbols in the style.
New in version 3.16.
- Return type
List[str]
- symbolChanged¶
Emitted whenever a symbol’s definition is changed. This does not include name or tag changes.
See also
New in version 3.4: [signal]
- Parameters
name (str) –
- symbolCount(self) → int¶
Returns count of symbols in style
- Return type
int
- symbolHasTag(self, type: QgsStyle.StyleEntity, symbol: str, tag: str) → bool¶
Returns whether a given tag is associated with the symbol
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity or ColorrampEntity
symbol (str) – is the name of the symbol or color ramp
tag (str) – the name of the tag to look for
- Return type
bool
- Returns
A boolean value identicating whether a tag was found attached to the symbol
- symbolId(self, name: str) → int¶
Returns the id in the style database for the given symbol name returns 0 if not found
- Parameters
name (str) –
- Return type
int
- symbolNames(self) → List[str]¶
Returns a list of names of symbols
- Return type
List[str]
- symbolRef(self, name: str) → QgsSymbol¶
Returns a const pointer to a symbol (doesn’t create new instance)
- Parameters
name (str) –
- Return type
- symbolRemoved¶
Emitted whenever a symbol has been removed from the style and the database has been updated as a result.
See also
See also
New in version 3.4: [signal]
- Parameters
name (str) –
- symbolRenamed¶
Emitted whenever a symbol has been renamed from
oldName
tonewName
See also
New in version 3.4: [signal]
- Parameters
oldName (str) –
newName (str) –
- symbolSaved¶
Emitted every time a new symbol has been added to the database. Emitted whenever a symbol has been added to the style and the database has been updated as a result.
See also
See also
See also
symbolChanged()
[signal]- Parameters
name (str) –
symbol (QgsSymbol) –
- symbolsOfFavorite(self, type: QgsStyle.StyleEntity) → List[str]¶
Returns the symbol names which are flagged as favorite
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity or ColorampEntity
- Return type
List[str]
- Returns
A QStringList of the symbol or colorramp names flagged as favorite
- symbolsOfSmartgroup(self, type: QgsStyle.StyleEntity, id: int) → List[str]¶
Returns the symbols for the smartgroup
- Parameters
type (QgsStyle.StyleEntity) –
id (int) –
- Return type
List[str]
- symbolsWithTag(self, type: QgsStyle.StyleEntity, tagid: int) → List[str]¶
Returns the symbol names with which have the given tag
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity or ColorampEntity
tagid (int) – is id of the tag which has been applied over the symbol as int
- Return type
List[str]
- Returns
A QStringList of the symbol or colorramp names for the given tag id
- tag(self, id: int) → str¶
Returns the tag name for the given id
- Parameters
id (int) –
- Return type
str
- tagId(self, tag: str) → int¶
Returns the database id for the given tag name
- Parameters
tag (str) –
- Return type
int
- tagSymbol(self, type: QgsStyle.StyleEntity, symbol: str, tags: Iterable[str]) → bool¶
Tags the symbol with the tags in the list
Applies the given tags to the given symbol or colorramp
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity or ColorrampEntity
symbol (str) – is the name of the symbol or colorramp as QString
tags (Iterable[str]) – is the list of the tags that are to be applied as QStringList
- Return type
bool
- Returns
returns the success state of the operation
- tags(self) → List[str]¶
Returns a list of all tags in the style database
See also
New in version 2.16.
- Return type
List[str]
- tagsOfSymbol(self, type: QgsStyle.StyleEntity, symbol: str) → List[str]¶
Returns the tags associated with the symbol
- Parameters
type (QgsStyle.StyleEntity) – is either SymbolEntity or ColorrampEntity
symbol (str) – is the name of the symbol or color ramp
- Return type
List[str]
- Returns
A QStringList of the tags that have been applied to that symbol/colorramp
- textFormat(self, name: str) → QgsTextFormat¶
Returns the text format with the specified
name
.New in version 3.10.
- Parameters
name (str) –
- Return type
- textFormatAdded¶
Emitted whenever a text format has been added to the style and the database has been updated as a result.
See also
See also
New in version 3.10: [signal]
- Parameters
name (str) –
- textFormatChanged¶
Emitted whenever a text format’s definition is changed. This does not include name or tag changes.
See also
New in version 3.10: [signal]
- Parameters
name (str) –
- textFormatCount(self) → int¶
Returns count of text formats in the style.
New in version 3.10.
- Return type
int
- textFormatId(self, name: str) → int¶
Returns the ID in the style database for the given text format by
name
. Returns 0 if the text format was not found.New in version 3.10.
- Parameters
name (str) –
- Return type
int
- textFormatNames(self) → List[str]¶
Returns a list of names of text formats in the style.
New in version 3.10.
- Return type
List[str]
- textFormatRemoved¶
Emitted whenever a text format has been removed from the style and the database has been updated as a result.
See also
See also
New in version 3.10: [signal]
- Parameters
name (str) –
- textFormatRenamed¶
Emitted whenever a text format has been renamed from
oldName
tonewName
See also
New in version 3.10: [signal]
- Parameters
oldName (str) –
newName (str) –
- timerEvent(self, QTimerEvent)¶