Class: QgsStyle

class qgis.core.QgsStyle

Bases: PyQt5.QtCore.QObject

Constructor for QgsStyle.

Methods

addColorRamp

Adds a color ramp to the style.

addEntity

Adds an entity to the style, with the specified name.

addFavorite

Adds the specified symbol to favorites

addLabelSettings

Adds label settings with the specified name to the style.

addSmartgroup

Adds a new smartgroup to the database and returns the id.

addSymbol

Adds a symbol to style and takes symbol’s ownership

addTag

Adds a new tag and returns the tag’s id

addTextFormat

Adds a text format with the specified name to the style.

allNames

Returns a list of the names of all existing entities of the specified type.

childEvent

clear

Removes all contents of the style

colorRamp

Returns a new copy of the specified color ramp.

colorRampCount

Returns count of color ramps

colorRampNames

Returns a list of names of color ramps

colorRampRef

Returns a const pointer to a symbol (doesn’t create new instance)

colorrampId

Returns the id in the style database for the given colorramp name returns 0 if not found

connectNotify

createDatabase

Creates an on-disk database

createMemoryDatabase

Creates a temporary memory database

createTables

Creates tables structure for new database

customEvent

defaultStyle

Returns default application-wide style

detagSymbol

Detags the symbol with the given list

disconnectNotify

errorString

Returns last error from load/save operation

exportXml

Exports the style as a XML file

fileName

Returns current file name of the style

findSymbols

Returns the names of the symbols which have a matching ‘substring’ in its definition

importXml

Imports the symbols and colorramps into the default style database from the given XML file

isFavorite

Returns True if the symbol with matching type and name is marked as a favorite.

isSignalConnected

isXmlStyleFile

Tests if the file at path is a QGIS style XML file.

labelSettings

Returns the label settings with the specified name.

labelSettingsCount

Returns count of label settings in the style.

labelSettingsId

Returns the ID in the style database for the given label settings by name.

labelSettingsLayerType

Returns the layer geometry type corresponding to the label settings with the specified name, or QgsWkbTypes.UnknownGeometry if matching label settings are not present.

labelSettingsNames

Returns a list of names of label settings in the style.

load

Loads a file into the style

receivers

remove

Removes the specified entity from the db

removeColorRamp

Removes color ramp from style (and delete it)

removeFavorite

Removes the specified symbol from favorites

removeLabelSettings

Removes label settings from the style.

removeSymbol

Removes symbol from style (and delete it)

removeTextFormat

Removes a text format from the style.

rename

Renames the given entity with the specified id

renameColorRamp

Changes ramp’s name

renameLabelSettings

Changes a label setting’s name.

renameSymbol

Renames a symbol from oldName to newName.

renameTextFormat

Changes a text format’s name.

save

Saves style into a file (will use current filename if empty string is passed)

saveColorRamp

Adds the colorramp to the DB

saveLabelSettings

Adds label settings to the database.

saveSymbol

Adds the symbol to the DB with the tags

saveTextFormat

Adds a text format to the database.

sender

senderSignalIndex

smartgroup

Returns the QgsSmartConditionMap for the given id

smartgroupId

Returns the DB id for the given smartgroup name

smartgroupNames

Returns the smart groups list

smartgroupOperator

Returns the operator for the smartgroup clumsy implementation TODO create a class for smartgroups

smartgroupsListMap

Returns the smart groups map with id as key and name as value

symbol

Returns a NEW copy of symbol

symbolCount

Returns count of symbols in style

symbolHasTag

Returns whether a given tag is associated with the symbol

symbolId

Returns the id in the style database for the given symbol name returns 0 if not found

symbolNames

Returns a list of names of symbols

symbolRef

Returns a const pointer to a symbol (doesn’t create new instance)

symbolsOfFavorite

Returns the symbol names which are flagged as favorite

symbolsOfSmartgroup

Returns the symbols for the smartgroup

symbolsWithTag

Returns the symbol names with which have the given tag

tag

Returns the tag name for the given id

tagId

Returns the DB id for the given tag name

tagSymbol

Tags the symbol with the tags in the list

tags

Returns a list of all tags in the style database

tagsOfSymbol

Returns the tags associated with the symbol

textFormat

Returns the text format with the specified name.

textFormatCount

Returns count of text formats in the style.

textFormatId

Returns the ID in the style database for the given text format by name.

textFormatNames

Returns a list of names of text formats in the style.

timerEvent

Signals

entityTagsChanged

Emitted whenever an entity’s tags are changed.

favoritedChanged

Emitted whenever an entity is either favorited or un-favorited.

groupsModified

Emitted every time a tag or smartgroup has been added, removed, or renamed [signal]

labelSettingsAdded

Emitted whenever label settings have been added to the style and the database has been updated as a result.

labelSettingsChanged

Emitted whenever a label setting’s definition is changed.

labelSettingsRemoved

Emitted whenever label settings have been removed from the style and the database has been updated as a result.

labelSettingsRenamed

Emitted whenever label settings have been renamed from oldName to newName

rampAdded

Emitted whenever a color ramp has been added to the style and the database has been updated as a result.

rampChanged

Emitted whenever a color ramp’s definition is changed.

rampRemoved

Emitted whenever a color ramp has been removed from the style and the database has been updated as a result.

