D3Asset
- Type
- Class
- Namespace
- craft\web\assets\d3
- Inherits
- craft\web\assets\d3\D3Asset » craft\web\AssetBundle » yii\web\AssetBundle (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
D3 asset bundle.
View source (opens new window)
# Public Properties
# sourcePath
- Type
- string (opens new window), null (opens new window)
- Default value
__DIR__ . '/dist'
The directory that contains the source asset files for this asset bundle. A source asset file is a file that is part of your source code repository of your Web application.
You must set this property if the directory containing the source asset files is not Web accessible.
By setting this property, \craft\web\assets\d3\AssetManager
will publish the source asset files
to a Web-accessible directory automatically when the asset bundle is registered on a page.
If you do not set this property, it means the source asset files are located under basePath (opens new window).
You can use either a directory or an alias of the directory.
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of an object property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets value of an object property. |
__unset() (opens new window) | Sets an object property to null. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
formatDef() | Returns the closest-matching D3 format definition for the current language. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
init() | Initializes the bundle. |
publish() (opens new window) | Publishes the asset bundle if its source code is not under Web-accessible directory. |
register() (opens new window) | Registers this asset bundle with a view. |
registerAssetFiles() | Registers the CSS and JS files with the given view. |
# formatDef()
Returns the closest-matching D3 format definition for the current language.
View source (opens new window)
Arguments
$dir
(string (opens new window)) – The path to the directory containing the format files
Returns
string (opens new window) – The JSON-encoded format definition
# init()
Initializes the bundle.
If you override this method, make sure you call the parent implementation in the last.
View source (opens new window)
# registerAssetFiles()
Registers the CSS and JS files with the given view.
View source (opens new window)
Arguments
$view
(yii\web\View (opens new window)) – The view that the asset files are to be registered with.