Bitrix API

Dashboard

FinalYes

Table of Contents

Methods

__construct()  : mixed
changeTitle()  : Result
Update title for dashboard in superset and bitrix
getAppId()  : string
getEditUrl()  : string
getEmbeddedCredentials()  : DashboardEmbeddedCredentials|null
getExternalId()  : int|null
ID that represents dashboard in superset
getField()  : mixed
getId()  : int
getNativeFilter()  : string
getNativeFilterFields()  : array<string|int, mixed>
getNativeFiltersConfig()  : array<string|int, mixed>
getOrmObject()  : SupersetDashboard
getStatus()  : string
getTitle()  : string
getType()  : string
getUrl()  : string
isAvailableDashboard()  : bool
isEditable()  : bool
isMarketDashboard()  : bool
isSupersetDashboardDataLoaded()  : bool
isSystemDashboard()  : bool
loadCredentials()  : self
loadProxyData()  : self
setEditUrl()  : self
toArray()  : array<string|int, mixed>
toggleDraft()  : Result
Publish or make draft dashboard.

Methods

changeTitle()

Update title for dashboard in superset and bitrix

public changeTitle(string $title) : Result
Parameters
$title : string
Return values
Result

getAppId()

public getAppId() : string
Return values
string

getEditUrl()

public getEditUrl() : string
Return values
string

getExternalId()

ID that represents dashboard in superset

public getExternalId() : int|null
Return values
int|null

getField()

public getField(mixed $fieldName) : mixed
Parameters
$fieldName : mixed

getId()

public getId() : int
Return values
int

getNativeFilter()

public getNativeFilter() : string
Return values
string

getNativeFilterFields()

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

getNativeFiltersConfig()

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

getStatus()

public getStatus() : string
Return values
string

getTitle()

public getTitle() : string
Return values
string

getType()

public getType() : string
Return values
string

getUrl()

public getUrl() : string
Return values
string

isAvailableDashboard()

public isAvailableDashboard() : bool
Return values
bool

isEditable()

public isEditable() : bool
Return values
bool

isMarketDashboard()

public isMarketDashboard() : bool
Return values
bool

isSupersetDashboardDataLoaded()

public isSupersetDashboardDataLoaded() : bool
Return values
bool

isSystemDashboard()

public isSystemDashboard() : bool
Return values
bool

loadCredentials()

public loadCredentials() : self
Return values
self

loadProxyData()

public loadProxyData() : self
Return values
self

setEditUrl()

public setEditUrl(string $editUrl) : self
Parameters
$editUrl : string
Return values
self

toArray()

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

toggleDraft()

Publish or make draft dashboard.

public toggleDraft(bool $published) : Result
Parameters
$published : bool
Return values
Result

        
On this page

Search results