rampRenamed

Emitted whenever a color ramp has been renamed from oldName to newName

symbolChanged

Emitted whenever a symbol’s definition is changed.

symbolRemoved

Emitted whenever a symbol has been removed from the style and the database has been updated as a result.

symbolRenamed

Emitted whenever a symbol has been renamed from oldName to newName

symbolSaved

Emitted every time a new symbol has been added to the database.

textFormatAdded

Emitted whenever a text format has been added to the style and the database has been updated as a result.

textFormatChanged

Emitted whenever a text format’s definition is changed.

textFormatRemoved

Emitted whenever a text format has been removed from the style and the database has been updated as a result.

textFormatRenamed

Emitted whenever a text format has been renamed from oldName to newName

Attributes

ColorrampEntity

LabelSettingsEntity

SmartgroupEntity

SymbolEntity

TagEntity

TextFormatEntity

ColorrampEntity = 2
LabelSettingsEntity = 5
SmartgroupEntity = 3
class StyleEntity

Bases: int

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 DB has to be updated, by default it is False

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 specified name. Ownership is not transferred.

If update is True 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
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 specified name to the style.

If update is set to True, the style DB 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
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 DB has to be updated, by default it is False

Return type

bool

Returns

success status of the operation

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 DB 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 specified name to the style.

If update is set to True, the style DB 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()
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

QgsColorRamp

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

QgsColorRamp

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()
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

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

createDatabase()

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

createDatabase()

New in version 3.0.

customEvent()
defaultStyle() → QgsStyle

Returns default application-wide style

Return type

QgsStyle

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()
entityTagsChanged

Emitted whenever an entity’s tags are changed.

New in version 3.4: [signal]

Parameters
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
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 matching type and name is marked as a favorite.

New in version 3.10.

Parameters
Return type

bool

isSignalConnected()
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

QgsPalLayerSettings

labelSettingsAdded

Emitted whenever label settings have been added to the style and the database has been updated as a result.

See also

symbolSaved()

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.

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, or QgsWkbTypes.UnknownGeometry if matching label settings are not present.

New in version 3.10.

Parameters

name (str) –

Return type

QgsWkbTypes.GeometryType

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

symbolRemoved()

New in version 3.10: [signal]

Parameters

name (str) –

labelSettingsRenamed

Emitted whenever label settings have been renamed from oldName to newName

See also

symbolRenamed()

New in version 3.10: [signal]

Parameters
  • oldName (str) –

  • newName (str) –

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

rampAdded

Emitted whenever a color ramp has been added to the style and the database has been updated as a result.

See also

rampRemoved()

See also

symbolSaved()

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

rampAdded()

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

rampAdded()

See also

symbolRemoved()

New in version 3.4: [signal]

Parameters

name (str) –

rampRenamed

Emitted whenever a color ramp has been renamed from oldName to newName

See also

symbolRenamed()

New in version 3.4: [signal]

Parameters
  • oldName (str) –

  • newName (str) –

receivers()
remove(self, type: QgsStyle.StyleEntity, id: int) → bool

Removes the specified entity from the db

Parameters
  • type (QgsStyle.StyleEntity) – is any of the style entities. Refer enum StyleEntity.

  • id (int) – is the DB id of the entity to be removed

Return type

bool

removeColorRamp(self, name: str) → bool

Removes color ramp from style (and delete it)

Parameters

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 DB 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

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

renameSymbol(self, oldName: str, newName: str) → bool

Renames a symbol from oldName to newName.

Returns True if symbol was successfully renamed.

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 DB

Parameters
  • name (str) – is the name of the colorramp as QString

  • ramp (QgsColorRamp) – is the pointer to the new QgsColorRamp being saved

  • favorite (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

saveSymbol(self, name: str, symbol: QgsSymbol, favorite: bool, tags: Iterable[str]) → bool

Adds the symbol to the DB with the tags

Parameters
  • name (str) – is the name of the symbol as QString

  • symbol (QgsSymbol) – is the pointer to the new QgsSymbol being saved

  • favorite (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

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()
senderSignalIndex()
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 DB 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 clumsy implementation TODO create a class for smartgroups

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

QgsSymbol

symbolChanged

Emitted whenever a symbol’s definition is changed. This does not include name or tag changes.

See also

symbolSaved()

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

QgsSymbol

symbolRemoved

Emitted whenever a symbol has been removed from the style and the database has been updated as a result.

See also

symbolSaved()

See also

rampRemoved()

New in version 3.4: [signal]

Parameters

name (str) –

symbolRenamed

Emitted whenever a symbol has been renamed from oldName to newName

See also

rampRenamed()

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

symbolRemoved()

See also

rampAdded()

See also

symbolChanged() [signal]

Parameters
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
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 DB 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

addTag()

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

QgsTextFormat

textFormatAdded

Emitted whenever a text format has been added to the style and the database has been updated as a result.

See also

symbolSaved()

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.

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

symbolRemoved()

New in version 3.10: [signal]

Parameters

name (str) –

textFormatRenamed

Emitted whenever a text format has been renamed from oldName to newName

See also

symbolRenamed()

New in version 3.10: [signal]

Parameters
  • oldName (str) –

  • newName (str) –

timerEvent()