instructions.Scalebar Class Reference

Class representing scalebar instruction. More...

Inheritance diagram for instructions.Scalebar:

Collaboration diagram for instructions.Scalebar:

Public Member Functions
def	__init__
def	__str__
def	Read
	Read instruction and save information. More...
def	EstimateSize
	Estimate size to draw scalebar. More...
Public Member Functions inherited from instructions.InstructionObject
def	__init__
def	__str__
	Returns particular part of text instruction. More...
def	__getitem__
def	__setitem__
def	GetInstruction
	Get current values. More...
def	SetInstruction
	Set default values. More...
def	Read
	Read instruction and save them. More...
def	PercentToReal
	Converts text coordinates from percent of region to map coordinates. More...

Data Fields
	type
	defaultInstruction
	instruction
Data Fields inherited from instructions.InstructionObject
	id
	defaultInstruction
	instruction
	unitConv

Detailed Description

Class representing scalebar instruction.

Definition at line 1196 of file instructions.py.

Constructor & Destructor Documentation

def instructions.Scalebar.__init__	(		self,
			id
	)

Definition at line 1198 of file instructions.py.

Member Function Documentation

def instructions.Scalebar.__str__

(

self

)

Definition at line 1210 of file instructions.py.

References instructions.Instruction.instruction, frame.PsMapFrame.instruction, dialogs.PsmapDialog.instruction, instructions.InstructionObject.instruction, dialogs.MapFramePanel.instruction, frame.PsMapBufferedWindow.instruction, dialogs.RasterPanel.instruction, dialogs.VectorPanel.instruction, and dialogs.LegendDialog.instruction.

def instructions.Scalebar.EstimateSize	(		self,
			scalebarDict,
			scale
	)

Estimate size to draw scalebar.

Definition at line 1262 of file instructions.py.

References utils.projInfo().

Referenced by instructions.Scalebar.Read().

def instructions.Scalebar.Read	(		self,
			instruction,
			text,
			kwargs
	)

Read instruction and save information.

Definition at line 1220 of file instructions.py.

References instructions.Scalebar.EstimateSize(), instructions.Instruction.instruction, frame.PsMapFrame.instruction, dialogs.PsmapDialog.instruction, instructions.InstructionObject.instruction, dialogs.MapFramePanel.instruction, frame.PsMapBufferedWindow.instruction, dialogs.RasterPanel.instruction, dialogs.VectorPanel.instruction, and dialogs.LegendDialog.instruction.

Field Documentation

instructions.Scalebar.defaultInstruction

Definition at line 1202 of file instructions.py.

instructions.Scalebar.instruction

Definition at line 1208 of file instructions.py.

instructions.Scalebar.type

Definition at line 1200 of file instructions.py.

Referenced by widgets.BaseValidator.Validate().

---

The documentation for this class was generated from the following file:

• instructions.py