Class: QgsCptCityColorRamp

class qgis.core.QgsCptCityColorRamp(schemeName: str | None = '', variantName: str | None = '', inverted: bool = False, doLoadFile: bool = True)

Bases: QgsGradientColorRamp

Constructor for QgsCptCityColorRamp

Parameters:

• schemeName – cpt-city scheme name

• variantName – cpt-city variant name

• inverted – invert ramp ordering

• doLoadFile – load cpt-city ramp from file

QgsCptCityColorRamp(schemeName: Optional[str], variantList: Iterable[Optional[str]], variantName: Optional[str] = ‘’, inverted: bool = False, doLoadFile: bool = True) Constructor for QgsCptCityColorRamp

Parameters:

• schemeName – cpt-city scheme name

• variantList – cpt-city variant list

• variantName – cpt-city variant name

• inverted – invert ramp ordering

• doLoadFile – load cpt-city ramp from file

QgsCptCityColorRamp(a0: QgsCptCityColorRamp)

Methods

clone	rtype: Optional[QgsCptCityColorRamp]
cloneGradientRamp	rtype: Optional[QgsGradientColorRamp]
copy	param other:
copyingFileName	rtype: str
copyingInfo	rtype: Dict[str, str]
create	Creates the symbol layer
descFileName	rtype: str
fileLoaded	rtype: bool
fileName	rtype: str
hasMultiStops	rtype: bool
invert
loadFile	rtype: bool
loadPalette
properties	rtype: Dict[str, Any]
schemeName	rtype: str
setName	param schemeName:
setSchemeName	param schemeName:
setVariantList	param variantList:
setVariantName	param variantName:
type	rtype: str
typeString	Returns the string identifier for QgsCptCityColorRamp.
variantList	rtype: List[str]
variantName	rtype: str

clone(self) → QgsCptCityColorRamp | None

Return type:

Optional[QgsCptCityColorRamp]

cloneGradientRamp(self) → QgsGradientColorRamp | None

Return type:

Optional[QgsGradientColorRamp]

copy(self, other: QgsCptCityColorRamp | None)

Parameters:

other (Optional[QgsCptCityColorRamp])

copyingFileName(self) → str

Return type:

str

copyingInfo(self) → Dict[str, str]

Return type:

Dict[str, str]

create(properties: Dict[str, Any] = {}) → QgsColorRamp | None

Creates the symbol layer

Parameters:

properties (Dict[str)

Return type:

Optional[QgsColorRamp]

descFileName(self) → str

Return type:

str

fileLoaded(self) → bool

Return type:

bool

fileName(self) → str

Return type:

str

hasMultiStops(self) → bool

Return type:

bool

invert(self)

loadFile(self) → bool

Return type:

bool

loadPalette(self)

properties(self) → Dict[str, Any]

Return type:

Dict[str, Any]

schemeName(self) → str

Return type:

str

setName(self, schemeName: str | None, variantName: str | None = '', variantList: Iterable[str | None] = [])

Parameters:

• schemeName (Optional[str])

• variantName (Optional[str] = '')

• variantList (Iterable[Optional[str]] = [])

setSchemeName(self, schemeName: str | None)

Parameters:

schemeName (Optional[str])

setVariantList(self, variantList: Iterable[str | None])

Parameters:

variantList (Iterable[Optional[str]])

setVariantName(self, variantName: str | None)

Parameters:

variantName (Optional[str])

type(self) → str

Return type:

str

typeString() → str

Returns the string identifier for QgsCptCityColorRamp.

Added in version 3.16.

Return type:

str

variantList(self) → List[str]

Return type:

List[str]

variantName(self) → str

Return type:

str