Bitrix API

Serial extends Base

AbstractYes

Class Serial

Table of Contents

Constants

DEFAULT_EMPTY_REPORT_COUNT  = 1
ENABLE_SORTING  = true
MAX_RENDER_REPORT_COUNT  = 15
USE_IN_VISUAL_CONSTRUCTOR  = false
VIEW_KEY  = ''

Methods

__construct()  : mixed
Serial widget base constructor.
addDefaultReportHandlersToWidgetHandler()  : BaseWidget
When building new widget, add default Report handlers to widget.
buildWidgetHandlerForBoard()  : BaseWidget
Use if need to construct widget entity by view type.
collectReportHandlerFormElements()  : void
Method to modify widget form elements.
collectWidgetHandlerFormElements()  : void
Set non-displayable color field.
getCompatibleDataType()  : string
getCompatibleViewTypes()  : array<string|int, mixed>
Return list of compatible view type keys, to this view types can switch without reform configurations.
getHeight()  : mixed
getJsClassName()  : string
getKey()  : string
getLabel()  : string
getLogoUri()  : string
getPreviewImageUri()  : mixed
getReportDefaultColor()  : string
Default colors set for reports.
getReportHandler()  : null
Find report handler by class name and build Report handler in context of widget handler and view type.
handlerFinallyBeforePassToView()  : array<string|int, mixed>
Handle all data prepared for this view.
isCompatibleWithView()  : bool
Check is $view compatible with current view type.
isDraggable()  : bool
isHorizontalResizable()  : bool
prepareWidgetContent()  : array<string|int, mixed>
Method to modify Content which pass to widget view, in absoulte end.
prepareWidgetFormBeforeRender()  : WidgetForm
Method to modify widget configuration form in context of view.
setCompatibleDataType()  : void
Set compatible data type.
setDraggable()  : void
Setter for draggable.
setHeight()  : void
Setter for height.
setHorizontalResizable()  : mixed
If true then big widget can set to small place.
setJsClassName()  : void
Setter for js class name.
setLabel()  : void
Setter for label.
setLogoUri()  : void
Setter for miniature src.
setPreviewImageUri()  : mixed

Constants

DEFAULT_EMPTY_REPORT_COUNT

public mixed DEFAULT_EMPTY_REPORT_COUNT = 1

ENABLE_SORTING

public mixed ENABLE_SORTING = true

MAX_RENDER_REPORT_COUNT

public mixed MAX_RENDER_REPORT_COUNT = 15

USE_IN_VISUAL_CONSTRUCTOR

public mixed USE_IN_VISUAL_CONSTRUCTOR = false

VIEW_KEY

public mixed VIEW_KEY = ''

Methods

__construct()

Serial widget base constructor.

public __construct() : mixed

addDefaultReportHandlersToWidgetHandler()

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

public addDefaultReportHandlersToWidgetHandler(BaseWidget $widgetHandler) : BaseWidget
Parameters
$widgetHandler : BaseWidget

Widget handler.

Return values
BaseWidget

buildWidgetHandlerForBoard()

Use if need to construct widget entity by view type.

public final buildWidgetHandlerForBoard(string $boardId) : BaseWidget
Parameters
$boardId : string

Board id.

Return values
BaseWidget

collectReportHandlerFormElements()

Method to modify widget form elements.

public collectReportHandlerFormElements(BaseReport $reportHandler) : void
Parameters
$reportHandler : BaseReport

Widget handler.

collectWidgetHandlerFormElements()

Set non-displayable color field.

public collectWidgetHandlerFormElements(BaseWidget $widgetHandler) : void
Parameters
$widgetHandler : BaseWidget

Widget handler.

getCompatibleDataType()

public getCompatibleDataType() : string
Return values
string

getCompatibleViewTypes()

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

public getCompatibleViewTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHeight()

public getHeight() : mixed

getJsClassName()

public getJsClassName() : string
Return values
string

getKey()

public getKey() : string
Return values
string

getLabel()

public getLabel() : string
Return values
string

getLogoUri()

public getLogoUri() : string
Return values
string

getPreviewImageUri()

public getPreviewImageUri() : mixed

getReportDefaultColor()

Default colors set for reports.

public getReportDefaultColor(int $num) : string
Parameters
$num : int

Number of color which need.

Return values
string

getReportHandler()

Find report handler by class name and build Report handler in context of widget handler and view type.

public getReportHandler(string $reportHandlerClassName, BaseWidget $widgetHandler) : null
Parameters
$reportHandlerClassName : string

Report handler class name.

$widgetHandler : BaseWidget

Widget handler.

Return values
null

handlerFinallyBeforePassToView()

Handle all data prepared for this view.

public handlerFinallyBeforePassToView(array<string|int, mixed> $dataFromReport) : array<string|int, mixed>

Collect parameters for pass serial amchart.

Parameters
$dataFromReport : array<string|int, mixed>

Parameters prepared in report handlers.

Tags
see
Amchart

documantation.

Return values
array<string|int, mixed>

isCompatibleWithView()

Check is $view compatible with current view type.

public isCompatibleWithView(View $view) : bool
Parameters
$view : View

View entity.

Return values
bool

isDraggable()

public isDraggable() : bool
Return values
bool

isHorizontalResizable()

public isHorizontalResizable() : bool
Return values
bool

prepareWidgetContent()

Method to modify Content which pass to widget view, in absoulte end.

public prepareWidgetContent(Widget $widget[, bool $withCalculatedData = false ]) : array<string|int, mixed>
Parameters
$widget : Widget

Widget entity.

$withCalculatedData : bool = false

Marker for calculate or no data in widget.

Return values
array<string|int, mixed>

prepareWidgetFormBeforeRender()

Method to modify widget configuration form in context of view.

public prepareWidgetFormBeforeRender(WidgetForm $form) : WidgetForm
Parameters
$form : WidgetForm

Form Entity.

Return values
WidgetForm —

$form

setCompatibleDataType()

Set compatible data type.

public setCompatibleDataType(string $compatibleDataType) : void
Parameters
$compatibleDataType : string

Data type which compatible with view type.

setDraggable()

Setter for draggable.

public setDraggable(bool $draggable) : void
Parameters
$draggable : bool

Marker for dragging functionality.

setHeight()

Setter for height.

public setHeight(mixed $height) : void

Can be 'auto'

Parameters
$height : mixed

Height of widget with header 55px.

setHorizontalResizable()

If true then big widget can set to small place.

public setHorizontalResizable(bool $horizontalResizable) : mixed
Parameters
$horizontalResizable : bool

Marker to set resizable mode. #return void

setJsClassName()

Setter for js class name.

public setJsClassName(string $jsClassName) : void
Parameters
$jsClassName : string

Js class name.

setLabel()

Setter for label.

public setLabel(string $label) : void
Parameters
$label : string

Label text.

setLogoUri()

Setter for miniature src.

public setLogoUri(string $logoUri) : void
Parameters
$logoUri : string

Path to miniature image.

setPreviewImageUri()

public setPreviewImageUri(mixed $previewImageUri) : mixed
Parameters
$previewImageUri : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results