Класс View

Граф наследования:View:

Открытые члены
	getHeight ()
	setHeight ($height)
	getKey ()
	getLabel ()
	setLabel ($label)
	getLogoUri ()
	setLogoUri ($logoUri)
	getCompatibleDataType ()
	setCompatibleDataType ($compatibleDataType)
	getCompatibleViewTypes ()
	handlerFinallyBeforePassToView ($dataFromReport)
	buildWidgetHandlerForBoard ($boardId)
	addDefaultReportHandlersToWidgetHandler (BaseWidget $widgetHandler)
	prepareWidgetFormBeforeRender (WidgetForm $form)
	collectWidgetHandlerFormElements (BaseWidget $widgetHandler)
	collectReportHandlerFormElements ($reportHandler)
	getJsClassName ()
	setJsClassName ($jsClassName)
	isDraggable ()
	setDraggable ($draggable)
	isCompatibleWithView (View $view)
	getReportDefaultColor ($num)
	isHorizontalResizable ()
	setHorizontalResizable ($horizontalResizable)
	getPreviewImageUri ()
	setPreviewImageUri ($previewImageUri)

Открытые атрибуты
const	VIEW_KEY = ''
const	MAX_RENDER_REPORT_COUNT = 0
const	DEFAULT_EMPTY_REPORT_COUNT = 1
const	USE_IN_VISUAL_CONSTRUCTOR = true

Подробное описание

См. определение в файле view.php строка 25

Методы

addDefaultReportHandlersToWidgetHandler()

addDefaultReportHandlersToWidgetHandler

(

BaseWidget

$widgetHandler

)

When building new widget, add default Report handlers to widget.

Аргументы

BaseWidget

$widgetHandler

Widget handler.

Возвращает

BaseWidget

Переопределяется в NumberBlockWithFormula.

См. определение в файле view.php строка 167

buildWidgetHandlerForBoard()

buildWidgetHandlerForBoard ( $boardId )

final

Use if need to construct widget entity by view type.

Аргументы

string

$boardId

Board id.

Возвращает

BaseWidget

См. определение в файле view.php строка 150

collectReportHandlerFormElements()

collectReportHandlerFormElements

(

$reportHandler

)

Method to modify widget form elements.

Аргументы

BaseReport

$reportHandler

Widget handler.

Возвращает

void

Переопределяется в NumberBlockWithFormula и MultiDirectional.

См. определение в файле view.php строка 289

collectWidgetHandlerFormElements()

collectWidgetHandlerFormElements

(

BaseWidget

$widgetHandler

)

Method to modify widget form elements.

Аргументы

BaseWidget

$widgetHandler

Widget handler.

Возвращает

void

Переопределяется в Grid, GroupedDataGrid, NumberBlock, Base и Base.

См. определение в файле view.php строка 222

getCompatibleDataType()

getCompatibleDataType

(

)

Возвращает

string

См. определение в файле view.php строка 110

getCompatibleViewTypes()

getCompatibleViewTypes

(

)

Return list of compatible view type keys, to this view types can switch without reform configurations.

Возвращает

array

Переопределяется в Column, ColumnLogarithmic, DonutDiagram, Funnel, LinearGraph, PieDiagram, SmoothedGraph, Stack и Column.

См. определение в файле view.php строка 131

getHeight()

getHeight

(

)

Возвращает

mixed

См. определение в файле view.php строка 44

getJsClassName()

getJsClassName

(

)

Возвращает

string

См. определение в файле view.php строка 372

getKey()

getKey

(

)

Возвращает

string

См. определение в файле view.php строка 64

getLabel()

getLabel

(

)

Возвращает

string

См. определение в файле view.php строка 72

getLogoUri()

getLogoUri

(

)

Возвращает

string

См. определение в файле view.php строка 91

getPreviewImageUri()

getPreviewImageUri

(

)

Возвращает

mixed

См. определение в файле view.php строка 515

getReportDefaultColor()

getReportDefaultColor

(

$num

)

Default colors set for reports.

Аргументы

int

$num

Number of color which need.

Возвращает

string

Переопределяется в GroupedDataGrid, NumberBlock, Activity и PieDiagram.

См. определение в файле view.php строка 475

handlerFinallyBeforePassToView()

handlerFinallyBeforePassToView ( $dataFromReport )

abstract

Handle all data prepared for this view.

Аргументы

array

$dataFromReport

Calculated data from report handler.

Возвращает

array

Переопределяется в Base, Grid, GroupedDataGrid, Base, Base, StoreProfitGraph, Activity, Column, ColumnLogarithmic, DonutDiagram, Funnel, LinearGraph, MultiDirectional, PieDiagram, Serial, SmoothedGraph, Stack, Column, Serial и Circle.

isCompatibleWithView()

isCompatibleWithView

(

View

$view

)

Check is $view compatible with current view type.

Аргументы

View

$view

View entity.

Возвращает

bool

См. определение в файле view.php строка 464

isDraggable()

isDraggable

(

)

Возвращает

bool

См. определение в файле view.php строка 442

isHorizontalResizable()

isHorizontalResizable

(

)

Возвращает

bool

См. определение в файле view.php строка 496

prepareWidgetFormBeforeRender()

prepareWidgetFormBeforeRender

(

WidgetForm

$form

)

Method to modify widget configuration form in context of view.

Аргументы

WidgetForm

$form

Form Entity.

Возвращает

WidgetForm $form

Переопределяется в NumberBlock.

См. определение в файле view.php строка 210

setCompatibleDataType()

setCompatibleDataType

(

$compatibleDataType

)

Set compatible data type.

Аргументы

string

$compatibleDataType

Data type which compatible with view type.

Возвращает

void

См. определение в файле view.php строка 121

setDraggable()

setDraggable

(

$draggable

)

Setter for draggable.

Аргументы

bool

$draggable

Marker for dragging functionality.

Возвращает

void

См. определение в файле view.php строка 453

setHeight()

setHeight

(

$height

)

Setter for height. Can be 'auto'

Аргументы

mixed

$height

Height of widget with header 55px.

Возвращает

void

См. определение в файле view.php строка 56

setHorizontalResizable()

setHorizontalResizable

(

$horizontalResizable

)

If true then big widget can set to small place.

Аргументы

bool

$horizontalResizable

Marker to set resizable mode. #return void

См. определение в файле view.php строка 507

setJsClassName()

setJsClassName

(

$jsClassName

)

Setter for js class name.

Аргументы

string

$jsClassName

Js class name.

Возвращает

void

См. определение в файле view.php строка 383

setLabel()

setLabel

(

$label

)

Setter for label.

Аргументы

string

$label

Label text.

Возвращает

void

См. определение в файле view.php строка 83

setLogoUri()

setLogoUri

(

$logoUri

)

Setter for miniature src.

Аргументы

string

$logoUri

Path to miniature image.

Возвращает

void

См. определение в файле view.php строка 102

setPreviewImageUri()

setPreviewImageUri

(

$previewImageUri

)

Аргументы

mixed

$previewImageUri

См. определение в файле view.php строка 523

Данные класса

DEFAULT_EMPTY_REPORT_COUNT

const DEFAULT_EMPTY_REPORT_COUNT = 1

См. определение в файле view.php строка 29

MAX_RENDER_REPORT_COUNT

const MAX_RENDER_REPORT_COUNT = 0

См. определение в файле view.php строка 28

USE_IN_VISUAL_CONSTRUCTOR

const USE_IN_VISUAL_CONSTRUCTOR = true

См. определение в файле view.php строка 30

VIEW_KEY

const VIEW_KEY = ''

См. определение в файле view.php строка 27