Bitrix API

RestAppBoard extends AnalyticBoard

Class AnalyticBoard

Table of Contents

Methods

__construct()  : mixed
addButton()  : mixed
addFeedbackButton()  : mixed
getBatchKey()  : string
getBoardKey()  : mixed
getButtons()  : array<string|int, BoardButton>
getButtonsContent()  : mixed
getDisplayComponentName()  : mixed
getDisplayComponentParams()  : mixed
getDisplayComponentTemplate()  : mixed
getExternalUrl()  : string
getFilter()  : Filter
getGroup()  : null
getLimitComponentName()  : mixed
getLimitComponentParams()  : mixed
getLimitComponentTemplateName()  : mixed
getMachineKey()  : mixed
getOptions()  : array<string|int, mixed>
getPlacement()  : string
getPlacementHandlerId()  : int
getRestAppId()  : int
getSliderLoader()  : string|null
getStepperIds()  : mixed
getTitle()  : mixed
isDisabled()  : bool
isExternal()  : bool
isLimited()  : mixed
isNestedInBatch()  : bool
isSliderSupport()  : bool
isStepperEnabled()  : bool
registerSetOptionsCallback()  : mixed
resetToDefault()  : mixed
Special actions to perform with board reset, required by some boards
setBatchKey()  : mixed
setBoardKey()  : mixed
setDisabled()  : mixed
setExternal()  : void
setExternalUrl()  : void
setFilter()  : mixed
setGroup()  : void
setLimit()  : mixed
setMachineKey()  : mixed
setPlacement()  : void
setPlacementHandlerId()  : void
setRestAppId()  : void
setSliderLoader()  : void
setSliderSupport()  : void
setStepperEnabled()  : mixed
setStepperIds()  : mixed
setTitle()  : mixed
toggleOption()  : mixed

Methods

__construct()

public __construct([string $boardId = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$boardId : string = ''
$options : array<string|int, mixed> = []

getBatchKey()

public getBatchKey() : string
Return values
string

getDisplayComponentName()

public getDisplayComponentName() : mixed

getDisplayComponentParams()

public getDisplayComponentParams() : mixed

getDisplayComponentTemplate()

public getDisplayComponentTemplate() : mixed

getExternalUrl()

public getExternalUrl() : string
Return values
string

getLimitComponentName()

public getLimitComponentName() : mixed

getLimitComponentParams()

public getLimitComponentParams() : mixed

getLimitComponentTemplateName()

public getLimitComponentTemplateName() : mixed

getOptions()

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

getPlacement()

public getPlacement() : string
Return values
string

getPlacementHandlerId()

public getPlacementHandlerId() : int
Return values
int

getRestAppId()

public getRestAppId() : int
Return values
int

getSliderLoader()

public getSliderLoader() : string|null
Return values
string|null

isNestedInBatch()

public isNestedInBatch() : bool
Return values
bool

isSliderSupport()

public isSliderSupport() : bool
Return values
bool

isStepperEnabled()

public isStepperEnabled() : bool
Return values
bool

registerSetOptionsCallback()

public registerSetOptionsCallback(callable $cb) : mixed
Parameters
$cb : callable

resetToDefault()

Special actions to perform with board reset, required by some boards

public resetToDefault() : mixed

setBatchKey()

public setBatchKey(string $batchKey) : mixed
Parameters
$batchKey : string

setBoardKey()

public setBoardKey(mixed $boardKey) : mixed
Parameters
$boardKey : mixed

setDisabled()

public setDisabled(bool $disabled) : mixed
Parameters
$disabled : bool

setExternal()

public setExternal(bool $isExternal) : void
Parameters
$isExternal : bool

setExternalUrl()

public setExternalUrl(string $externalUrl) : void
Parameters
$externalUrl : string

setGroup()

public setGroup(null $group) : void
Parameters
$group : null

setLimit()

public setLimit(mixed $limitComponentParams[, mixed $limit = false ]) : mixed
Parameters
$limitComponentParams : mixed
$limit : mixed = false

setMachineKey()

public setMachineKey(mixed $machineKey) : mixed
Parameters
$machineKey : mixed

setPlacement()

public setPlacement(string $placement) : void
Parameters
$placement : string

setPlacementHandlerId()

public setPlacementHandlerId(int $placementHandlerId) : void
Parameters
$placementHandlerId : int

setRestAppId()

public setRestAppId(int $restAppId) : void
Parameters
$restAppId : int

setSliderLoader()

public setSliderLoader(string $sliderLoader) : void
Parameters
$sliderLoader : string

setSliderSupport()

public setSliderSupport(bool $isSliderSupport) : void
Parameters
$isSliderSupport : bool

setStepperEnabled()

public setStepperEnabled(bool $stepperEnabled) : mixed
Parameters
$stepperEnabled : bool

setStepperIds()

public setStepperIds([mixed $stepperIds = [] ]) : mixed
Parameters
$stepperIds : mixed = []

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : mixed

toggleOption()

public toggleOption(string $optionName) : mixed
Parameters
$optionName : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results