ScaleBar
=================

.. currentmodule:: axioma.render

.. class:: ScaleBar

	Класс производит отрисовку масштабной линейки для карты

		.. py:method:: ScaleBar(map, parent=None)

			Конструктор

			:param map: Карта, для которой создается масштабная линейка. 
			:type map: :class:`~axioma.render.Map`
			:param parent: Владелец масштабной линейки. При удалении владельца так же удаляется и сам элемент
			:type parent: :class:`~PyQt5.QtCore.QObject`

		.. py:method:: render(point, context, mapViewport)

			Отрисовка линейки в переданном контексте

			:param point: Точка, от которой производится отрисовка
			:type point: :class:`~PyQt5.QtCore.QPointF`
			:param context: Контекст, в котором требуется отрисовать линейку
			:type context: :class:`~axioma.render.Context`
			:param mapViewport: Текущее значение MapViewport для расчета текущих  значений
			:type mapViewport: :class:`MapViewport`

		.. py:method:: textRender()

			Текущее значение оформления текстовых объектов, которое используется при отрисовке линейки

			:return: Установленное значение
			:rtype: :class:`TextRenderer`

		.. py:method:: setTextRender(textRender)

			Установка нового значения оформления текста

			:param  textRender: Оформление текстовых объектов
			:type textRender: :class:`TextRenderer`

		.. py:method:: borderColor()

			Цвет окантовки

			:return: Цвет
			:rtype: :class:`QColor`

		.. py:method:: setBorderColor(borderColor)

			Переопределение цвета окантовки

			:param borderColor: Новое значение цвета
			:type borderColor: :class:`QColor`

		.. py:method:: fillColorOne()

			Первый цвет заливки 

			:return: Цвет
			:rtype: :class:`QColor`

		.. py:method:: setFillColorOne(fillColorOne)

			Установка нового первого цвета заливки

			:param fillColorOne: Новое значение цвета
			:type fillColorOne: :class:`QColor`

		.. py:method:: fillColorTwo()

			Второй цвет заливки 

			:return: Цвет
			:rtype: :class:`QColor`

		.. py:method:: setFillColorTwo(fillColorTwo)

			Установка нового цвета заливки

			:param fillColorTwo: Новое значение второго цвета
			:type fillColorTwo: :class:`QColor`

		.. py:method:: isShowCartographScale()

			Будет ли показан картографический масштаб

			:return: True, если да. В противном случае False
			:rtype: :class:`bool`  

		.. py:method:: setIsShowCartographScale(isShowCartographScale)

			Установка - управление показом картографическим масштабом

			:param isShowCartographScale: True, если необходимо подсказать внизу текущее значение картографического масштаба. В противном случае False
			:type isShowCartographScale: :class:`bool`

		.. py:method:: isAutomaticScale()

			Устанавливает режим округления параметров линейки до удобочитаемого вида.

			:return: Если установлено значение True, производится округление до значений, кратных 1, 2.5, 5.  Размер линейки в этом случае подгоняется до ближайшего значения. В противном случае значения не округляются и показывается расчетное
			:rtype: :class:`bool`

		.. py:method:: setIsAutomaticScale(isAutomaticScale)

			Установка режима округления текущего масштаба до удобочитаемого вида

			:param isAutomaticScale: True, если режим необходимо включить
			:type isAutomaticScale: :class:`bool`

		.. py:method:: map()

			Карта, к которой относится масштабная линейка

			:return: Объект карты
			:rtype: :class:`~axioma.render.Map`

		.. py:method:: deviceUnit()

			Единицы измерения в отчете для расчета соотношения

			:return: Единицы измерения
			:rtype: :class:`Unit`

		.. py:method:: setDeviceUnit(deviceUnit)

			Установка нового значения единиц измерения

			:param deviceUnit: Единицы измерения
			:type deviceUnit: :class:`Unit`

		.. py:method:: size()

			Текущий размер масштабной линейки

			:return: Размер
			:rtype: :class:`~PyQt5.QtCore.QSizeF`

		.. py:method:: setSize(size)

			Установка нового значения размера масштабной линейки

			:param size: Новое значение
			:type size: :class:`QSizeF`