Class: QgsCptCityColorRamp

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

Bases: QgsGradientColorRamp

Constructor for QgsCptCityColorRamp

Parameters
  • schemeName (str = '') – cpt-city scheme name

  • variantName (str = '') – cpt-city variant name

  • inverted (bool = False) – invert ramp ordering

  • doLoadFile (bool = True) – load cpt-city ramp from file

QgsCptCityColorRamp(schemeName: str, variantList: Iterable[str], variantName: 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(QgsCptCityColorRamp)

Methods

clone

rtype

QgsCptCityColorRamp

cloneGradientRamp

rtype

QgsGradientColorRamp

copy

param other

copyingFileName

rtype

str

copyingInfo

rtype

Dict[str, str]

create

param properties

descFileName

rtype

str

fileLoaded

rtype

bool

fileName

rtype

str

hasMultiStops

rtype

bool

invert

loadFile

rtype

bool

loadPalette

properties

rtype

Dict[str, str]

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
Return type

QgsCptCityColorRamp

cloneGradientRamp(self)QgsGradientColorRamp
Return type

QgsGradientColorRamp

copy(self, other: QgsCptCityColorRamp)
Parameters

other (QgsCptCityColorRamp) –

copyingFileName(self) → str
Return type

str

copyingInfo(self) → Dict[str, str]
Return type

Dict[str, str]

create(properties: Dict[str, str] = {})QgsColorRamp
Parameters

properties (Dict[str) –

Return type

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, str]
Return type

Dict[str, str]

schemeName(self) → str
Return type

str

setName(self, schemeName: str, variantName: str = '', variantList: Iterable[str] = [])
Parameters
  • schemeName (str) –

  • variantName (str = '') –

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

setSchemeName(self, schemeName: str)
Parameters

schemeName (str) –

setVariantList(self, variantList: Iterable[str])
Parameters

variantList (Iterable[str]) –

setVariantName(self, variantName: str)
Parameters

variantName (str) –

type(self) → str
Return type

str

typeString() → str

Returns the string identifier for QgsCptCityColorRamp.

New in version 3.16.

Return type

str

variantList(self) → List[str]
Return type

List[str]

variantName(self) → str
Return type

str